LockedException
extends AccountStatusException
in package
LockedException is thrown if the user account is locked.
Tags
Table of Contents
- $token : mixed
- $user : mixed
- __construct() : mixed
- __serialize() : array<string|int, mixed>
- Returns all the necessary state of the object for serialization purposes.
- __unserialize() : void
- Restores the object state from an array given by __serialize().
- getMessageData() : array<string|int, mixed>
- Message data to be used by the translation component.
- getMessageKey() : mixed
- {@inheritdoc}
- getToken() : TokenInterface|null
- Get the token.
- getUser() : UserInterface
- Get the user.
- setToken() : mixed
- setUser() : mixed
Properties
$token
private
mixed
$token
$user
private
mixed
$user
Methods
__construct()
public
__construct([string $message = '' ], int $code[, Throwable $previous = null ]) : mixed
Parameters
- $message : string = ''
- $code : int
- $previous : Throwable = null
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> —__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 —getMessageData()
Message data to be used by the translation component.
public
getMessageData() : array<string|int, mixed>
Return values
array<string|int, mixed> —getMessageKey()
{@inheritdoc}
public
getMessageKey() : mixed
Return values
mixed —getToken()
Get the token.
public
getToken() : TokenInterface|null
Return values
TokenInterface|null —getUser()
Get the user.
public
getUser() : UserInterface
Return values
UserInterface —setToken()
public
setToken(TokenInterface $token) : mixed
Parameters
- $token : TokenInterface
Return values
mixed —setUser()
public
setUser(UserInterface $user) : mixed
Parameters
- $user : UserInterface