Class ErrorHandlerMiddleware
Error handling middleware.
Traps exceptions and converts them into HTML or content-type appropriate error pages using the CakePHP ExceptionRenderer.
Property Summary
-
$_config protected
arrayRuntime config
-
$_configInitialized protected
boolWhether the config property has already been configured with defaults
-
$_defaultConfig protected
arrayDefault configuration values.
-
$exceptionRenderer protected
Cake\Error\ExceptionRendererInterface|callable|string|nullException render.
Method Summary
-
__construct() public
Constructor
-
__invoke() public
Wrap the remaining middleware with error handling.
-
_configDelete() protected
Deletes a single config key.
-
_configRead() protected
Reads a config key.
-
_configWrite() protected
Writes a config key.
-
config() public deprecated
Gets/Sets the config.
-
configShallow() public
Merge provided config with existing config. Unlike
config()which does a recursive merge for nested keys, this method does a simple merge. -
getConfig() public
Returns the config.
-
getMessage() protected
Generate the error log message.
-
getRenderer() protected
Get a renderer instance
-
handleException() public
Handle an exception and generate an error response
-
handleInternalError() protected
-
logException() protected
Log an error for the exception if applicable.
-
setConfig() public
Sets the config.
Method Detail
__construct() ¶ public
__construct(string|callable|null $exceptionRenderer = null, array $config = [])Constructor
Parameters
-
string|callable|null$exceptionRenderer optional 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() ¶ public
__invoke(Psr\Http\Message\ServerRequestInterface $request, Psr\Http\Message\ResponseInterface $response, callable $next): Psr\Http\Message\ResponseInterfaceWrap 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_configDelete() ¶ protected
_configDelete(string $key): voidDeletes a single config key.
Parameters
-
string$key Key to delete.
Returns
voidThrows
Cake\Core\Exception\Exceptionif attempting to clobber existing config
_configRead() ¶ protected
_configRead(string|null $key): mixedReads a config key.
Parameters
-
string|null$key Key to read.
Returns
mixed_configWrite() ¶ protected
_configWrite(string|array $key, mixed $value, bool|string $merge = false): voidWrites 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.
Returns
voidThrows
Cake\Core\Exception\Exceptionif attempting to clobber existing config
config() ¶ public
config(string|array|null $key = null, mixed|null $value = null, bool $merge = true): mixedGets/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']);Parameters
-
string|array|null$key optional The key to get/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
mixedThrows
Cake\Core\Exception\ExceptionWhen trying to set a key that is invalid.
configShallow() ¶ public
configShallow(string|array $key, mixed|null $value = null): $thisMerge 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
$thisgetConfig() ¶ public
getConfig(string|null $key = null, mixed $default = null): mixedReturns 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
mixedgetMessage() ¶ protected
getMessage(Psr\Http\Message\ServerRequestInterface $request, Exception $exception): stringGenerate the error log message.
Parameters
-
Psr\Http\Message\ServerRequestInterface$request The current request.
-
Exception$exception The exception to log a message for.
Returns
stringgetRenderer() ¶ protected
getRenderer(Exception $exception): Cake\Error\ExceptionRendererInterfaceGet a renderer instance
Parameters
-
Exception$exception The exception being rendered.
Returns
Cake\Error\ExceptionRendererInterfaceThrows
ExceptionWhen the renderer class cannot be found.
handleException() ¶ public
handleException(Exception $exception, Psr\Http\Message\ServerRequestInterface $request, Psr\Http\Message\ResponseInterface $response): Psr\Http\Message\ResponseInterfaceHandle 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\ResponseInterfacehandleInternalError() ¶ protected
handleInternalError(Psr\Http\Message\ResponseInterface $response): Psr\Http\Message\ResponseInterfaceParameters
-
Psr\Http\Message\ResponseInterface$response The response
Returns
Psr\Http\Message\ResponseInterfacelogException() ¶ protected
logException(Psr\Http\Message\ServerRequestInterface $request, Exception $exception): voidLog 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.
Returns
voidsetConfig() ¶ public
setConfig(string|array $key, mixed|null $value = null, bool $merge = true): $thisSets 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
$thisThrows
Cake\Core\Exception\ExceptionWhen trying to set a key that is invalid.
Property Detail
$_configInitialized ¶ protected
Whether the config property has already been configured with defaults
Type
bool$_defaultConfig ¶ protected
Default configuration values.
logEnable logging of exceptions.skipLogList 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']traceShould error logs include stack traces?
Type
array$exceptionRenderer ¶ protected
Exception render.
Type
Cake\Error\ExceptionRendererInterface|callable|string|null