Docs4dev
Docs
cakephp / 3.9 / class-cake.http.exception.httpexception.html

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);

Namespace: Cake\Http\Exception

Properties summary

  • $_attributes protected
    array

    Array of attributes that are passed in from the constructor, and made available in the view when a development error is displayed.

  • $_defaultCode protected
    int

    Default exception code

  • $_messageTemplate protected
    string

    Template string that has attributes sprintf()'ed into it.

  • $_responseHeaders protected
    array|null

    Array of headers to be passed to Cake\Http\Response::header()

Method Summary

Method Detail

__construct() public

__construct(mixed $message, mixed $code, mixed $previous)

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 code of the error, is also the HTTP status code for the error.

\Exception|null $previous optional

the previous exception.

getAttributes() public

getAttributes()

Get the passed in attributes

Returns

array

getCode() public

getCode()

responseHeader() public

responseHeader(mixed $header, mixed $value)

Get/set the response header to be used

See also Cake\Http\Response::withHeader()

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 (deprecated)
string|null $value optional

The header value.

Returns

array|null

Property Detail

$_attributes protected

Array of attributes that are passed in from the constructor, and made available in the view when a development error is displayed.

Type

array

$_defaultCode protected

Default exception code

Type

int

$_messageTemplate protected

Template string that has attributes sprintf()'ed into it.

Type

string

$_responseHeaders protected

Array of headers to be passed to Cake\Http\Response::header()

Type

array|null

© 2005–present The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/3.9/class-Cake.Http.Exception.HttpException.html