W3cubDocs

/Symfony 3.0

Symfony\Component\Security\Core\Authentication\Token\RememberMeToken

class RememberMeToken extends AbstractToken

Authentication Token for "Remember-Me".

Methods

__construct(UserInterface $user, string $providerKey, string $secret)

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 a user.

from AbstractToken
bool isAuthenticated()

Returns whether the user is authenticated or not.

from AbstractToken
setAuthenticated($authenticated)

Sets the authenticated flag.

eraseCredentials()

Removes sensitive information from the token.

from AbstractToken
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
string getProviderKey()

Returns the provider secret.

string getSecret()

Returns the secret.

mixed getCredentials()

Returns the user credentials.

Details

public __construct(UserInterface $user, string $providerKey, string $secret)

Constructor.

Parameters

UserInterface $user
string $providerKey
string $secret A secret used to make sure the token is created by the app and not by a malicious client

Exceptions

InvalidArgumentException

public RoleInterface[] getRoles()

Returns the user roles.

Return Value

RoleInterface[] An array of RoleInterface instances.

public string getUsername()

Returns the username.

Return Value

string

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

public setUser(string|object $user)

Sets a user.

Parameters

string|object $user The user

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($authenticated)

Sets the authenticated flag.

Parameters

$authenticated

public eraseCredentials()

Removes sensitive information from the token.

public serialize()

{@inheritdoc}

public unserialize($serialized)

{@inheritdoc}

Parameters

$serialized

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

public string __toString()

Returns a string representation of the Token.

This is only to be used for debugging purposes.

Return Value

string

public string getProviderKey()

Returns the provider secret.

Return Value

string The provider secret

public string getSecret()

Returns the secret.

Return Value

string

public mixed getCredentials()

Returns the user credentials.

Return Value

mixed The user credentials