AbstractToken

__construct(array $roles = array())

Parameters

array

$roles

An array of roles

Exceptions

InvalidArgumentException

Role[] getRoles()

Returns the user roles.

Return Value

Role[]

An array of Role instances

string getUsername()

Returns the username.

Return Value

string

mixed getUser()

Returns a user representation.

Return Value

mixed

Can be a UserInterface instance, an object implementing a __toString method, or the username as a regular string

setUser(mixed $user)

Sets the user in the token.

The user can be a UserInterface instance, or an object implementing a __toString method or the username as a regular string.

Parameters

mixed

$user

Exceptions

InvalidArgumentException

bool isAuthenticated()

Returns whether the user is authenticated or not.

Return Value

bool	true if the token has been authenticated, false otherwise

setAuthenticated($authenticated)

Sets the authenticated flag.

Parameters

$authenticated

eraseCredentials()

Removes sensitive information from the token.

serialize()

{@inheritdoc}

unserialize($serialized)

{@inheritdoc}

Parameters

$serialized

array getAttributes()

Returns the token attributes.

Return Value

array

The token attributes

setAttributes(array $attributes)

Sets the token attributes.

Parameters

array

$attributes

The token attributes

bool hasAttribute(string $name)

Returns true if the attribute exists.

Parameters

string

$name

The attribute name

Return Value

bool	true if the attribute exists, false otherwise

mixed getAttribute(string $name)

Returns an attribute value.

Parameters

string

$name

The attribute name

Return Value

mixed

The attribute value

Exceptions

InvalidArgumentException

When attribute doesn't exist for this token

setAttribute(string $name, mixed $value)

Sets an attribute.

Parameters

string	$name	The attribute name
mixed	$value	The attribute value

string __toString()

Returns a string representation of the Token.

This is only to be used for debugging purposes.

Return Value

string