Error handling middleware.
Traps exceptions and converts them into HTML or content-type appropriate error pages using the CakePHP ExceptionRenderer.
array
Runtime config
bool
Whether the config property has already been configured with defaults
array
Default configuration values.
\Cake\Error\ErrorHandler|null
Error handler instance.
Merge provided config with existing config. Unlike config()
which does a recursive merge for nested keys, this method does a simple merge.
__construct(mixed $errorHandler)
Constructor
\Cake\Error\ErrorHandler|array
$errorHandler optional The error handler instance or config array.
InvalidArgumentException
_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
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.
$this
getConfig(?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.
mixed
Configuration 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.
mixed
Configuration data at the named key
InvalidArgumentException
getErrorHandler()
Get a error handler instance
\Cake\Error\ErrorHandler
The error handler.
handleException(\Throwable $exception, \Psr\Http\Message\ServerRequestInterface $request)
Handle an exception and generate an error response
\Throwable
$exception The exception to handle.
\Psr\Http\Message\ServerRequestInterface
$request The request.
\Psr\Http\Message\ResponseInterface
A response
handleInternalError()
Handle internal errors.
\Psr\Http\Message\ResponseInterface
A response
handleRedirect(\Cake\Http\Exception\RedirectException $exception)
Convert a redirect exception into a response.
\Cake\Http\Exception\RedirectException
$exception The exception to handle
\Psr\Http\Message\ResponseInterface
Response created from the redirect.
process(\Psr\Http\Message\ServerRequestInterface $request, \Psr\Http\Server\RequestHandlerInterface $handler)
Wrap the remaining middleware with error handling.
\Psr\Http\Message\ServerRequestInterface
$request The request.
\Psr\Http\Server\RequestHandlerInterface
$handler The request handler.
\Psr\Http\Message\ResponseInterface
A response.
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.
$this
Cake\Core\Exception\Exception
Runtime config
array
Whether the config property has already been configured with defaults
bool
Default configuration values.
Ignored if contructor is passed an ErrorHandler instance.
log
Enable logging of exceptions.
skipLog
List of exceptions to skip logging. Exceptions that extend one of the listed exceptions will also not be logged. Example:
'skipLog' => ['Cake\Error\NotFoundException', 'Cake\Error\UnauthorizedException']
trace
Should error logs include stack traces?
exceptionRenderer
The renderer instance or class name to use or a callable factory which returns a \Cake\Error\ExceptionRendererInterface instance. Defaults to \Cake\Error\ExceptionRenderer
array
Error handler instance.
\Cake\Error\ErrorHandler|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.Middleware.ErrorHandlerMiddleware.html