Class ErrorTrap
Entry point to CakePHP's error handling.
Using the register() method you can attach an ErrorTrap to PHP's default error handler.
When errors are trapped, errors are logged (if logging is enabled). Then the Error.beforeRender event is triggered.
Finally, errors are 'rendered' using the defined renderer. If no error renderer is defined in configuration
one of the default implementations will be chosen based on the PHP SAPI.
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>Configuration options. Generally these are defined in config/app.php
-
$_eventClass protected
stringDefault class name for new event objects.
-
$_eventManager protected
Cake\Event\EventManagerInterface|nullInstance of the Cake\Event\EventManager this object is using to dispatch inner events.
Method Summary
-
__construct() public
Constructor
-
_configDelete() protected
Deletes a single config key.
-
_configRead() protected
Reads a config key.
-
_configWrite() protected
Writes a config key.
-
chooseErrorRenderer() protected
Choose an error renderer based on config or the SAPI
-
configShallow() public
Merge provided config with existing config. Unlike
config()which does a recursive merge for nested keys, this method does a simple merge. -
dispatchEvent() public
Wrapper for creating and dispatching events.
-
getConfig() public
Returns the config.
-
getConfigOrFail() public
Returns the config for this specific key.
-
getEventManager() public
Returns the Cake\Event\EventManager manager instance for this object.
-
handleError() public
Handle an error from PHP set_error_handler
-
logError() protected
Logging helper method.
-
logger() public
Get an instance of the logger.
-
register() public
Attach this ErrorTrap to PHP's default error handler.
-
renderer() public
Get an instance of the renderer.
-
setConfig() public
Sets the config.
-
setEventManager() public
Returns the Cake\Event\EventManagerInterface instance for this object.
Method Detail
__construct() ¶ public
__construct(array<string, mixed> $options = [])Constructor
Parameters
-
array<string, mixed>$options optional An options array. See $_defaultConfig.
_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
chooseErrorRenderer() ¶ protected
chooseErrorRenderer(): class-string<Cake\Error\ErrorRendererInterface>Choose an error renderer based on config or the SAPI
Returns
class-string<Cake\Error\ErrorRendererInterface>configShallow() ¶ 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
$thisdispatchEvent() ¶ public
dispatchEvent(string $name, array $data = [], TSubject|null $subject = null): Cake\Event\EventInterface<TSubject>Wrapper for creating and dispatching events.
Returns a dispatched event.
Parameters
-
string$name Name of the event.
-
array$data optional Any value you wish to be transported with this event to it can be read by listeners.
-
TSubject|null$subject optional The object that this event applies to ($this by default).
Returns
Cake\Event\EventInterface<TSubject>getConfig() ¶ 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
InvalidArgumentExceptiongetEventManager() ¶ public
getEventManager(): Cake\Event\EventManagerInterfaceReturns the Cake\Event\EventManager manager instance for this object.
You can use this instance to register any new listeners or callbacks to the object events, or create your own events and trigger them at will.
Returns
Cake\Event\EventManagerInterfacehandleError() ¶ public
handleError(int $code, string $description, string|null $file = null, int|null $line = null): boolHandle an error from PHP set_error_handler
Will use the configured renderer to generate output and output it.
This method will dispatch the Error.beforeRender event which can be listened
to on the global event manager.
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
Returns
boollogError() ¶ protected
logError(Cake\Error\PhpError $error): voidLogging helper method.
Parameters
-
Cake\Error\PhpError$error The error object to log.
Returns
voidlogger() ¶ public
logger(): Cake\Error\ErrorLoggerInterfaceGet an instance of the logger.
Returns
Cake\Error\ErrorLoggerInterfaceregister() ¶ public
register(): voidAttach this ErrorTrap to PHP's default error handler.
This will replace the existing error handler, and the previous error handler will be discarded.
This method will also set the global error level via error_reporting().
Returns
voidrenderer() ¶ public
renderer(): Cake\Error\ErrorRendererInterfaceGet an instance of the renderer.
Returns
Cake\Error\ErrorRendererInterfacesetConfig() ¶ 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.
setEventManager() ¶ public
setEventManager(Cake\Event\EventManagerInterface $eventManager): $thisReturns the Cake\Event\EventManagerInterface instance for this object.
You can use this instance to register any new listeners or callbacks to the object events, or create your own events and trigger them at will.
Parameters
-
Cake\Event\EventManagerInterface$eventManager the eventManager to set
Returns
$thisProperty Detail
$_configInitialized ¶ protected
Whether the config property has already been configured with defaults
Type
bool$_defaultConfig ¶ protected
Configuration options. Generally these are defined in config/app.php
errorLevel- int - The level of errors you are interested in capturing.errorRenderer- string - The class name of render errors with. Defaults to choosing between Html and Console based on the SAPI.log- boolean - Whether or not you want errors logged.logger- string - The class name of the error logger to use.trace- boolean - Whether or not backtraces should be included in logged errors.
Type
array<string, mixed>$_eventManager ¶ protected
Instance of the Cake\Event\EventManager this object is using to dispatch inner events.
Type
Cake\Event\EventManagerInterface|null