AbstractToken
in package
implements
TokenInterface
Base class for Token instances.
Tags
Interfaces, Classes, Traits and Enums
- TokenInterface
- TokenInterface is the interface for the user authentication information.
Table of Contents
- $attributes : mixed
- $authenticated : mixed
- $roleNames : mixed
- $roles : mixed
- $user : mixed
- __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
- Returns an attribute value.
- getAttributes() : array<string|int, mixed>
- Returns the token attributes.
- getRoleNames() : array<string|int, mixed>
- getRoles() : array<string|int, Role>
- Returns the user roles.
- getUser() : string|Stringable|UserInterface
- Returns a user representation.
- getUsername() : string
- Returns the username.
- hasAttribute() : bool
- Returns true if the attribute exists.
- isAuthenticated() : bool
- Returns whether the user is authenticated or not.
- setAttribute() : mixed
- Sets an attribute.
- setAttributes() : mixed
- Sets the token attributes.
- setAuthenticated() : mixed
- Sets the authenticated flag.
- setUser() : mixed
- Sets the user in the token.
- hasUserChanged() : bool
Properties
$attributes
private
mixed
$attributes
= []
$authenticated
private
mixed
$authenticated
= false
$roleNames
private
mixed
$roleNames
= []
$roles
private
mixed
$roles
= []
$user
private
mixed
$user
Methods
__construct()
public
__construct([array<string|int, string> $roles = [] ]) : mixed
Parameters
- $roles : array<string|int, string> = []
-
An array of roles
Tags
Return values
mixed —__serialize()
Returns all the necessary state of the object for serialization purposes.
public
__serialize() : array<string|int, mixed>
There is no need to serialize any entry, they should be returned as-is.
If you extend this method, keep in mind you MUST guarantee parent data is present in the state.
Here is an example of how to extend this method:
public function __serialize(): array
{
return [$this->childAttribute, parent::__serialize()];
}
Tags
Return values
array<string|int, mixed> —__toString()
Returns a string representation of the Token.
public
__toString() : string
Return values
string —__unserialize()
Restores the object state from an array given by __serialize().
public
__unserialize(array<string|int, mixed> $data) : void
There is no need to unserialize any entry in $data, they are already ready-to-use.
If you extend this method, keep in mind you MUST pass the parent data to its respective class.
Here is an example of how to extend this method:
public function __unserialize(array $data): void
{
[$this->childAttribute, $parentData] = $data;
parent::__unserialize($parentData);
}
Parameters
- $data : array<string|int, mixed>
Tags
Return values
void —eraseCredentials()
Removes sensitive information from the token.
public
eraseCredentials() : mixed
Return values
mixed —getAttribute()
Returns an attribute value.
public
getAttribute(string $name) : mixed
Parameters
- $name : string
-
The attribute name
Tags
Return values
mixed —The attribute value
getAttributes()
Returns the token attributes.
public
getAttributes() : array<string|int, mixed>
Return values
array<string|int, mixed> —The token attributes
getRoleNames()
public
getRoleNames() : array<string|int, mixed>
Return values
array<string|int, mixed> —getRoles()
Returns the user roles.
public
getRoles() : array<string|int, Role>
Return values
array<string|int, Role> —An array of Role instances
getUser()
Returns a user representation.
public
getUser() : string|Stringable|UserInterface
Return values
string|Stringable|UserInterface —getUsername()
Returns the username.
public
getUsername() : string
Return values
string —hasAttribute()
Returns true if the attribute exists.
public
hasAttribute(string $name) : bool
Parameters
- $name : string
-
The attribute name
Return values
bool —true if the attribute exists, false otherwise
isAuthenticated()
Returns whether the user is authenticated or not.
public
isAuthenticated() : bool
Return values
bool —true if the token has been authenticated, false otherwise
setAttribute()
Sets an attribute.
public
setAttribute(string $name, mixed $value) : mixed
Parameters
- $name : string
-
The attribute name
- $value : mixed
-
The attribute value
Return values
mixed —setAttributes()
Sets the token attributes.
public
setAttributes(array<string|int, mixed> $attributes) : mixed
Parameters
- $attributes : array<string|int, mixed>
-
The token attributes
Return values
mixed —setAuthenticated()
Sets the authenticated flag.
public
setAuthenticated(mixed $authenticated) : mixed
Parameters
- $authenticated : mixed
Return values
mixed —setUser()
Sets the user in the token.
public
setUser(mixed $user) : mixed
Parameters
- $user : mixed
Return values
mixed —hasUserChanged()
private
hasUserChanged(UserInterface $user) : bool
Parameters
- $user : UserInterface