CakePHP
  • Documentation
    • Book
    • API
    • Videos
    • Reporting Security Issues
    • Privacy Policy
    • Logos & Trademarks
  • Business Solutions
  • Swag
  • Road Trip
  • Team
  • Community
    • Community
    • Get Involved
    • Issues (Github)
    • Bakery
    • Featured Resources
    • Training
    • Meetups
    • My CakePHP
    • CakeFest
    • Newsletter
    • Linkedin
    • YouTube
    • Facebook
    • Twitter
    • Mastodon
    • Help & Support
    • Forum
    • Stack Overflow
    • IRC
    • Slack
    • Paid Support
CakePHP

C CakePHP 3.2 Red Velvet API

  • Project:
    • CakePHP
      • CakePHP
      • Authentication
      • Authorization
      • Chronos
      • Elastic Search
      • Queue
  • Version:
    • 3.2
      • 5.2
      • 5.1
      • 5.0
      • 4.6
      • 4.5
      • 4.4
      • 4.3
      • 4.2
      • 4.1
      • 4.0
      • 3.10
      • 3.9
      • 3.8
      • 3.7
      • 3.6
      • 3.5
      • 3.4
      • 3.3
      • 3.2
      • 3.1
      • 3.0
      • 2.10
      • 2.9
      • 2.8
      • 2.7
      • 2.6
      • 2.5
      • 2.4
      • 2.3
      • 2.2
      • 2.1
      • 2.0
      • 1.3
      • 1.2

Namespaces

  • Global
  • Cake
    • Auth
    • Cache
    • Collection
    • Console
    • Controller
    • Core
    • Database
    • Datasource
    • Error
    • Event
    • Filesystem
    • Form
    • I18n
    • Log
    • Mailer
    • Network
    • ORM
    • Routing
    • Shell
    • TestSuite
    • Utility
    • Validation
    • View

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.

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

Namespace: Cake\Error
See: \Cake\Error\ExceptionRenderer for more information on how to customize exception rendering.

Property Summary

  • $_options protected
    array

    Options to use for the Error handling.

Method Summary

  • __construct() public

    Constructor

  • _clearOutput() protected

    Clear output buffers so error pages display properly.

  • _displayError() protected

    Display an error.

  • _displayException() protected

    Displays an exception response body.

  • _getMessage() protected

    Generates a formatted error message

  • _logError() protected

    Log an error.

  • _logException() protected

    Handles exception logging

  • _requestContext() protected

    Get the request context for an error/exception trace.

  • _sendResponse() protected

    Method that can be easily stubbed in testing.

  • _stop() protected

    Stop the process.

  • handleError() public

    Set as the default error handler by CakePHP.

  • handleException() public

    Handle uncaught exceptions.

  • handleFatalError() public

    Display/Log a fatal error.

  • increaseMemoryLimit() public

    Increases the PHP "memory_limit" ini setting by the specified amount in kilobytes

  • mapErrorCode() public static

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

  • register() public

    Register the error and exception handlers.

  • 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(array $options = [])

Constructor

Parameters
array $options optional

The options for error handling.

_clearOutput() ¶ protected

_clearOutput(): void

Clear output buffers so error pages display properly.

Easily stubbed in testing.

Returns
void

_displayError() ¶ protected

_displayError(array $error, bool $debug): void

Display an error.

Template method of BaseErrorHandler.

Only when debug > 2 will a formatted error be displayed.

Parameters
array $error

An array of error data.

bool $debug

Whether or not the app is in debug mode.

Returns
void

_displayException() ¶ protected

_displayException(Exception $exception): void

Displays an exception response body.

Subclasses should implement this method to display an uncaught exception as desired for the runtime they operate in.

Parameters
Exception $exception

The exception to display

Returns
void
Throws
Exception
When the chosen exception renderer is invalid.

_getMessage() ¶ protected

_getMessage(Exception $exception): string

Generates a formatted error message

Parameters
Exception $exception

Exception instance

Returns
string

_logError() ¶ protected

_logError(string $level, array $data): bool

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): bool

Handles exception logging

Parameters
Exception $exception

Exception instance.

Returns
bool

_requestContext() ¶ protected

_requestContext(Cake\Network\Request $request): string

Get the request context for an error/exception trace.

Parameters
Cake\Network\Request $request

The request to read from.

Returns
string

_sendResponse() ¶ protected

_sendResponse(string|Cake\Network\Response $response): void

Method that can be easily stubbed in testing.

Parameters
string|Cake\Network\Response $response

Either the message or response object.

Returns
void

_stop() ¶ protected

_stop(int $code): void

Stop the process.

Implemented in subclasses that need it.

Parameters
int $code

Exit code.

Returns
void

handleError() ¶ public

handleError(int $code, string $description, string|null $file = null, int|null $line = null, array|null $context = null): bool

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 > 0. And will log errors to Log, when debug == 0.

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

handleException() ¶ public

handleException(Exception $exception): void

Handle uncaught exceptions.

Uses a template method provided by subclasses to display errors in an environment appropriate way.

Parameters
Exception $exception

Exception instance.

Returns
void
Throws
Exception
When renderer class not found
See Also
http://php.net/manual/en/function.set-exception-handler.php

handleFatalError() ¶ public

handleFatalError(int $code, string $description, string $file, int $line): bool

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(string $additionalKb): void

Increases the PHP "memory_limit" ini setting by the specified amount in kilobytes

Parameters
string $additionalKb

Number in kilobytes

Returns
void

mapErrorCode() ¶ public static

mapErrorCode(int $code): array

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

Parameters
int $code

Error code to map

Returns
array

register() ¶ public

register(): void

Register the error and exception handlers.

Returns
void

wrapAndHandleException() ¶ public

wrapAndHandleException(Exception|Error $exception): void

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

Returns
void

Property Detail

$_options ¶ protected

Options to use for the Error handling.

Type
array
OpenHub
Pingping
Linode
  • Business Solutions
  • Showcase
  • Documentation
  • Book
  • API
  • Videos
  • Reporting Security Issues
  • Privacy Policy
  • Logos & Trademarks
  • Community
  • Get Involved
  • Issues (Github)
  • Bakery
  • Featured Resources
  • Training
  • Meetups
  • My CakePHP
  • CakeFest
  • Newsletter
  • Linkedin
  • YouTube
  • Facebook
  • Twitter
  • Mastodon
  • Help & Support
  • Forum
  • Stack Overflow
  • IRC
  • Slack
  • Paid Support

Generated using CakePHP API Docs