abstract class AccountStatusException extends AuthenticationException

AccountStatusException is the base class for authentication exceptions caused by the user account status.

Methods

setToken(TokenInterface $token)

No description

serialize()

{@inheritdoc}

unserialize($serialized)

{@inheritdoc}

array
getState()

Returns all the necessary state of the object for serialization purposes.

setState(array $data)

Restores the object state from an array given by getState().

doSerialize($serialized, $isCalledFromOverridingMethod)

No description

string
getMessageKey()

Message key to be used by the translation component.

array
getMessageData()

Message data to be used by the translation component.

getUser()

Get the user.

setUser(UserInterface $user)

No description

Details

TokenInterface getToken()

Get the token.

Return Value

TokenInterface

setToken(TokenInterface $token)

Parameters

TokenInterface $token

serialize()

{@inheritdoc}

unserialize($serialized)

{@inheritdoc}

Parameters

$serialized

at line 45
protected array getState()

Returns all the necessary state of the object for serialization purposes.

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: protected function getState(): array { return [$this->childAttribute, parent::getState()]; }

Return Value

array

at line 53
protected setState(array $data)

Restores the object state from an array given by getState().

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: protected function setState(array $data) { [$this->childAttribute, $parentData] = $data; parent::setState($parentData); }

Parameters

array $data

protected doSerialize($serialized, $isCalledFromOverridingMethod)

Parameters

$serialized
$isCalledFromOverridingMethod

string getMessageKey()

Message key to be used by the translation component.

Return Value

string

array getMessageData()

Message data to be used by the translation component.

Return Value

array

at line 32
UserInterface getUser()

Get the user.

Return Value

UserInterface

at line 37
setUser(UserInterface $user)

Parameters

UserInterface $user