Docs4dev
Docs
cakephp / 4.4 / class-cake.error.consoleerrorhandler.html

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

Property Summary

  • $_config protected
    array<string, mixed>

    Runtime config

  • $_configInitialized protected
    bool

    Whether the config property has already been configured with defaults

  • $_defaultConfig protected
    array<string, mixed>

    Options to use for the Error handling.

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

    Standard error stream.

  • $logger protected
    Cake\Error\ErrorLoggerInterface|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 deprecated

    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<string, mixed> $config = [])

Constructor

Parameters

array<string, mixed> $config optional

Config options for the error handler.

_configDelete() protected

_configDelete(string $key): void

Deletes a single config key.

Parameters

string $key

Key to delete.

Returns

void

Throws

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

_configRead() protected

_configRead(string|null $key): mixed

Reads a config key.

Parameters

string|null $key

Key to read.

Returns

mixed

_configWrite() protected

_configWrite(array<string, mixed>|string $key, mixed $value, string|bool $merge = false): void

Writes a config key.

Parameters

array<string, mixed>|string $key

Key to write to.

mixed $value

Value to write.

string|bool $merge optional

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

Returns

void

Throws

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

_displayError() protected

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

Prints an error to stderr.

Template method of BaseErrorHandler.

Parameters

array $error

An array of error data.

bool $debug

Whether the app is in debug mode.

Returns

void

_displayException() protected

_displayException(Throwable $exception): void

Prints an exception to stderr.

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

Parameters

Throwable $exception

The exception to handle

Returns

void

_logError() protected

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

Log an error.

Parameters

string|int $level

The level name of the log.

array $data

Array of error data.

Returns

bool

_stop() protected

_stop(int $code): void

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

Implemented in subclasses that need it.

Parameters

int $code

The exit code.

Returns

void

configShallow() public

configShallow(array<string, mixed>|string $key, mixed|null $value = null): $this

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

array<string, mixed>|string $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|null $key = null, mixed $default = null): mixed

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

getConfigOrFail() public

getConfigOrFail(string $key): mixed

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

Throws

InvalidArgumentException

getLogger() public

getLogger(): Cake\Error\ErrorLoggerInterface

Get exception logger.

Returns

Cake\Error\ErrorLoggerInterface

handleError() public

handleError(int $code, string $description, string|null $file = null, int|null $line = null, array<string, mixed>|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 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<string, mixed>|null $context optional

Context

Returns

bool

handleException() public

handleException(Throwable $exception): void

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

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

Parameters

Throwable $exception

Exception instance.

Returns

void

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

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

Parameters

int $additionalKb

Number in kilobytes

Returns

void

logException() public

logException(Throwable $exception, Psr\Http\Message\ServerRequestInterface|null $request = null): bool

Log an error for the exception if applicable.

Parameters

Throwable $exception

The exception to log a message for.

Psr\Http\Message\ServerRequestInterface|null $request optional

The current request.

Returns

bool

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

setConfig() public

setConfig(array<string, mixed>|string $key, mixed|null $value = null, bool $merge = true): $this

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

array<string, mixed>|string $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\CakeException
When trying to set a key that is invalid.

wrapAndHandleException() public

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

Throwable $exception

The exception to handle

Returns

void

Property Detail

$_config protected

Runtime config

Type

array<string, mixed>

$_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<string, mixed>

$_handled protected

Type

bool

$_stderr protected

Standard error stream.

Type

Cake\Console\ConsoleOutput

$logger protected

Exception logger instance.

Type

Cake\Error\ErrorLoggerInterface|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.4/class-Cake.Error.ConsoleErrorHandler.html