Class ExceptionRenderer
Exception Renderer.
Captures and handles all unhandled exceptions. Displays helpful framework errors when debug is true. When debug is false a CakeException will render 404 or 500 errors. If an uncaught exception is thrown and it is a type that ExceptionHandler does not know about it will be treated as a 500 error.
Implementing application specific exception rendering
You can implement application specific exception handling by creating a subclass of
ExceptionRenderer and configure it to be the exceptionRenderer in config/error.php
Using a subclass of ExceptionRenderer
Using a subclass of ExceptionRenderer gives you full control over how Exceptions are rendered, you can configure your class in your config/app.php.
Property Summary
-
$controller protected
Cake\Controller\ControllerController instance.
-
$error protected
ExceptionThe exception being handled.
-
$method protected
stringThe method corresponding to the Exception this object is for.
-
$request protected
Cake\Http\ServerRequest|nullIf set, this will be request used to create the controller that will render the error.
-
$template protected
stringTemplate to render for Cake\Core\Exception\Exception
Method Summary
-
__construct() public
Creates the controller to perform rendering on the error response. If the error is a Cake\Core\Exception\Exception it will be converted to either a 400 or a 500 code error depending on the code used to construct the error.
-
__debugInfo() public
Returns an array that can be used to describe the internal state of this object.
-
__get() public
Magic accessor for properties made protected.
-
__set() public
Magic setter for properties made protected.
-
_code() protected
Get HTTP status code.
-
_customMethod() protected
Render a custom error method/template.
-
_getController() protected
Get the controller instance to handle the exception. Override this method in subclasses to customize the controller used. This method returns the built in
ErrorControllernormally, or if an error is repeated a bare controller will be used. -
_message() protected
Get error message.
-
_method() protected
Get method name
-
_outputMessage() protected
Generate the response using the controller object.
-
_outputMessageSafe() protected
A safer way to render error messages, replaces all helpers, with basics and doesn't call component methods.
-
_shutdown() protected
Run the shutdown events.
-
_template() protected
Get template for rendering exception info.
-
_unwrap() protected
Returns the unwrapped exception object in case we are dealing with a PHP 7 Error object
-
render() public
Renders the response for the exception.
Method Detail
__construct() ¶ public
__construct(Exception $exception, Cake\Http\ServerRequest $request = null)Creates the controller to perform rendering on the error response. If the error is a Cake\Core\Exception\Exception it will be converted to either a 400 or a 500 code error depending on the code used to construct the error.
Parameters
-
Exception$exception Exception.
-
Cake\Http\ServerRequest$request optional The request - if this is set it will be used instead of creating a new one
__debugInfo() ¶ public
__debugInfo(): arrayReturns an array that can be used to describe the internal state of this object.
Returns
array__get() ¶ public
__get(string $name): mixedMagic accessor for properties made protected.
Parameters
-
string$name Name of the attribute to get.
Returns
mixed__set() ¶ public
__set(string $name, mixed $value): voidMagic setter for properties made protected.
Parameters
-
string$name Name to property.
-
mixed$value Value for property.
Returns
void_code() ¶ protected
_code(Exception $exception): intGet HTTP status code.
Parameters
-
Exception$exception Exception.
Returns
int_customMethod() ¶ protected
_customMethod(string $method, Exception $exception): Cake\Http\ResponseRender a custom error method/template.
Parameters
-
string$method The method name to invoke.
-
Exception$exception The exception to render.
Returns
Cake\Http\Response_getController() ¶ protected
_getController(): Cake\Controller\ControllerGet the controller instance to handle the exception.
Override this method in subclasses to customize the controller used.
This method returns the built in ErrorController normally, or if an error is repeated
a bare controller will be used.
Returns
Cake\Controller\Controller_message() ¶ protected
_message(Exception $exception, int $code): stringGet error message.
Parameters
-
Exception$exception Exception.
-
int$code Error code.
Returns
string_method() ¶ protected
_method(Exception $exception): stringGet method name
Parameters
-
Exception$exception Exception instance.
Returns
string_outputMessage() ¶ protected
_outputMessage(string $template): Cake\Http\ResponseGenerate the response using the controller object.
Parameters
-
string$template The template to render.
Returns
Cake\Http\Response_outputMessageSafe() ¶ protected
_outputMessageSafe(string $template): Cake\Http\ResponseA safer way to render error messages, replaces all helpers, with basics and doesn't call component methods.
Parameters
-
string$template The template to render.
Returns
Cake\Http\Response_shutdown() ¶ protected
_shutdown(): Cake\Http\ResponseRun the shutdown events.
Triggers the afterFilter and afterDispatch events.
Returns
Cake\Http\Response_template() ¶ protected
_template(Exception $exception, string $method, int $code): stringGet template for rendering exception info.
Parameters
-
Exception$exception Exception instance.
-
string$method Method name.
-
int$code Error code.
Returns
string_unwrap() ¶ protected
_unwrap(Exception $exception): ExceptionErrorReturns the unwrapped exception object in case we are dealing with a PHP 7 Error object
Parameters
-
Exception$exception The object to unwrap
Returns
ExceptionErrorrender() ¶ public
render(): Cake\Http\ResponseRenders the response for the exception.
Returns
Cake\Http\ResponseProperty Detail
$request ¶ protected
If set, this will be request used to create the controller that will render the error.
Type
Cake\Http\ServerRequest|null