PreAuthenticatedToken
extends AbstractToken
in package
PreAuthenticatedToken implements a pre-authenticated token.
Tags
Table of Contents
Properties
- $attributes : array<string|int, mixed>
- $firewallName : string
- $roleNames : array<string|int, mixed>
- $user : mixed
Methods
- __construct() : mixed
- __serialize() : array<string|int, mixed>
- Returns all the necessary state of the object for serialization purposes.
- __toString() : string
- Returns a string representation of the Token.
- __unserialize() : void
- Restores the object state from an array given by __serialize().
- eraseCredentials() : mixed
- Removes sensitive information from the token.
- getAttribute() : mixed
- getAttributes() : array<string|int, mixed>
- getFirewallName() : string
- getRoleNames() : array<string|int, string>
- Returns the user roles.
- getUser() : UserInterface|null
- Returns a user representation.
- getUserIdentifier() : string
- Returns the user identifier used during authentication (e.g. a user's email address or username).
- hasAttribute() : bool
- setAttribute() : mixed
- setAttributes() : mixed
- setUser() : mixed
- Sets the authenticated user in the token.
Properties
$attributes
private
array<string|int, mixed>
$attributes
= []
$firewallName
private
string
$firewallName
$roleNames
private
array<string|int, mixed>
$roleNames
= []
$user
private
mixed
$user
= null
Methods
__construct()
public
__construct(UserInterface $user, string $firewallName[, array<string|int, string> $roles = [] ]) : mixed
Parameters
- $user : UserInterface
- $firewallName : string
- $roles : array<string|int, string> = []
__serialize()
Returns all the necessary state of the object for serialization purposes.
public
__serialize() : array<string|int, mixed>
Return values
array<string|int, mixed>__toString()
Returns a string representation of the Token.
public
__toString() : string
This is only to be used for debugging purposes.
Return values
string__unserialize()
Restores the object state from an array given by __serialize().
public
__unserialize(array<string|int, mixed> $data) : void
Parameters
- $data : array<string|int, mixed>
eraseCredentials()
Removes sensitive information from the token.
public
eraseCredentials() : mixed
getAttribute()
public
getAttribute(string $name) : mixed
Parameters
- $name : string
getAttributes()
public
getAttributes() : array<string|int, mixed>
Return values
array<string|int, mixed>getFirewallName()
public
getFirewallName() : string
Return values
stringgetRoleNames()
Returns the user roles.
public
getRoleNames() : array<string|int, string>
Return values
array<string|int, string>getUser()
Returns a user representation.
public
getUser() : UserInterface|null
Return values
UserInterface|nullgetUserIdentifier()
Returns the user identifier used during authentication (e.g. a user's email address or username).
public
getUserIdentifier() : string
Return values
stringhasAttribute()
public
hasAttribute(string $name) : bool
Parameters
- $name : string
Return values
boolsetAttribute()
public
setAttribute(string $name, mixed $value) : mixed
Parameters
- $name : string
- $value : mixed
setAttributes()
public
setAttributes(array<string|int, mixed> $attributes) : mixed
Parameters
- $attributes : array<string|int, mixed>
-
The token attributes
setUser()
Sets the authenticated user in the token.
public
setUser(UserInterface $user) : mixed
Parameters
- $user : UserInterface