Class ConsoleException

Exception class for Console libraries. This exception will be thrown from Console library classes when they encounter an error.

Exception
Extended by RuntimeException
Extended by Cake\Core\Exception\Exception
Extended by Cake\Console\Exception\ConsoleException
Namespace: Cake\Console\Exception
Located at Console/Exception/ConsoleException.php

Methods inherited from Cake\Core\Exception\Exception

__constructsource public 

__construct( string|array $message , integer $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
integer $code optional 500
The code of the error, is also the HTTP status code for the error.
Exception $previous optional null
the previous exception.

Overrides

Exception::__construct()

getAttributessource public 

getAttributes( )

Get the passed in attributes

Returns

array
array

responseHeadersource public 

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

Get/set the response header to be used

See also Cake\Network\Response::header()

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

Returns

array
array

Properties inherited from Cake\Core\Exception\Exception

$_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.

[]

$_messageTemplatesource

protected string

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

''

$_responseHeaderssource

protected array

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

null

Properties inherited from Exception

$codesource

protected integer

$filesource

protected mixed

$linesource

protected mixed

$messagesource

protected string 

''

© 2005–2016 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.
http://api.cakephp.org/3.1/class-Cake.Console.Exception.ConsoleException.html