Class

Symfony\Component\Security\Core\Authentication\Token\UsernamePasswordToken

class UsernamePasswordToken extends AbstractToken

UsernamePasswordToken implements a username and password token.

Methods

__construct(string $user, string $credentials, string $providerKey, array $roles = array())

Constructor.

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
Boolean 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($str)

{@inheritdoc}

array getAttributes()

Returns the token attributes.

from AbstractToken
setAttributes(array $attributes)

Sets the token attributes.

from AbstractToken
Boolean hasAttribute(string $name)

Returns true if the attribute exists.

from AbstractToken
mixed getAttribute(string $name)

Returns a attribute value.

from AbstractToken
setAttribute(string $name, mixed $value)

Sets a attribute.

from AbstractToken
string __toString()

Returns a string representation of the Token.

from AbstractToken
mixed getCredentials()

Returns the user credentials.

getProviderKey()

Details

at line 34
public __construct(string $user, string $credentials, string $providerKey, array $roles = array())

Constructor.

Parameters

string $user The username (like a nickname, email address, etc.), or a UserInterface instance or an object implementing a __toString method.
string $credentials This usually is the password of the user
string $providerKey The provider key
array $roles An array of roles

Exceptions

InvalidArgumentException

in AbstractToken at line 56
public Role[] getRoles()

Returns the user roles.

Return Value

Role[] An array of Role instances.

in AbstractToken at line 64
public string getUsername()

Returns the username.

Return Value

string

in AbstractToken at line 73
public mixed getUser()

Returns a user representation.

Return Value

mixed either returns an object which implements __toString(), or a primitive string is returned.

in AbstractToken at line 87
public 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 The user

Exceptions

InvalidArgumentException

in AbstractToken at line 117
public Boolean isAuthenticated()

Returns whether the user is authenticated or not.

Return Value

Boolean true if the token has been authenticated, false otherwise

at line 52
public setAuthenticated($isAuthenticated)

Sets the authenticated flag.

Parameters

$isAuthenticated

at line 74
public eraseCredentials()

Removes sensitive information from the token.

at line 81
public serialize()

{@inheritdoc}

at line 86
public unserialize($str)

{@inheritdoc}

Parameters

$str

in AbstractToken at line 161
public array getAttributes()

Returns the token attributes.

Return Value

array The token attributes

in AbstractToken at line 171
public setAttributes(array $attributes)

Sets the token attributes.

Parameters

array $attributes The token attributes

in AbstractToken at line 183
public Boolean hasAttribute(string $name)

Returns true if the attribute exists.

Parameters

string $name The attribute name

Return Value

Boolean true if the attribute exists, false otherwise

in AbstractToken at line 197
public mixed getAttribute(string $name)

Returns a attribute value.

Parameters

string $name The attribute name

Return Value

mixed The attribute value

Exceptions

InvalidArgumentException When attribute doesn't exist for this token

in AbstractToken at line 212
public setAttribute(string $name, mixed $value)

Sets a attribute.

Parameters

string $name The attribute name
mixed $value The attribute value

in AbstractToken at line 220
public string __toString()

Returns a string representation of the Token.

This is only to be used for debugging purposes.

Return Value

string

at line 61
public mixed getCredentials()

Returns the user credentials.

Return Value

mixed The user credentials

at line 66
public getProviderKey()