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 |
| RoleInterface[] | getRoles() Returns the user roles. | from TokenInterface |
| mixed | getCredentials() Returns the user credentials. | from TokenInterface |
| mixed | getUser() Returns a user representation. | from TokenInterface |
| setUser(mixed $user) Sets a user. | 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.
RoleInterface[] getRoles()
Returns the user roles.
mixed getCredentials()
Returns the user credentials.
mixed getUser()
Returns a user representation.
setUser(mixed $user)
Sets a user.
string getUsername()
Returns the username.
bool isAuthenticated()
Returns whether the user is authenticated or not.
setAuthenticated(bool $isAuthenticated)
Sets the authenticated flag.
eraseCredentials()
Removes sensitive information from the token.
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.
Please login to continue.