W3cubDocs

/Symfony 3.0

Symfony\Component\Security\Guard\Token\GuardTokenInterface

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

public string __toString()

Returns a string representation of the Token.

This is only to be used for debugging purposes.

Return Value

string

public RoleInterface[] getRoles()

Returns the user roles.

Return Value

RoleInterface[] An array of RoleInterface instances.

public mixed getCredentials()

Returns the user credentials.

Return Value

mixed The user credentials

public 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

See also

AbstractToken::setUser()

public setUser(mixed $user)

Sets a user.

Parameters

mixed $user

public string getUsername()

Returns the username.

Return Value

string

public bool isAuthenticated()

Returns whether the user is authenticated or not.

Return Value

bool true if the token has been authenticated, false otherwise

public setAuthenticated(bool $isAuthenticated)

Sets the authenticated flag.

Parameters

bool $isAuthenticated The authenticated flag

public eraseCredentials()

Removes sensitive information from the token.

public array getAttributes()

Returns the token attributes.

Return Value

array The token attributes

public setAttributes(array $attributes)

Sets the token attributes.

Parameters

array $attributes The token attributes

public 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

public 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

public setAttribute(string $name, mixed $value)

Sets an attribute.

Parameters

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

© 2004–2016 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/3.0/Symfony/Component/Security/Guard/Token/GuardTokenInterface.html