interface TokenInterface implements Serializable

TokenInterface is the interface for the user authentication information.

Methods

string
__toString()

Returns a string representation of the Token.

Role[]
getRoles()

Returns the user roles.

mixed
getCredentials()

Returns the user credentials.

string|object
getUser()

Returns a user representation.

setUser(string|object $user)

Sets the user in the token.

string
getUsername()

Returns the username.

bool
isAuthenticated()

Returns whether the user is authenticated or not.

setAuthenticated(bool $isAuthenticated)

Sets the authenticated flag.

eraseCredentials()

Removes sensitive information from the token.

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.

Details

at line line 31
string __toString()

Returns a string representation of the Token.

This is only to be used for debugging purposes.

Return Value

string

at line line 38
Role[] getRoles()

Returns the user roles.

Return Value

Role[] An array of Role instances

at line line 45
mixed getCredentials()

Returns the user credentials.

Return Value

mixed The user credentials

at line line 55
string|object getUser()

Returns a user representation.

Return Value

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

See also

AbstractToken::setUser()

at line line 67
setUser(string|object $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

string|object $user The user

Exceptions

InvalidArgumentException

at line line 74
string getUsername()

Returns the username.

Return Value

string

at line line 81
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 88
setAuthenticated(bool $isAuthenticated)

Sets the authenticated flag.

Parameters

bool $isAuthenticated The authenticated flag

at line line 93
eraseCredentials()

Removes sensitive information from the token.

at line line 100
array getAttributes()

Returns the token attributes.

Return Value

array The token attributes

at line line 107
setAttributes(array $attributes)

Sets the token attributes.

Parameters

array $attributes The token attributes

at line line 116
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 127
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 135
setAttribute(string $name, mixed $value)

Sets an attribute.

Parameters

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