class AuthenticationException extends RuntimeException implements Serializable

AuthenticationException is the base class for all authentication exceptions.

Methods

getToken()

Get the token.

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.

Details

at line 31
TokenInterface getToken()

Get the token.

Return Value

TokenInterface

at line 36
setToken(TokenInterface $token)

Parameters

TokenInterface $token

at line 48
serialize()

{@inheritdoc}

at line 60
unserialize($serialized)

{@inheritdoc}

Parameters

$serialized

at line 80
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

See also

setState()

at line 101
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

See also

getState()

at line 109
protected doSerialize($serialized, $isCalledFromOverridingMethod)

Parameters

$serialized
$isCalledFromOverridingMethod

at line 124
string getMessageKey()

Message key to be used by the translation component.

Return Value

string

at line 134
array getMessageData()

Message data to be used by the translation component.

Return Value

array