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.
Property Summary
-
$_config protected
array<string, mixed>Runtime config
-
$_configInitialized protected
boolWhether the config property has already been configured with defaults
-
$_defaultConfig protected
array<string, mixed>Options to use for the Error handling.
-
$_handled protected
bool -
$logger protected
Cake\Error\ErrorLoggerInterface|nullException logger instance.
Method Summary
-
_configDelete() protected
Deletes a single config key.
-
_configRead() protected
Reads a config key.
-
_configWrite() protected
Writes a config key.
-
_displayError() abstract protected
Display an error message in an environment specific way.
-
_displayException() abstract protected
Display an exception in an environment specific way.
-
_logError() protected
Log an error.
-
_stop() protected
Stop 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 uncaught exceptions.
-
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
Errorthen, it wraps the passed object inside another Exception object for backwards compatibility purposes.
Method Detail
_configDelete() ¶ protected
_configDelete(string $key): voidDeletes a single config key.
Parameters
-
string$key Key to delete.
Returns
voidThrows
Cake\Core\Exception\CakeExceptionif attempting to clobber existing config
_configRead() ¶ protected
_configRead(string|null $key): mixedReads 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): voidWrites 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
voidThrows
Cake\Core\Exception\CakeExceptionif attempting to clobber existing config
_displayError() ¶ abstract protected
_displayError(array $error, bool $debug): voidDisplay 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 the app is in debug mode.
Returns
void_displayException() ¶ abstract protected
_displayException(Throwable $exception): voidDisplay 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
-
Throwable$exception The uncaught exception.
Returns
void_logError() ¶ protected
_logError(string|int $level, array $data): boolLog 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): voidStop the process.
Implemented in subclasses that need it.
Parameters
-
int$code Exit code.
Returns
voidconfigShallow() ¶ public
configShallow(array<string, mixed>|string $key, mixed|null $value = null): $thisMerge 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
$thisgetConfig() ¶ public
getConfig(string|null $key = null, mixed $default = null): mixedReturns 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
mixedgetConfigOrFail() ¶ public
getConfigOrFail(string $key): mixedReturns 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
mixedThrows
InvalidArgumentExceptiongetLogger() ¶ public
getLogger(): Cake\Error\ErrorLoggerInterfaceGet exception logger.
Returns
Cake\Error\ErrorLoggerInterfacehandleError() ¶ public
handleError(int $code, string $description, string|null $file = null, int|null $line = null, array<string, mixed>|null $context = null): boolSet 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
boolhandleException() ¶ public
handleException(Throwable $exception): voidHandle uncaught exceptions.
Uses a template method provided by subclasses to display errors in an environment appropriate way.
Parameters
-
Throwable$exception Exception instance.
Returns
voidThrows
ExceptionWhen renderer class not found
See Also
handleFatalError() ¶ public
handleFatalError(int $code, string $description, string $file, int $line): boolDisplay/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
boolincreaseMemoryLimit() ¶ public
increaseMemoryLimit(int $additionalKb): voidIncreases the PHP "memory_limit" ini setting by the specified amount in kilobytes
Parameters
-
int$additionalKb Number in kilobytes
Returns
voidlogException() ¶ public
logException(Throwable $exception, Psr\Http\Message\ServerRequestInterface|null $request = null): boolLog 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
boolmapErrorCode() ¶ public static
mapErrorCode(int $code): arrayMap an error code into an Error word, and log location.
Parameters
-
int$code Error code to map
Returns
arraysetConfig() ¶ public
setConfig(array<string, mixed>|string $key, mixed|null $value = null, bool $merge = true): $thisSets 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
$thisThrows
Cake\Core\Exception\CakeExceptionWhen trying to set a key that is invalid.
wrapAndHandleException() ¶ public
wrapAndHandleException(Throwable $exception): voidChecks 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
voidProperty Detail
$_configInitialized ¶ protected
Whether the config property has already been configured with defaults
Type
bool