class PreAuthenticatedToken extends AbstractToken

PreAuthenticatedToken implements a pre-authenticated token.

Methods

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

No description

Role[]
getRoles()

Returns the user roles.

string
getUsername()

Returns the username.

mixed
getUser()

Returns a user representation.

setUser(mixed $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($str)

{@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.

string
getProviderKey()

Returns the provider key.

mixed
getCredentials()

Returns the user credentials.

Details

at line line 30
__construct(string|object $user, mixed $credentials, string $providerKey, array $roles = array())

Parameters

string|object $user The user can be a UserInterface instance, or an object implementing a __toString method or the username as a regular string
mixed $credentials The user credentials
string $providerKey The provider key
array $roles An array of roles

in AbstractToken at line line 53
Role[] getRoles()

Returns the user roles.

Return Value

Role[] An array of Role instances

in AbstractToken at line line 61
string getUsername()

Returns the username.

Return Value

string

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

in AbstractToken at line line 88
setUser(mixed $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

mixed $user

Exceptions

InvalidArgumentException

in AbstractToken at line line 118
bool isAuthenticated()

Returns whether the user is authenticated or not.

Return Value

bool true if the token has been authenticated, false otherwise

in AbstractToken at line line 126
setAuthenticated($authenticated)

Sets the authenticated flag.

Parameters

$authenticated

at line line 68
eraseCredentials()

Removes sensitive information from the token.

at line line 78
serialize()

{@inheritdoc}

at line line 86
unserialize($str)

{@inheritdoc}

Parameters

$str

in AbstractToken at line line 169
array getAttributes()

Returns the token attributes.

Return Value

array The token attributes

in AbstractToken at line line 179
setAttributes(array $attributes)

Sets the token attributes.

Parameters

array $attributes The token attributes

in AbstractToken at line line 191
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 line 205
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 line 220
setAttribute(string $name, mixed $value)

Sets an attribute.

Parameters

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

in AbstractToken at line line 228
string __toString()

Returns a string representation of the Token.

This is only to be used for debugging purposes.

Return Value

string

at line line 52
string getProviderKey()

Returns the provider key.

Return Value

string The provider key

at line line 60
mixed getCredentials()

Returns the user credentials.

Return Value

mixed The user credentials