1. class
  2. Symfony
  3. Component
  4. Security
  5. Core
  6. Authentication
  7. Token
  8. PreAuthenticatedToken

PreAuthenticatedToken

class PreAuthenticatedToken extends AbstractToken

PreAuthenticatedToken implements a pre-authenticated token.

Methods

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

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

Sets the user in the token.

from AbstractToken
bool
isAuthenticated()

Returns whether the user is authenticated or not.

from AbstractToken
setAuthenticated($authenticated)

Sets the authenticated flag.

from AbstractToken
eraseCredentials()

Removes sensitive information from the token.

serialize()

{@inheritdoc}

unserialize($str)

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

mixed
getCredentials()

Returns the user credentials.

Details

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

Constructor.

Parameters

string|object $user The user
mixed $credentials The user credentials
string $providerKey The provider key
array $roles An array of roles

in AbstractToken at line line 56
RoleInterface[] getRoles()

Returns the user roles.

Return Value

RoleInterface[] An array of RoleInterface instances.

in AbstractToken at line line 64
string getUsername()

Returns the username.

Return Value

string

in AbstractToken at line line 76
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 91
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 121
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 129
setAuthenticated($authenticated)

Sets the authenticated flag.

Parameters

$authenticated

at line line 72
eraseCredentials()

Removes sensitive information from the token.

at line line 82
serialize()

{@inheritdoc}

at line line 90
unserialize($str)

{@inheritdoc}

Parameters

$str

in AbstractToken at line line 172
array getAttributes()

Returns the token attributes.

Return Value

array The token attributes

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

Sets the token attributes.

Parameters

array $attributes The token attributes

in AbstractToken at line line 194
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 208
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 223
setAttribute(string $name, mixed $value)

Sets an attribute.

Parameters

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

in AbstractToken at line line 231
string __toString()

Returns a string representation of the Token.

This is only to be used for debugging purposes.

Return Value

string

at line line 56
string getProviderKey()

Returns the provider key.

Return Value

string The provider key

at line line 64
mixed getCredentials()

Returns the user credentials.

Return Value

mixed The user credentials