Docs4dev
Docs
cakephp / 4.4 / class-cake.error.middleware.errorhandlermiddleware.html

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

Property Summary

  • $_config protected
    array<string, mixed>

    Runtime config

  • $_configInitialized protected
    bool

    Whether the config property has already been configured with defaults

  • $_defaultConfig protected
    array<string, mixed>

    Default configuration values.

  • $errorHandler protected
    Cake\Error\ErrorHandler|null

    Error handler instance.

  • $exceptionTrap protected
    Cake\Error\ExceptionTrap|null

    ExceptionTrap instance

Method Summary

Method Detail

__construct() public

__construct(Cake\Error\ErrorHandlerCake\Error\ExceptionTrap|array $errorHandler = [])

Constructor

Parameters

Cake\Error\ErrorHandlerCake\Error\ExceptionTrap|array $errorHandler optional

The error handler instance or config array.

Throws

InvalidArgumentException

_configDelete() protected

_configDelete(string $key): void

Deletes a single config key.

Parameters

string $key

Key to delete.

Returns

void

Throws

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

_configRead() protected

_configRead(string|null $key): mixed

Reads 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): void

Writes 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

void

Throws

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

configShallow() public

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

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

$this

getConfig() public

getConfig(string|null $key = null, mixed $default = null): mixed

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

getConfigOrFail() public

getConfigOrFail(string $key): mixed

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

Throws

InvalidArgumentException

getErrorHandler() protected

getErrorHandler(): Cake\Error\ErrorHandler

Get a error handler instance

Returns

Cake\Error\ErrorHandler

getExceptionTrap() protected

getExceptionTrap(): Cake\Error\ExceptionTrap

Get a exception trap instance

Returns

Cake\Error\ExceptionTrap

handleException() public

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

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

handleInternalError() protected

handleInternalError(): Psr\Http\Message\ResponseInterface

Handle internal errors.

Returns

Psr\Http\Message\ResponseInterface

handleRedirect() public

handleRedirect(Cake\Http\Exception\RedirectException $exception): Psr\Http\Message\ResponseInterface

Convert a redirect exception into a response.

Parameters

Cake\Http\Exception\RedirectException $exception

The exception to handle

Returns

Psr\Http\Message\ResponseInterface

process() public

process(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.

Parameters

ServerRequestInterface $request

The request.

RequestHandlerInterface $handler

The request handler.

Returns

Psr\Http\Message\ResponseInterface

setConfig() public

setConfig(array<string, mixed>|string $key, mixed|null $value = null, bool $merge = true): $this

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

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

$this

Throws

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

Property Detail

$_config protected

Runtime config

Type

array<string, mixed>

$_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 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.

Type

array<string, mixed>

$errorHandler protected

Error handler instance.

Type

Cake\Error\ErrorHandler|null

$exceptionTrap protected

ExceptionTrap instance

Type

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