Error handling middleware.
Traps exceptions and converts them into HTML or content-type appropriate error pages using the CakePHP ExceptionRenderer.
array<string, mixed>Runtime config
boolWhether the config property has already been configured with defaults
array<string, mixed>Default configuration values.
Cake\Error\ErrorHandler|nullError handler instance.
Cake\Error\ExceptionTrap|nullExceptionTrap instance
Constructor
Deletes a single config key.
Reads a config key.
Writes a config key.
Merge provided config with existing config. Unlike config() which does a recursive merge for nested keys, this method does a simple merge.
Returns the config.
Returns the config for this specific key.
Get a error handler instance
Get a exception trap instance
Handle an exception and generate an error response
Handle internal errors.
Convert a redirect exception into a response.
Wrap the remaining middleware with error handling.
Sets the config.
__construct(Cake\Error\ErrorHandlerCake\Error\ExceptionTrap|array $errorHandler = [])
Constructor
Cake\Error\ErrorHandlerCake\Error\ExceptionTrap|array $errorHandler optional The error handler instance or config array.
InvalidArgumentException_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\CakeExceptionconfigShallow(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.
$thisgetConfig(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.
mixedInvalidArgumentExceptiongetErrorHandler(): Cake\Error\ErrorHandler
Get a error handler instance
Cake\Error\ErrorHandlergetExceptionTrap(): Cake\Error\ExceptionTrap
Get a exception trap instance
Cake\Error\ExceptionTraphandleException(Throwable $exception, Psr\Http\Message\ServerRequestInterface $request): Psr\Http\Message\ResponseInterface
Handle an exception and generate an error response
Throwable $exception The exception to handle.
Psr\Http\Message\ServerRequestInterface $request The request.
Psr\Http\Message\ResponseInterfacehandleInternalError(): Psr\Http\Message\ResponseInterface
Handle internal errors.
Psr\Http\Message\ResponseInterfacehandleRedirect(Cake\Http\Exception\RedirectException $exception): Psr\Http\Message\ResponseInterface
Convert a redirect exception into a response.
Cake\Http\Exception\RedirectException $exception The exception to handle
Psr\Http\Message\ResponseInterfaceprocess(ServerRequestInterface $request, RequestHandlerInterface $handler): Psr\Http\Message\ResponseInterface
Wrap the remaining middleware with error handling.
Processes an incoming server request in order to produce a response. If unable to produce the response itself, it may delegate to the provided request handler to do so.
ServerRequestInterface $request The request.
RequestHandlerInterface $handler The request handler.
Psr\Http\Message\ResponseInterfacesetConfig(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\CakeExceptionRuntime config
array<string, mixed>Whether the config property has already been configured with defaults
boolDefault configuration values.
Ignored if contructor is passed an ExceptionTrap instance.
Configuration keys and values are shared with ExceptionTrap. This class will pass its configuration onto the ExceptionTrap class if you are using the array style constructor.
array<string, mixed>Error handler instance.
Cake\Error\ErrorHandler|nullExceptionTrap instance
Cake\Error\ExceptionTrap|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.Middleware.ErrorHandlerMiddleware.html