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.
array<string, mixed>Runtime config
boolWhether the config property has already been configured with defaults
array<string, mixed>Configuration options. Generally these are defined in config/app.php
stringDefault class name for new event objects.
Cake\Event\EventManagerInterface|nullInstance of the Cake\Event\EventManager this object is using to dispatch inner events.
Constructor
Deletes a single config key.
Reads a config key.
Writes a config key.
Choose an error renderer based on config or the SAPI
Merge provided config with existing config. Unlike config() which does a recursive merge for nested keys, this method does a simple merge.
Wrapper for creating and dispatching events.
Returns the config.
Returns the config for this specific key.
Returns the Cake\Event\EventManager manager instance for this object.
Handle an error from PHP set_error_handler
Logging helper method.
Get an instance of the logger.
Attach this ErrorTrap to PHP's default error handler.
Get an instance of the renderer.
Sets the config.
Returns the Cake\Event\EventManagerInterface instance for this object.
__construct(array<string, mixed> $options = [])
Constructor
array<string, mixed> $options optional An options array. See $_defaultConfig.
_configDelete(string $key): void
Deletes a single config key.
string $key Key to delete.
voidCake\Core\Exception\CakeException_configRead(string|null $key): mixed
Reads a config key.
string|null $key Key to read.
mixed_configWrite(array<string, mixed>|string $key, mixed $value, string|bool $merge = false): void
Writes a config key.
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.
voidCake\Core\Exception\CakeExceptionchooseErrorRenderer(): class-stringCake\Error\ErrorRendererInterface>
Choose an error renderer based on config or the SAPI
class-stringCake\Error\ErrorRendererInterface>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']);
array<string, mixed>|string $key The key to set, or a complete array of configs.
mixed|null $value optional The value to set.
$thisdispatchEvent(string $name, array|null $data = null, object|null $subject = null): Cake\Event\EventInterface
Wrapper for creating and dispatching events.
Returns a dispatched event.
string $name Name of the event.
array|null $data optional Any value you wish to be transported with this event to it can be read by listeners.
object|null $subject optional The object that this event applies to ($this by default).
Cake\Event\EventInterfacegetConfig(string|null $key = null, mixed $default = null): mixed
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.
mixedgetConfigOrFail(string $key): mixed
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.
mixedInvalidArgumentExceptiongetEventManager(): Cake\Event\EventManagerInterface
Returns 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.
Cake\Event\EventManagerInterfacehandleError(int $code, string $description, string|null $file = null, int|null $line = null): bool
Handle 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.
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
boollogError(Cake\Error\PhpError $error): void
Logging helper method.
Cake\Error\PhpError $error The error object to log.
voidlogger(): Cake\Error\ErrorLoggerInterface
Get an instance of the logger.
Cake\Error\ErrorLoggerInterfaceregister(): void
Attach 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().
voidrenderer(): Cake\Error\ErrorRendererInterface
Get an instance of the renderer.
Cake\Error\ErrorRendererInterfacesetConfig(array<string, mixed>|string $key, mixed|null $value = null, bool $merge = true): $this
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']);
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.
$thisCake\Core\Exception\CakeExceptionsetEventManager(Cake\Event\EventManagerInterface $eventManager): $this
Returns 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.
Cake\Event\EventManagerInterface $eventManager the eventManager to set
$thisRuntime config
array<string, mixed>Whether the config property has already been configured with defaults
boolConfiguration 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.array<string, mixed>Default class name for new event objects.
stringInstance of the Cake\Event\EventManager this object is using to dispatch inner events.
Cake\Event\EventManagerInterface|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.ErrorTrap.html