Class CakeException

CakeException is used a base class for CakePHP's internal exceptions. In general framework errors are interpreted as 500 code errors.

Exception implements Throwable
Extended by RuntimeException
Extended by CakeBaseException
Extended by CakeException

Direct Subclasses

Package: Cake\Error
Copyright: Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
License: MIT License
Location: Cake/Error/exceptions.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.

  • $_messageTemplate protected
    string
    Template string that has attributes sprintf()'ed into it.

Inherited Properties

Method Summary

Method Detail

__construct()source public 

__construct( string|array $message , integer $code 500 )

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 CakeException::$_messageTemplate

integer $code optional 500
The code of the error, is also the HTTP status code for the error.

Overrides

Exception::__construct()

getAttributes()source public 

getAttributes( )

Get the passed in attributes

Returns

array

Methods inherited from CakeBaseException

responseHeader()source public 

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

Get/set the response header to be used

Parameters

string|array $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

string $value optional null
The header value.

Returns

array

See

CakeResponse::header()

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.

array()

$_messageTemplatesource

protected string

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

''

© 2005–2017 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/2.10/class-CakeException.html