Class HttpException
Parent class for all of the HTTP related exceptions in CakePHP. All HTTP status/error related exceptions should extend this class so catch blocks can be specifically typed.
You may also use this as a meaningful bridge to Cake\Core\Exception\CakeException, e.g.: throw new \Cake\Network\Exception\HttpException('HTTP Version Not Supported', 505);
Property Summary
-
$_attributes protected
arrayArray of attributes that are passed in from the constructor, and made available in the view when a development error is displayed.
-
$_defaultCode protected
intDefault exception code
-
$_messageTemplate protected
stringTemplate string that has attributes sprintf()'ed into it.
-
$_responseHeaders protected
array|nullArray of headers to be passed to Cake\Http\Response::header()
-
$headers protected
array
Method Summary
-
__construct() public
Constructor.
-
getAttributes() public
Get the passed in attributes
-
getCode() public @method
Gets the Exception code.
-
getHeaders() public
Returns array of response headers.
-
responseHeader() public deprecated
Get/set the response header to be used
-
setHeader() public
Set a single HTTP response header.
-
setHeaders() public
Sets HTTP response headers.
Method Detail
__construct() ¶ public
__construct(string|array $message = '', int|null $code = null, Throwable|null $previous = null)Constructor.
Allows you to create exceptions that are treated as framework errors and disabled when debug mode is off.
Parameters
-
string|array$message optional Either the string of the error message, or an array of attributes that are made available in the view, and sprintf()'d into Exception::$_messageTemplate
-
int|null$code optional The error code
-
Throwable|null$previous optional the previous exception.
responseHeader() ¶ public
responseHeader(string|array|null $header = null, string|null $value = null): array|nullGet/set the response header to be used
See also Cake\Http\Response::withHeader()
Parameters
-
string|array|null$header optional A single header string or an associative array of "header name" => "header value"
-
string|null$value optional The header value.
Returns
array|nullsetHeader() ¶ public
setHeader(string $header, string|string[]|null $value = null): voidSet a single HTTP response header.
Parameters
-
string$header Header name
-
string|string[]|null$value optional Header value
Returns
voidsetHeaders() ¶ public
setHeaders(array $headers): voidSets HTTP response headers.
Parameters
-
array$headers Array of header name and value pairs.
Returns
void