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) | ||
| RoleInterface[] | getRoles() Returns the user roles. | from AbstractToken |
| string | getUsername() Returns the username. | from AbstractToken |
| mixed | getUser() Returns a user representation. | from AbstractToken |
| setUser(mixed $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)
RoleInterface[] 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.
The user can be a UserInterface instance, or an object implementing a __toString method or the username as a regular string.
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.
This is only to be used for debugging purposes.
mixed getCredentials()
This is meant to be only an authenticated token, where credentials have already been used and are thus cleared.
{@inheritdoc}
string getProviderKey()
Returns the provider (firewall) key.
Please login to continue.