Core\Authentication\Token\UsernamePasswordToken (Component\Security)
Symfony\Component\Security\Core\Authentication\Token\UsernamePasswordToken
class UsernamePasswordToken extends AbstractToken
UsernamePasswordToken implements a username and password token.
Methods
__construct(string|object $user, string $credentials, string $providerKey, array $roles = array()) Constructor. | ||
RoleInterface[] | getRoles() Returns the user roles. | from AbstractToken |
string | getUsername() Returns the username. | from AbstractToken |
mixed | getUser() Returns a user representation. | from AbstractToken |
setUser(string|object $user) Sets the user in the token. | from AbstractToken | |
bool | isAuthenticated() Returns whether the user is authenticated or not. | from AbstractToken |
setAuthenticated($isAuthenticated) Sets the authenticated flag. | ||
eraseCredentials() Removes sensitive information from the token. | ||
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() Returns the user credentials. | |
string | getProviderKey() Returns the provider key. |
Details
public __construct(string|object $user, string $credentials, string $providerKey, array $roles = array())
Constructor.
public RoleInterface[] getRoles()
Returns the user roles.
public string getUsername()
Returns the username.
public mixed getUser()
Returns a user representation.
public 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.
public bool isAuthenticated()
Returns whether the user is authenticated or not.
public setAuthenticated($isAuthenticated)
Sets the authenticated flag.
public eraseCredentials()
Removes sensitive information from the token.
public serialize()
{@inheritdoc}
public unserialize($serialized)
{@inheritdoc}
public array getAttributes()
Returns the token attributes.
public setAttributes(array $attributes)
Sets the token attributes.
public bool hasAttribute(string $name)
Returns true if the attribute exists.
public mixed getAttribute(string $name)
Returns an attribute value.
public setAttribute(string $name, mixed $value)
Sets an attribute.
public string __toString()
Returns a string representation of the Token.
This is only to be used for debugging purposes.
public mixed getCredentials()
Returns the user credentials.
public string getProviderKey()
Returns the provider key.
© 2004–2016 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/3.0/Symfony/Component/Security/Core/Authentication/Token/UsernamePasswordToken.html