1. class
  2. Symfony
  3. \
  4. Component
  5. \
  6. Security
  7. \
  8. Guard
  9. \
  10. Token
  11. \
  12. PostAuthenticationGuardToken

PostAuthenticationGuardToken

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

Role[]
getRoles()

Returns the user roles.

from AbstractToken
string
getUsername()

Returns the username.

from AbstractToken
string|object
getUser()

Returns a user representation.

from AbstractToken
setUser(string|object $user)

Sets the user in the token.

from AbstractToken
bool
isAuthenticated()

Returns whether the user is authenticated or not.

from AbstractToken
setAuthenticated($authenticated)

Sets the authenticated flag.

from AbstractToken
eraseCredentials()

Removes sensitive information from the token.

from AbstractToken
serialize()

{@inheritdoc}

unserialize($serialized)

{@inheritdoc}

array
getAttributes()

Returns the token attributes.

from AbstractToken
setAttributes(array $attributes)

Sets the token attributes.

from AbstractToken
bool
hasAttribute(string $name)

Returns true if the attribute exists.

from AbstractToken
mixed
getAttribute(string $name)

Returns an attribute value.

from AbstractToken
setAttribute(string $name, mixed $value)

Sets an attribute.

from AbstractToken
string
__toString()

Returns a string representation of the Token.

from AbstractToken
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

__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

Role[] getRoles()

Returns the user roles.

Return Value

Role[] An array of Role instances

string getUsername()

Returns the username.

Return Value

string

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

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

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

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

string getProviderKey()

Returns the provider (firewall) key.

Return Value

string