class PreAuthenticationGuardToken extends AbstractToken implements GuardTokenInterface

The token used by the guard auth system before authentication.

The GuardAuthenticationListener creates this, which is then consumed immediately by the GuardAuthenticationProvider. If authentication is successful, a different authenticated token is returned

Methods

__construct(mixed $credentials, string $guardProviderKey)

No description

Role[]
getRoles()

Returns the user roles.

string
getUsername()

Returns the username.

string|object
getUser()

Returns a user representation.

setUser(string|object $user)

Sets the user in the token.

bool
isAuthenticated()

Returns whether the user is authenticated or not.

setAuthenticated($authenticated)

Sets the authenticated flag.

eraseCredentials()

Removes sensitive information from the token.

serialize()

{@inheritdoc}

unserialize($serialized)

{@inheritdoc}

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.

string
__toString()

Returns a string representation of the Token.

getGuardProviderKey()

No description

mixed
getCredentials()

Returns the user credentials, which might be an array of anything you wanted to put in there (e.g. username, password, favoriteColor).

Details

at line 34
__construct(mixed $credentials, string $guardProviderKey)

Parameters

mixed $credentials
string $guardProviderKey Unique key that bind this token to a specific AuthenticatorInterface

in AbstractToken at line 53
Role[] getRoles()

Returns the user roles.

Return Value

Role[] An array of Role instances

in AbstractToken at line 61
string getUsername()

Returns the username.

Return Value

string

in AbstractToken at line 73
string|object getUser()

Returns a user representation.

Return Value

string|object Can be a UserInterface instance, an object implementing a __toString method, or the username as a regular string

in AbstractToken at line 81
setUser(string|object $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

string|object $user The user

Exceptions

InvalidArgumentException

in AbstractToken at line 111
bool isAuthenticated()

Returns whether the user is authenticated or not.

Return Value

bool true if the token has been authenticated, false otherwise

at line 61
setAuthenticated($authenticated)

Sets the authenticated flag.

Parameters

$authenticated

in AbstractToken at line 127
eraseCredentials()

Removes sensitive information from the token.

in AbstractToken at line 137
serialize()

{@inheritdoc}

in AbstractToken at line 152
unserialize($serialized)

{@inheritdoc}

Parameters

$serialized

in AbstractToken at line 162
array getAttributes()

Returns the token attributes.

Return Value

array The token attributes

in AbstractToken at line 172
setAttributes(array $attributes)

Sets the token attributes.

Parameters

array $attributes The token attributes

in AbstractToken at line 184
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

in AbstractToken at line 198
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

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

Sets an attribute.

Parameters

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

in AbstractToken at line 221
string __toString()

Returns a string representation of the Token.

This is only to be used for debugging purposes.

Return Value

string

at line 45
getGuardProviderKey()

at line 56
mixed getCredentials()

Returns the user credentials, which might be an array of anything you wanted to put in there (e.g. username, password, favoriteColor).

Return Value

mixed The user credentials