Class ErrorHandler
Error Handler provides basic error and exception handling for your application. It captures and handles all unhandled exceptions and errors. Displays helpful framework errors when debug mode is on.
Uncaught exceptions
When debug mode is off a ExceptionRenderer will render 404 or 500 errors. If an uncaught exception is thrown and it is a type that ExceptionRenderer does not know about it will be treated as a 500 error.
Implementing application specific exception handling
You can implement application specific exception handling in one of a few ways. Each approach gives you different amounts of control over the exception handling process.
- Modify config/error.php and setup custom exception handling.
- Use the
exceptionRenderer
option to inject an Exception renderer. This will let you keep the existing handling logic but override the rendering logic.
Create your own Exception handler
This gives you full control over the exception handling process. The class you choose should be loaded in your config/error.php and registered as the default exception handler.
Using a custom renderer with exceptionRenderer
If you don't want to take control of the exception handling, but want to change how exceptions are rendered you can use exceptionRenderer
option to choose a class to render exception pages. By default Cake\Error\ExceptionRenderer
is used. Your custom exception renderer class should be placed in src/Error.
Your custom renderer should expect an exception in its constructor, and implement a render method. Failing to do so will cause additional errors.
Logging exceptions
Using the built-in exception handling, you can log all the exceptions that are dealt with by ErrorHandler by setting log
option to true in your config/error.php. Enabling this will log every exception to Log and the configured loggers.
PHP errors
Error handler also provides the built in features for handling php errors (trigger_error). While in debug mode, errors will be output to the screen using debugger. While in production mode, errors will be logged to Log. You can control which errors are logged by setting errorLevel
option in config/error.php.
Logging errors
When ErrorHandler is used for handling errors, you can enable error logging by setting the log
option to true. This will log all errors to the configured log handlers.
Controlling what errors are logged/displayed
You can control which errors are logged / displayed by ErrorHandler by setting errorLevel
. Setting this to one or a combination of a few of the E_* constants will only enable the specified errors:
$options['errorLevel'] = E_ALL & ~E_NOTICE;
Would enable handling for all non Notice errors.
Properties summary
Method Summary
- increaseMemoryLimit() public
Increases the PHP "memory_limit" ini setting by the specified amount in kilobytes
- wrapAndHandleException() public
Checks the passed exception type. If it is an instance of
Error
then, it wraps the passed object inside another Exception object for backwards compatibility purposes.
Method Detail
__construct() public
__construct(mixed $options)
Constructor
Parameters
-
array
$options optional The options for error handling.
_clearOutput() protected
_clearOutput()
Clear output buffers so error pages display properly.
Easily stubbed in testing.
_displayError() protected
_displayError(mixed $error, mixed $debug)
Display an error.
Template method of BaseErrorHandler.
Parameters
-
array
$error An array of error data.
-
bool
$debug Whether or not the app is in debug mode.
_displayException() protected
_displayException(mixed $exception)
Displays an exception response body.
Parameters
-
\Exception
$exception The exception to display.
Throws
Exception
When the chosen exception renderer is invalid.
_getMessage() protected
_getMessage(\Exception $exception)
Generates a formatted error message
Parameters
-
\Exception
$exception Exception instance
Returns
string
Formatted message
_logError() protected
_logError(mixed $level, mixed $data)
Log an error.
Parameters
-
string
$level The level name of the log.
-
array
$data Array of error data.
Returns
bool
_logException() protected
_logException(\Exception $exception)
Handles exception logging
Parameters
-
\Exception
$exception Exception instance.
Returns
bool
_logInternalError() protected
_logInternalError(mixed $exception)
Logs both PHP5 and PHP7 errors.
The PHP5 part will be removed with 4.0.
Parameters
-
\Throwable|\Exception
$exception Exception.
_requestContext() protected
_requestContext(mixed $request)
Get the request context for an error/exception trace.
Parameters
-
\Cake\Http\ServerRequest
$request The request to read from.
Returns
string
_sendResponse() protected
_sendResponse(mixed $response)
Method that can be easily stubbed in testing.
Parameters
-
string|\Cake\Http\Response
$response Either the message or response object.
_stop() protected
_stop(mixed $code)
Stop the process.
Implemented in subclasses that need it.
Parameters
-
int
$code Exit code.
getMessageForException() protected
getMessageForException(mixed $exception, mixed $isPrevious)
Generate the message for the exception
Parameters
-
\Exception
$exception The exception to log a message for.
-
bool
$isPrevious optional False for original exception, true for previous
Returns
string
Error message
handleError() public
handleError(mixed $code, mixed $description, mixed $file, mixed $line, mixed $context)
Set as the default error handler by CakePHP.
Use config/error.php to customize or replace this error handler. This function will use Debugger to display errors when debug mode is on. And will log errors to Log, when debug mode is off.
You can use the 'errorLevel' option to set what type of errors will be handled. Stack traces for errors can be enabled with the 'trace' option.
Parameters
-
int
$code Code of error
-
string
$description Error description
-
string|null
$file optional File on which error occurred
-
int|null
$line optional Line that triggered the error
-
array|null
$context optional Context
Returns
bool
True if error was handled
handleException() public
handleException(\Exception $exception)
Handle uncaught exceptions.
Uses a template method provided by subclasses to display errors in an environment appropriate way.
Parameters
-
\Exception
$exception Exception instance.
Throws
Exception
When renderer class not found
See Also
handleFatalError() public
handleFatalError(mixed $code, mixed $description, mixed $file, mixed $line)
Display/Log a fatal error.
Parameters
-
int
$code Code of error
-
string
$description Error description
-
string
$file File on which error occurred
-
int
$line Line that triggered the error
Returns
bool
increaseMemoryLimit() public
increaseMemoryLimit(mixed $additionalKb)
Increases the PHP "memory_limit" ini setting by the specified amount in kilobytes
Parameters
-
int
$additionalKb Number in kilobytes
mapErrorCode() public static
mapErrorCode(mixed $code)
Map an error code into an Error word, and log location.
Parameters
-
int
$code Error code to map
Returns
array
Array of error word, and log location.
register() public
register()
Register the error and exception handlers.
wrapAndHandleException() public
wrapAndHandleException(mixed $exception)
Checks the passed exception type. If it is an instance of Error
then, it wraps the passed object inside another Exception object for backwards compatibility purposes.
Parameters
-
\Exception|\Error
$exception The exception to handle
Property Detail
$_handled protected
Type
bool
$_options protected
Options to use for the Error handling.
Type
array
© 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/3.9/class-Cake.Error.ErrorHandler.html