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\Exception, 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.
-
$_messageTemplate protected
stringTemplate string that has attributes sprintf()'ed into it.
-
$_responseHeaders protected
arrayArray of headers to be passed to Cake\Network\Response::header()
Method Summary
-
__construct() public
Constructor.
-
getAttributes() public
Get the passed in attributes
-
responseHeader() public
Get/set the response header to be used
Method Detail
__construct() ¶ public
__construct(string|array $message, int $code = 500, Exception $previous = null)Constructor.
Allows you to create exceptions that are treated as framework errors and disabled when debug = 0.
Parameters
-
string|array$message 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$code optional The code of the error, is also the HTTP status code for the error.
-
Exception$previous optional the previous exception.
responseHeader() ¶ public
responseHeader(string|array|null $header = null, string $value = null): arrayGet/set the response header to be used
See also Cake\Network\Response::header()
Parameters
-
string|array|null$header optional An array of header strings or a single header string
- an associative array of "header name" => "header value"
- an array of string headers is also accepted
-
string$value optional The header value.
Returns
array