AccountStatusException
extends AuthenticationException
in package
AbstractYes
AccountStatusException is the base class for authentication exceptions caused by the user account status.
Tags
Table of Contents
Properties
Methods
- __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() : string
- Message key to be used by the translation component.
- getToken() : TokenInterface|null
- getUser() : UserInterface|null
- Get the user.
- setToken() : mixed
- setUser() : mixed
Properties
$token
private
mixed
$token
= null
$user
private
mixed
$user
Methods
__construct()
public
__construct([string $message = '' ][, int $code = 0 ][, Throwable $previous = null ]) : mixed
Parameters
- $message : string = ''
- $code : int = 0
- $previous : Throwable = null
__serialize()
Returns all the necessary state of the object for serialization purposes.
public
__serialize() : array<string|int, mixed>
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
Parameters
- $data : array<string|int, mixed>
getMessageData()
Message data to be used by the translation component.
public
getMessageData() : array<string|int, mixed>
Return values
array<string|int, mixed>getMessageKey()
Message key to be used by the translation component.
public
getMessageKey() : string
Return values
stringgetToken()
public
getToken() : TokenInterface|null
Return values
TokenInterface|nullgetUser()
Get the user.
public
getUser() : UserInterface|null
Return values
UserInterface|nullsetToken()
public
setToken(TokenInterface $token) : mixed
Parameters
- $token : TokenInterface
setUser()
public
setUser(UserInterface $user) : mixed
Parameters
- $user : UserInterface