Class ErrorHandlerMiddleware

Error handling middleware.

Traps exceptions and converts them into HTML or content-type appropriate error pages using the CakePHP ExceptionRenderer.

Namespace: Cake\Error\Middleware

Properties summary

  • $_config protected
    array

    Runtime config

  • $_configInitialized protected
    bool

    Whether the config property has already been configured with defaults

  • $_defaultConfig protected
    array

    Default configuration values.

  • $errorHandler protected
    \Cake\Error\ErrorHandler|null

    Error handler instance.

Method Summary

Method Detail

__construct() public 

__construct(mixed $errorHandler)

Constructor

Parameters

\Cake\Error\ErrorHandler|array $errorHandler optional

The error handler instance or config array.

Throws

InvalidArgumentException

_configDelete() protected 

_configDelete(string $key)

Deletes a single config key.

Parameters

string $key

Key to delete.

Throws

Cake\Core\Exception\Exception
if attempting to clobber existing config

_configRead() protected 

_configRead(?string $key)

Reads a config key.

Parameters

string|null $key

Key to read.

Returns

mixed

_configWrite() protected 

_configWrite(mixed $key, mixed $value, mixed $merge)

Writes a config key.

Parameters

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.

Throws

Cake\Core\Exception\Exception
if attempting to clobber existing config

configShallow() public 

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']);

Parameters

string|array $key

The key to set, or a complete array of configs.

mixed|null $value optional

The value to set.

Returns

$this

getConfig() public 

getConfig(?string $key, mixed $default)

Returns 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

mixed

Configuration data at the named key or null if the key does not exist.

getConfigOrFail() public 

getConfigOrFail(string $key)

Returns 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

mixed

Configuration data at the named key

Throws

InvalidArgumentException

getErrorHandler() protected 

getErrorHandler()

Get a error handler instance

Returns

\Cake\Error\ErrorHandler

The error handler.

handleException() public 

handleException(\Throwable $exception, \Psr\Http\Message\ServerRequestInterface $request)

Handle an exception and generate an error response

Parameters

\Throwable $exception

The exception to handle.

\Psr\Http\Message\ServerRequestInterface $request

The request.

Returns

\Psr\Http\Message\ResponseInterface

A response

handleInternalError() protected 

handleInternalError()

Handle internal errors.

Returns

\Psr\Http\Message\ResponseInterface

A response

handleRedirect() public 

handleRedirect(\Cake\Http\Exception\RedirectException $exception)

Convert a redirect exception into a response.

Parameters

\Cake\Http\Exception\RedirectException $exception

The exception to handle

Returns

\Psr\Http\Message\ResponseInterface

Response created from the redirect.

process() public 

process(\Psr\Http\Message\ServerRequestInterface $request, \Psr\Http\Server\RequestHandlerInterface $handler)

Wrap the remaining middleware with error handling.

Parameters

\Psr\Http\Message\ServerRequestInterface $request

The request.

\Psr\Http\Server\RequestHandlerInterface $handler

The request handler.

Returns

\Psr\Http\Message\ResponseInterface

A response.

setConfig() public 

setConfig(mixed $key, mixed $value, mixed $merge)

Sets 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

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.

Returns

$this

Throws

Cake\Core\Exception\Exception
When trying to set a key that is invalid.

Property Detail

$_config protected

Runtime config

Type

array

$_configInitialized protected

Whether the config property has already been configured with defaults

Type

bool

$_defaultConfig protected

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

Type

array

$errorHandler protected

Error handler instance.

Type

\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