W3cubDocs

/CakePHP 3.8

Class ErrorHandlerMiddleware

Error handling middleware.

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

Cake\Error\Middleware\ErrorHandlerMiddleware uses Cake\Core\InstanceConfigTrait

Properties summary

Inherited Properties

Method Summary

Method Detail

__construct()source public

__construct( string|callable|null $exceptionRenderer = null , array $config = [] )

Constructor

Parameters

string|callable|null $exceptionRenderer optional null

The renderer or class name to use or a callable factory. If null, Configure::read('Error.exceptionRenderer') will be used.

array $config optional []

Configuration options to use. If empty, Configure::read('Error') will be used.

__invoke()source public

__invoke( Psr\Http\Message\ServerRequestInterface $request , Psr\Http\Message\ResponseInterface $response , callable $next )

Wrap the remaining middleware with error handling.

Parameters

Psr\Http\Message\ServerRequestInterface $request
The request.
Psr\Http\Message\ResponseInterface $response
The response.
callable $next
Callback to invoke the next middleware.

Returns

Psr\Http\Message\ResponseInterface
A response

getMessage()source protected

getMessage( Psr\Http\Message\ServerRequestInterface $request , Exception $exception )

Generate the error log message.

Parameters

Psr\Http\Message\ServerRequestInterface $request
The current request.
Exception $exception
The exception to log a message for.

Returns

string
Error message

getMessageForException()source protected

getMessageForException( Exception $exception , boolean $isPrevious = false )

Generate the message for the exception

Parameters

Exception $exception
The exception to log a message for.
boolean $isPrevious optional false
False for original exception, true for previous

Returns

string
Error message

getRenderer()source protected

getRenderer( Exception $exception , Psr\Http\Message\ServerRequestInterface $request )

Get a renderer instance

Parameters

Exception $exception
The exception being rendered.
Psr\Http\Message\ServerRequestInterface $request
The request.

Returns

Cake\Error\ExceptionRendererInterface
The exception renderer.

Throws

Exception
When the renderer class cannot be found.

handleException()source public

handleException( Exception $exception , Psr\Http\Message\ServerRequestInterface $request , Psr\Http\Message\ResponseInterface $response )

Handle an exception and generate an error response

Parameters

Exception $exception
The exception to handle.
Psr\Http\Message\ServerRequestInterface $request
The request.
Psr\Http\Message\ResponseInterface $response
The response.

Returns

Psr\Http\Message\ResponseInterface
A response

handleInternalError()source protected

handleInternalError( Psr\Http\Message\ResponseInterface $response )

Parameters

Psr\Http\Message\ResponseInterface $response
The response

Returns

Psr\Http\Message\ResponseInterface
A response

logException()source protected

logException( Psr\Http\Message\ServerRequestInterface $request , Exception $exception )

Log an error for the exception if applicable.

Parameters

Psr\Http\Message\ServerRequestInterface $request
The current request.
Exception $exception
The exception to log a message for.

Methods used from Cake\Core\InstanceConfigTrait

_configDelete()source 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()source protected

_configRead( string|null $key )

Reads a config key.

Parameters

string|null $key
Key to read.

Returns

mixed

_configWrite()source protected

_configWrite( string|array $key , mixed $value , boolean|string $merge = false )

Writes a config key.

Parameters

string|array $key
Key to write to.
mixed $value
Value to write.
boolean|string $merge optional false

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

config()source public deprecated

config( string|array|null $key = null , mixed|null $value = null , boolean $merge = true )

Gets/Sets the config.

Usage

Reading the whole config:

$this->config();

Reading a specific value:

$this->config('key');

Reading a nested value:

$this->config('some.nested.key');

Setting a specific value:

$this->config('key', $value);

Setting a nested value:

$this->config('some.nested.key', $value);

Updating multiple config settings at the same time:

$this->config(['one' => 'value', 'another' => 'value']);

Deprecated

3.4.0 use setConfig()/getConfig() instead.

Parameters

string|array|null $key optional null
The key to get/set, or a complete array of configs.
mixed|null $value optional null
The value to set.
boolean $merge optional true
Whether to recursively merge or overwrite existing config, defaults to true.

Returns

mixed
Config value being read, or the object itself on write operations.

Throws

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

configShallow()source public

configShallow( string|array $key , mixed|null $value = null )

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 null
The value to set.

Returns


$this

getConfig()source public

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

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 null
The key to get or null for the whole config.
mixed $default optional null
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.

setConfig()source public

setConfig( string|array $key , mixed|null $value = null , boolean $merge = true )

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 null
The value to set.
boolean $merge optional true
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.

Properties detail

$_defaultConfigsource

protected array

Default configuration values.

  • 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?

[
    'skipLog' => [],
    'log' => true,
    'trace' => false,
]

$exceptionRenderersource

protected Cake\Error\ExceptionRendererInterface|callable|string|null

Exception render.

© 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/3.8/class-Cake.Error.Middleware.ErrorHandlerMiddleware.html