class PostAuthenticationGuardToken extends AbstractToken implements GuardTokenInterface

Used as an "authenticated" token, though it could be set to not-authenticated later.

If you're using Guard authentication, you must use a class that implements GuardTokenInterface as your authenticated token (like this class).

Methods

__construct(UserInterface $user, string $providerKey, array $roles)

No description

getRoles()

Returns the user roles.

string
getUsername()

Returns the username.

string|object
getUser()

Returns a user representation.

setUser(string|object $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.

mixed
getCredentials()

This is meant to be only an authenticated token, where credentials have already been used and are thus cleared.

string
getProviderKey()

Returns the provider (firewall) key.

Details

at line 37
__construct(UserInterface $user, string $providerKey, array $roles)

Parameters

UserInterface $user The user!
string $providerKey The provider (firewall) key
array $roles An array of roles

Exceptions

InvalidArgumentException

in AbstractToken at line 54
RoleInterface[] getRoles()

Returns the user roles.

Return Value

RoleInterface[] An array of RoleInterface instances

in AbstractToken at line 62
string getUsername()

Returns the username.

Return Value

string

in AbstractToken at line 74
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

in AbstractToken at line 82
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

in AbstractToken at line 112
bool isAuthenticated()

Returns whether the user is authenticated or not.

Return Value

bool true if the token has been authenticated, false otherwise

in AbstractToken at line 120
setAuthenticated($authenticated)

Sets the authenticated flag.

Parameters

$authenticated

in AbstractToken at line 128
eraseCredentials()

Removes sensitive information from the token.

at line 77
serialize()

{@inheritdoc}

at line 85
unserialize($serialized)

{@inheritdoc}

Parameters

$serialized

in AbstractToken at line 163
array getAttributes()

Returns the token attributes.

Return Value

array The token attributes

in AbstractToken at line 173
setAttributes(array $attributes)

Sets the token attributes.

Parameters

array $attributes The token attributes

in AbstractToken at line 185
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

in AbstractToken at line 199
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

in AbstractToken at line 214
setAttribute(string $name, mixed $value)

Sets an attribute.

Parameters

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

in AbstractToken at line 222
string __toString()

Returns a string representation of the Token.

This is only to be used for debugging purposes.

Return Value

string

at line 59
mixed getCredentials()

This is meant to be only an authenticated token, where credentials have already been used and are thus cleared.

{@inheritdoc}

Return Value

mixed The user credentials

at line 69
string getProviderKey()

Returns the provider (firewall) key.

Return Value

string