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 > 1.

Uncaught exceptions

When debug < 1 a CakeException will render 404 or 500 errors. If an uncaught exception is thrown and it is a type that ErrorHandler 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.

  • Set Configure::write('Exception.handler', 'YourClass::yourMethod');
  • Create AppController::appError();
  • Set Configure::write('Exception.renderer', 'YourClass');

Create your own Exception handler with Exception.handler

This gives you full control over the exception handling process. The class you choose should be loaded in your app/Config/bootstrap.php, so its available to handle any exceptions. You can define the handler as any callback type. Using Exception.handler overrides all other exception handling settings and logic.

Using AppController::appError();

This controller method is called instead of the default exception rendering. It receives the thrown exception as its only argument. You should implement your error handling in that method. Using AppController::appError(), will supersede any configuration for Exception.renderer.

Using a custom renderer with Exception.renderer

If you don't want to take control of the exception handling, but want to change how exceptions are rendered you can use Exception.renderer to choose a class to render exception pages. By default ExceptionRenderer is used. Your custom exception renderer class should be placed in app/Lib/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 Exception.log to true in your core.php. Enabling this will log every exception to CakeLog 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 CakeLog. You can control which errors are logged by setting Error.level in your core.php.

Logging errors

When ErrorHandler is used for handling errors, you can enable error logging by setting Error.log 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 Error.level. Setting this to one or a combination of a few of the E_* constants will only enable the specified errors.

e.g. Configure::write('Error.level', E_ALL & ~E_NOTICE);

Would enable handling for all non Notice errors.

Package: Cake\Error
See: ExceptionRenderer for more information on how to customize exception rendering.
Copyright: Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
License: MIT License
Location: Cake/Error/ErrorHandler.php

Properties summary

  • $_bailExceptionRendering protected static
    boolean

    Whether to give up rendering an exception, if the renderer itself is throwing exceptions.

Method Summary

  • _getErrorMessage() protected static
    Generate the string to use to describe the error.
  • _getMessage() protected static
    Generates a formatted error message
  • _log() protected static
    Handles exception logging
  • handleError() public static

    Set as the default error handler by CakePHP. Use Configure::write('Error.handler', $callback), to use your own error handling methods. This function will use Debugger to display errors when debug > 0. And will log errors to CakeLog, when debug == 0.

  • handleException() public static
    Set as the default exception handler by the CakePHP bootstrap process.
  • handleFatalError() public static
    Generate an error page when some fatal error happens.
  • mapErrorCode() public static
    Map an error code into an Error word, and log location.

Method Detail

_getErrorMessage()source protected static

_getErrorMessage( string $error , integer $code , string $description , string $file , integer $line )

Generate the string to use to describe the error.

Parameters

string $error
The error type (e.g. "Warning")
integer $code
Code of error
string $description
Error description
string $file
File on which error occurred
integer $line
Line that triggered the error

Returns

string

_getMessage()source protected static

_getMessage( Exception $exception )

Generates a formatted error message

Parameters

Exception $exception
Exception instance

Returns

string
Formatted message

_log()source protected static

_log( Exception|ParseError $exception , array $config )

Handles exception logging

Parameters

Exception|ParseError $exception
The exception to render.
array $config
An array of configuration for logging.

Returns

boolean

handleError()source public static

handleError( integer $code , string $description , string $file null , integer $line null , array $context null )

Set as the default error handler by CakePHP. Use Configure::write('Error.handler', $callback), to use your own error handling methods. This function will use Debugger to display errors when debug > 0. And will log errors to CakeLog, when debug == 0.

You can use Configure::write('Error.level', $value); to set what type of errors will be handled here. Stack traces for errors can be enabled with Configure::write('Error.trace', true);

Parameters

integer $code
Code of error
string $description
Error description
string $file optional null
File on which error occurred
integer $line optional null
Line that triggered the error
array $context optional null
Context

Returns

boolean
true if error was handled

handleException()source public static

handleException( Exception|ParseError $exception )

Set as the default exception handler by the CakePHP bootstrap process.

This will either use custom exception renderer class if configured, or use the default ExceptionRenderer.

Parameters

Exception|ParseError $exception
The exception to render.

See

http://php.net/manual/en/function.set-exception-handler.php

handleFatalError()source public static

handleFatalError( integer $code , string $description , string $file , integer $line )

Generate an error page when some fatal error happens.

Parameters

integer $code
Code of error
string $description
Error description
string $file
File on which error occurred
integer $line
Line that triggered the error

Returns

boolean

Throws

FatalErrorException
If the Exception renderer threw an exception during rendering, and debug > 0.
InternalErrorException
If the Exception renderer threw an exception during rendering, and debug is 0.

mapErrorCode()source public static

mapErrorCode( integer $code )

Map an error code into an Error word, and log location.

Parameters

integer $code
Error code to map

Returns

array
Array of error word, and log location.

Properties detail

$_bailExceptionRenderingsource

protected static boolean

Whether to give up rendering an exception, if the renderer itself is throwing exceptions.

false

© 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.
https://api.cakephp.org/2.9/class-ErrorHandler.html