AuthExpiredException extends HttpException
Expired authentication exception. Used when the user needs to authenticate/reauthenticate.
Child classes of HttpException should be thrown when we want to return an HTTP status code and user-viewable message(s) during the application lifecycle.
Tags
Table of Contents
| $defaultMessage | string | |
|---|---|---|
| $httpErrorCode | int | |
| $httpErrorCode | int | |
| $messages | ||
| $defaultMessage | string | |
| getHttpErrorCode() | Return the HTTP status code associated with this exception. | int |
| getUserMessages() | Return the user-viewable messages associated with this exception. | mixed |
| addUserMessage() | Add a user-viewable message for this exception. | mixed |
Properties
$defaultMessage
protected
string
$defaultMessage
= 'ACCOUNT.SESSION_EXPIRED'
$httpErrorCode
protected
int
$httpErrorCode
= 401
$httpErrorCode
protected
int
$httpErrorCode
= 500
$messages
protected
mixed
$messages
= []
$defaultMessage
protected
string
$defaultMessage
= 'SERVER_ERROR'
Methods
getHttpErrorCode()
Return the HTTP status code associated with this exception.
public
getHttpErrorCode(
)
: int
Return values
intgetUserMessages()
Return the user-viewable messages associated with this exception.
public
getUserMessages(
)
: mixed
Return values
mixedaddUserMessage()
Add a user-viewable message for this exception.
public
addUserMessage(
$message :
UserMessage|string
[, $parameters :
array
= [] ]
)
: mixed
Parameters
- $message : UserMessage|string
- $parameters : array = []
The parameters to be filled in for any placeholders in the message.