TokenInterface

interface TokenInterface implements Serializable

TokenInterface is the interface for the user authentication information.

Methods

string	__toString() Returns a string representation of the Token.
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.

Details

string __toString()

Returns a string representation of the Token.

This is only to be used for debugging purposes.

Return Value

string

RoleInterface[] getRoles()

Returns the user roles.

Return Value

RoleInterface[]

An array of RoleInterface instances

mixed getCredentials()

Returns the user credentials.

Return Value

mixed

The user credentials

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

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

Links:

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

doc_Symfony

2016-10-28 06:34:42

Comments

TokenInterface

Methods

Details

string __toString()

Return Value

RoleInterface[] getRoles()

Return Value

mixed getCredentials()

Return Value

mixed getUser()

Return Value

See also

setUser(mixed $user)

Parameters

string getUsername()

Return Value

bool isAuthenticated()

Return Value

setAuthenticated(bool $isAuthenticated)

Parameters

eraseCredentials()

array getAttributes()

Return Value

setAttributes(array $attributes)

Parameters

bool hasAttribute(string $name)

Parameters

Return Value

mixed getAttribute(string $name)

Parameters

Return Value

Exceptions

setAttribute(string $name, mixed $value)

Parameters