Exception Renderer.
Captures and handles all unhandled exceptions. Displays helpful framework errors when debug is true. When debug is false a ExceptionRenderer 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.
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 gives you full control over how Exceptions are rendered, you can configure your class in your config/app.php.
\Cake\Controller\Controller
Controller instance.
\Throwable
The exception being handled.
string
The method corresponding to the Exception this object is for.
\Cake\Http\ServerRequest|null
If set, this will be request used to create the controller that will render the error.
string
Template to render for Cake\Core\Exception\Exception
Returns an array that can be used to describe the internal state of this object.
A safer way to render error messages, replaces all helpers, with basics and doesn't call component methods.
__construct(\Throwable $exception, ?\Cake\Http\ServerRequest $request)
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.
\Throwable
$exception Exception.
\Cake\Http\ServerRequest
$request optional The request if this is set it will be used instead of creating a new one.
__debugInfo()
Returns an array that can be used to describe the internal state of this object.
array
_code(\Throwable $exception)
Get HTTP status code.
\Throwable
$exception Exception.
int
A valid HTTP error status code.
_customMethod(string $method, \Throwable $exception)
Render a custom error method/template.
string
$method The method name to invoke.
\Throwable
$exception The exception to render.
\Cake\Http\Response
The response to send.
_getController()
Get 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.
\Cake\Controller\Controller
_message(\Throwable $exception, int $code)
Get error message.
\Throwable
$exception Exception.
int
$code Error code.
string
Error message
_method(\Throwable $exception)
Get method name
\Throwable
$exception Exception instance.
string
_outputMessage(string $template)
Generate the response using the controller object.
string
$template The template to render.
\Cake\Http\Response
A response object that can be sent.
_outputMessageSafe(string $template)
A safer way to render error messages, replaces all helpers, with basics and doesn't call component methods.
string
$template The template to render.
\Cake\Http\Response
A response object that can be sent.
_shutdown()
Run the shutdown events.
Triggers the afterFilter and afterDispatch events.
\Cake\Http\Response
The response to serve.
_template(\Throwable $exception, string $method, int $code)
Get template for rendering exception info.
\Throwable
$exception Exception instance.
string
$method Method name.
int
$code Error code.
string
Template name
clearOutput()
Clear output buffers so error pages display properly.
render()
Renders the response for the exception.
\Cake\Http\Response
The response to be sent.
Controller instance.
\Cake\Controller\Controller
The exception being handled.
\Throwable
The method corresponding to the Exception this object is for.
string
If set, this will be request used to create the controller that will render the error.
\Cake\Http\ServerRequest|null
Template to render for Cake\Core\Exception\Exception
string
© 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/4.1/class-Cake.Error.ExceptionRenderer.html