PreAuthenticationGuardToken
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) | ||
| Role[] | 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)
Parameters
| mixed | $credentials | |
| string | $guardProviderKey | Unique key that bind this token to a specific AuthenticatorInterface |
Role[] getRoles()
Returns the user roles.
Return Value
| Role[] | An array of Role instances |
string getUsername()
Returns the username.
Return Value
| string |
mixed getUser()
Returns a user representation.
Return Value
| mixed | Can be a UserInterface instance, an object implementing a __toString method, or the username as a regular string |
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.
Parameters
| mixed | $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 |
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).
Return Value
| mixed | The user credentials |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/4.0/Symfony/Component/Security/Guard/Token/PreAuthenticationGuardToken.html