GuardTokenInterface
interface GuardTokenInterface implements TokenInterface
A marker interface that both guard tokens implement.
Any tokens passed to GuardAuthenticationProvider (i.e. any tokens that are handled by the guard auth system) must implement this interface.
Methods
| string | __toString() Returns a string representation of the Token. |
from TokenInterface |
| Role[] | getRoles() Returns the user roles. |
from TokenInterface |
| mixed | getCredentials() Returns the user credentials. |
from TokenInterface |
| string|object | getUser() Returns a user representation. |
from TokenInterface |
| setUser(string|object $user) Sets the user in the token. |
from TokenInterface | |
| string | getUsername() Returns the username. |
from TokenInterface |
| bool | isAuthenticated() Returns whether the user is authenticated or not. |
from TokenInterface |
| setAuthenticated(bool $isAuthenticated) Sets the authenticated flag. |
from TokenInterface | |
| eraseCredentials() Removes sensitive information from the token. |
from TokenInterface | |
| array | getAttributes() Returns the token attributes. |
from TokenInterface |
| setAttributes(array $attributes) Sets the token attributes. |
from TokenInterface | |
| bool | hasAttribute(string $name) Returns true if the attribute exists. |
from TokenInterface |
| mixed | getAttribute(string $name) Returns an attribute value. |
from TokenInterface |
| setAttribute(string $name, mixed $value) Sets an attribute. |
from TokenInterface |
Details
string __toString()
Returns a string representation of the Token.
This is only to be used for debugging purposes.
Return Value
| string |
Role[] getRoles()
Returns the user roles.
Return Value
| Role[] | An array of Role instances |
mixed getCredentials()
Returns the user credentials.
Return Value
| mixed | The user credentials |
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 |
See also
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
string getUsername()
Returns the username.
Return Value
| string |
bool isAuthenticated()
Returns whether the user is authenticated or not.
Return Value
| bool | true if the token has been authenticated, false otherwise |
setAuthenticated(bool $isAuthenticated)
Sets the authenticated flag.
Parameters
| bool | $isAuthenticated | The authenticated flag |
eraseCredentials()
Removes sensitive information from the token.
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 |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
https://api.symfony.com/4.1/Symfony/Component/Security/Guard/Token/GuardTokenInterface.html