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.
arrayRuntime config
boolWhether the config property has already been configured with defaults
arrayOptions to use for the Error handling.
bool\Cake\Error\ErrorLoggerInterface|nullException logger instance.
Merge provided config with existing config. Unlike config() which does a recursive merge for nested keys, this method does a simple merge.
Increases the PHP "memory_limit" ini setting by the specified amount in kilobytes
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.
_configDelete(string $key)
Deletes a single config key.
string $key Key to delete.
Cake\Core\Exception\Exception_configRead(?string $key)
Reads a config key.
string|null $key Key to read.
mixed_configWrite(mixed $key, mixed $value, mixed $merge)
Writes a config key.
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.
Cake\Core\Exception\Exception_displayError(array $error, bool $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.
array $error An array of error data.
bool $debug Whether or not the app is in debug mode.
_displayException(\Throwable $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.
\Throwable $exception The uncaught exception.
_logError(mixed $level, array $data)
Log an error.
int|string $level The level name of the log.
array $data Array of error data.
bool_stop(int $code)
Stop the process.
Implemented in subclasses that need it.
int $code Exit code.
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']);
string|array $key The key to set, or a complete array of configs.
mixed|null $value optional The value to set.
$thisgetConfig(?string $key, mixed $default)
Returns the config.
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'); 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.
mixedConfiguration data at the named key or null if the key does not exist.
getConfigOrFail(string $key)
Returns the config for this specific key.
The config value for this key must exist, it can never be null.
string $key The key to get.
mixedConfiguration data at the named key
InvalidArgumentExceptiongetLogger()
Get exception logger.
\Cake\Error\ErrorLoggerInterfacehandleError(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.
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
boolTrue if error was handled
handleException(\Throwable $exception)
Handle uncaught exceptions.
Uses a template method provided by subclasses to display errors in an environment appropriate way.
\Throwable $exception Exception instance.
ExceptionhandleFatalError(int $code, string $description, string $file, int $line)
Display/Log a fatal error.
int $code Code of error
string $description Error description
string $file File on which error occurred
int $line Line that triggered the error
boolincreaseMemoryLimit(int $additionalKb)
Increases the PHP "memory_limit" ini setting by the specified amount in kilobytes
int $additionalKb Number in kilobytes
logException(\Throwable $exception, ?\Psr\Http\Message\ServerRequestInterface $request)
Log an error for the exception if applicable.
\Throwable $exception The exception to log a message for.
\Psr\Http\Message\ServerRequestInterface $request optional The current request.
boolmapErrorCode(int $code)
Map an error code into an Error word, and log location.
int $code Error code to map
arrayArray of error word, and log location.
register()
Register the error and exception handlers.
setConfig(mixed $key, mixed $value, mixed $merge)
Sets the config.
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']);
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.
$thisCake\Core\Exception\ExceptionwrapAndHandleException(\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.
\Throwable $exception The exception to handle
Runtime config
arrayWhether the config property has already been configured with defaults
boolOptions to use for the Error handling.
arrayboolException logger instance.
\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.1/class-Cake.Error.BaseErrorHandler.html