class PreAuthenticationGuardToken extends AbstractToken implements GuardTokenInterface
The token used by the guard auth system before authentication.
The GuardAuthenticationListener creates this, which is then consumed immediately by the GuardAuthenticationProvider. If authentication is successful, a different authenticated token is returned
Methods
| __construct(mixed $credentials, string $guardProviderKey) | ||
| 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. | ||
| eraseCredentials() Removes sensitive information from the token. | from AbstractToken | |
| serialize() {@inheritdoc} | from AbstractToken | |
| unserialize($serialized) {@inheritdoc} | from AbstractToken | |
| 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 |
| getGuardProviderKey() | ||
| mixed | getCredentials() Returns the user credentials, which might be an array of anything you wanted to put in there (e.g. username, password, favoriteColor). |
Details
__construct(mixed $credentials, string $guardProviderKey)
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.
getGuardProviderKey()
mixed getCredentials()
Returns the user credentials, which might be an array of anything you wanted to put in there (e.g. username, password, favoriteColor).
Please login to continue.