Status431
extends Http
in package
FinalYes
Exception for 431 Request Header Fields Too Large responses
Tags
Table of Contents
Properties
- $code : int
- HTTP status code
- $data : mixed
- Data associated with the exception
- $reason : string
- Reason phrase
- $type : string
- Type of exception
Methods
- __construct() : mixed
- Create a new exception
- get_class() : string
- Get the correct exception class for a given error code
- getData() : mixed
- Gives any relevant data
- getReason() : string
- Get the status message.
- getType() : string
- Like {@see \Exception::getCode()}, but a string code.
Properties
$code
HTTP status code
protected
int
$code
= 431
$data
Data associated with the exception
protected
mixed
$data
$reason
Reason phrase
protected
string
$reason
= 'Request Header Fields Too Large'
$type
Type of exception
protected
string
$type
Methods
__construct()
Create a new exception
public
__construct([string|null $reason = null ][, mixed $data = null ]) : mixed
There is no mechanism to pass in the status code, as this is set by the subclass used. Reason phrases can vary, however.
Parameters
- $reason : string|null = null
-
Reason phrase
- $data : mixed = null
-
Associated data
get_class()
Get the correct exception class for a given error code
public
static get_class(int|bool $code) : string
Parameters
- $code : int|bool
-
HTTP status code, or false if unavailable
Return values
string —Exception class name to use
getData()
Gives any relevant data
public
getData() : mixed
getReason()
Get the status message.
public
getReason() : string
Return values
stringgetType()
Like {@see \Exception::getCode()}, but a string code.
public
getType() : string