Class ConsoleErrorHandler

Error Handler for Cake console. Does simple printing of the exception that occurred and the stack trace of the error.

Namespace: Cake\Error

Properties summary

  • $_config protected
    array

    Runtime config

  • $_configInitialized protected
    bool

    Whether the config property has already been configured with defaults

  • $_defaultConfig protected
    array

    Options to use for the Error handling.

  • $_handled protected
    bool
  • $_stderr protected
    \Cake\Console\ConsoleOutput

    Standard error stream.

  • $logger protected
    \Cake\Error\ErrorLogger|null

    Exception logger instance.

Method Summary

  • __construct() public

    Constructor

  • _configDelete() protected

    Deletes a single config key.

  • _configRead() protected

    Reads a config key.

  • _configWrite() protected

    Writes a config key.

  • _displayError() protected

    Prints an error to stderr.

  • _displayException() protected

    Prints an exception to stderr.

  • _logError() protected

    Log an error.

  • _stop() protected

    Stop the execution and set the exit code for the process.

  • configShallow() public

    Merge provided config with existing config. Unlike config() which does a recursive merge for nested keys, this method does a simple merge.

  • getConfig() public

    Returns the config.

  • getConfigOrFail() public

    Returns the config for this specific key.

  • getLogger() public

    Get exception logger.

  • handleError() public

    Set as the default error handler by CakePHP.

  • handleException() public

    Handle errors in the console environment. Writes errors to stderr, and logs messages if Configure::read('debug') is false.

  • handleFatalError() public

    Display/Log a fatal error.

  • increaseMemoryLimit() public

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

  • logException() public

    Log an error for the exception if applicable.

  • mapErrorCode() public static

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

  • register() public

    Register the error and exception handlers.

  • setConfig() public

    Sets the config.

  • 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 $config)

Constructor

Parameters

array $config optional

Config options for the error handler.

_configDelete() protected 

_configDelete(string $key)

Deletes a single config key.

Parameters

string $key

Key to delete.

Throws

Cake\Core\Exception\Exception
if attempting to clobber existing config

_configRead() protected 

_configRead(?string $key)

Reads a config key.

Parameters

string|null $key

Key to read.

Returns

mixed

_configWrite() protected 

_configWrite(mixed $key, mixed $value, mixed $merge)

Writes a config key.

Parameters

string|array $key

Key to write to.

mixed $value

Value to write.

bool|string $merge optional

True to merge recursively, 'shallow' for simple merge, false to overwrite, defaults to false.

Throws

Cake\Core\Exception\Exception
if attempting to clobber existing config

_displayError() protected 

_displayError(array $error, bool $debug)

Prints an error to stderr.

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(\Throwable $exception)

Prints an exception to stderr.

Parameters

\Throwable $exception

The exception to handle

_logError() protected 

_logError(mixed $level, array $data)

Log an error.

Parameters

int|string $level

The level name of the log.

array $data

Array of error data.

Returns

bool

_stop() protected 

_stop(int $code)

Stop the execution and set the exit code for the process.

Parameters

int $code

The exit code.

configShallow() public 

configShallow(mixed $key, mixed $value)

Merge provided config with existing config. Unlike config() which does a recursive merge for nested keys, this method does a simple merge.

Setting a specific value:

$this->configShallow('key', $value);

Setting a nested value:

$this->configShallow('some.nested.key', $value);

Updating multiple config settings at the same time:

$this->configShallow(['one' => 'value', 'another' => 'value']);

Parameters

string|array $key

The key to set, or a complete array of configs.

mixed|null $value optional

The value to set.

Returns

$this

getConfig() public 

getConfig(?string $key, mixed $default)

Returns the config.

Usage

Reading the whole config:

$this->getConfig();

Reading a specific value:

$this->getConfig('key');

Reading a nested value:

$this->getConfig('some.nested.key');

Reading with default value:

$this->getConfig('some-key', 'default-value');

Parameters

string|null $key optional

The key to get or null for the whole config.

mixed $default optional

The return value when the key does not exist.

Returns

mixed

Configuration data at the named key or null if the key does not exist.

getConfigOrFail() public 

getConfigOrFail(string $key)

Returns the config for this specific key.

The config value for this key must exist, it can never be null.

Parameters

string $key

The key to get.

Returns

mixed

Configuration data at the named key

Throws

InvalidArgumentException

getLogger() public 

getLogger()

Get exception logger.

Returns

\Cake\Error\ErrorLogger

handleError() public 

handleError(int $code, string $description, ?string $file, ?int $line, ?array $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(\Throwable $exception)

Handle errors in the console environment. Writes errors to stderr, and logs messages if Configure::read('debug') is false.

Parameters

\Throwable $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(int $code, string $description, string $file, int $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(int $additionalKb)

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

Parameters

int $additionalKb

Number in kilobytes

logException() public 

logException(\Throwable $exception, ?\Psr\Http\Message\ServerRequestInterface $request)

Log an error for the exception if applicable.

Parameters

\Throwable $exception

The exception to log a message for.

\Psr\Http\Message\ServerRequestInterface $request optional

The current request.

Returns

bool

mapErrorCode() public static 

mapErrorCode(int $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.

setConfig() public 

setConfig(mixed $key, mixed $value, mixed $merge)

Sets the config.

Usage

Setting a specific value:

$this->setConfig('key', $value);

Setting a nested value:

$this->setConfig('some.nested.key', $value);

Updating multiple config settings at the same time:

$this->setConfig(['one' => 'value', 'another' => 'value']);

Parameters

string|array $key

The key to set, or a complete array of configs.

mixed|null $value optional

The value to set.

bool $merge optional

Whether to recursively merge or overwrite existing config, defaults to true.

Returns

$this

Throws

Cake\Core\Exception\Exception
When trying to set a key that is invalid.

wrapAndHandleException() public 

wrapAndHandleException(\Throwable $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

\Throwable $exception

The exception to handle

Property Detail

$_config protected

Runtime config

Type

array

$_configInitialized protected

Whether the config property has already been configured with defaults

Type

bool

$_defaultConfig protected

Options to use for the Error handling.

Type

array

$_handled protected

Type

bool

$_stderr protected

Standard error stream.

Type

\Cake\Console\ConsoleOutput

$logger protected

Exception logger instance.

Type

\Cake\Error\ErrorLogger|null

© 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.0/class-Cake.Error.ConsoleErrorHandler.html