Class BaseErrorHandler

Base error handler that provides logic common to the CLI + web error/exception handlers.

Subclasses are required to implement the template methods to handle displaying the errors in their environment.

Abstract
Namespace: Cake\Error

Properties summary

  • $_handled protected
    bool
  • $_options protected
    array

    Options to use for the Error handling.

Method Summary

Method Detail

_displayError() abstract protected 

_displayError(mixed $error, mixed $debug)

Display an error message in an environment specific way.

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

Parameters

array $error

An array of error data.

bool $debug

Whether or not the app is in debug mode.

_displayException() abstract protected 

_displayException(mixed $exception)

Display an exception in an environment specific way.

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

Parameters

\Exception $exception

The uncaught exception.

_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

_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

_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

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

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.BaseErrorHandler.html