class AbstractToken implements TokenInterface

Base class for Token instances.

Methods

__construct(array $roles = array())

Constructor.

getRoles()

Returns the user roles.

string
getUsername()

Returns the username.

mixed
getUser()

Returns a user representation.

setUser(mixed $user)

Sets the user in the token.

bool
isAuthenticated()

Returns whether the user is authenticated or not.

setAuthenticated($authenticated)

Sets the authenticated flag.

eraseCredentials()

Removes sensitive information from the token.

serialize()

{@inheritdoc}

unserialize($serialized)

{@inheritdoc}

array
getAttributes()

Returns the token attributes.

setAttributes(array $attributes)

Sets the token attributes.

bool
hasAttribute(string $name)

Returns true if the attribute exists.

mixed
getAttribute(string $name)

Returns an attribute value.

setAttribute(string $name, mixed $value)

Sets an attribute.

string
__toString()

Returns a string representation of the Token.

Details

at line line 40
__construct(array $roles = array())

Constructor.

Parameters

array $roles An array of roles

Exceptions

InvalidArgumentException

at line line 56
RoleInterface[] getRoles()

Returns the user roles.

Return Value

RoleInterface[] An array of RoleInterface instances

at line line 64
string getUsername()

Returns the username.

Return Value

string

at line line 76
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

at line line 91
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

at line line 121
bool isAuthenticated()

Returns whether the user is authenticated or not.

Return Value

bool true if the token has been authenticated, false otherwise

at line line 129
setAuthenticated($authenticated)

Sets the authenticated flag.

Parameters

$authenticated

at line line 137
eraseCredentials()

Removes sensitive information from the token.

at line line 147
serialize()

{@inheritdoc}

at line line 162
unserialize($serialized)

{@inheritdoc}

Parameters

$serialized

at line line 172
array getAttributes()

Returns the token attributes.

Return Value

array The token attributes

at line line 182
setAttributes(array $attributes)

Sets the token attributes.

Parameters

array $attributes The token attributes

at line line 194
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

at line line 208
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

at line line 223
setAttribute(string $name, mixed $value)

Sets an attribute.

Parameters

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

at line line 231
string __toString()

Returns a string representation of the Token.

This is only to be used for debugging purposes.

Return Value

string