Class Exception

Base class that all CakePHP Exceptions extend.

Exception implements Throwable
Extended by RuntimeException
Extended by Cake\Core\Exception\Exception

Direct Subclasses

Indirect Subclasses

Namespace: Cake\Core\Exception
Location: Core/Exception/Exception.php

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
    integer
    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()

Inherited Properties

  • code, file, line, message

Method Summary

Method Detail

__construct()source public 

__construct( string|array $message = '' , integer|null $code = null , Exception|null $previous = null )

Constructor.

Allows you to create exceptions that are treated as framework errors and disabled when debug = 0.

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

integer|null $code optional null
The code of the error, is also the HTTP status code for the error.
Exception|null $previous optional null
the previous exception.

Overrides

Exception::__construct()

getAttributes()source public 

getAttributes( )

Get the passed in attributes

Returns

array

responseHeader()source public 

responseHeader( string|array|null $header = null , string|null $value = null )

Get/set the response header to be used

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

Parameters

string|array|null $header optional null

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 null
The header value.

Returns

array

Properties detail

$_attributessource

protected array

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

[]

$_defaultCodesource

protected integer

Default exception code

500

$_messageTemplatesource

protected string

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

''

$_responseHeaderssource

protected array|null

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

© 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.7/class-Cake.Core.Exception.Exception.html