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(mixed $user) Sets a user.	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

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

Constructor.

Parameters

string\|object	$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

RoleInterface[] getRoles()

Returns the user roles.

Return Value

RoleInterface[]

An array of RoleInterface 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 a user.

Parameters

mixed

$user

bool isAuthenticated()

Returns whether the user is authenticated or not.

Return Value

bool	true if the token has been authenticated, false otherwise

setAuthenticated($isAuthenticated)

Sets the authenticated flag.

Parameters

$isAuthenticated

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

mixed getCredentials()

Returns the user credentials.

Return Value

mixed

The user credentials

string getProviderKey()

Returns the provider key.

Return Value

string

The provider key

Links:

http://api.symfony.com/master/Symfony/Component/Security/Core/Authentication/Token/UsernamePasswordToken.html

doc_Symfony

2016-10-28 06:36:18

Comments