Class ConsoleException
Exception class for Console libraries. This exception will be thrown from Console library classes when they encounter an error.
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.
-
$_defaultCode protected
intDefault exception code
-
$_messageTemplate protected
stringTemplate string that has attributes sprintf()'ed into it.
-
$_responseHeaders protected
array|nullArray of headers to be passed to Cake\Http\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|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
-
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.
responseHeader() ¶ public
responseHeader(string|array|null $header = null, string|null $value = null): arrayGet/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