$_config
$_config : array
Runtime config
Error handling middleware.
Traps exceptions and converts them into HTML or content-type appropriate error pages using the CakePHP ExceptionRenderer.
$_defaultConfig : 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?$exceptionRenderer : \Cake\Error\ExceptionRendererInterface|callable|string|null
Exception render.
setConfig(string|array $key, mixed|null $value = null, boolean $merge = true) : $this
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 | The value to set. |
| boolean | $merge | Whether to recursively merge or overwrite existing config, defaults to true. |
When trying to set a key that is invalid.
getConfig(string|null $key = null, mixed $default = null) : mixed
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 | The key to get or null for the whole config. |
| mixed | $default | The return value when the key does not exist. |
Config value being read.
config(string|array|null $key = null, mixed|null $value = null, boolean $merge = true) : mixed
Gets/Sets the config.
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']);| string|array|null | $key | The key to get/set, or a complete array of configs. |
| mixed|null | $value | The value to set. |
| boolean | $merge | Whether to recursively merge or overwrite existing config, defaults to true. |
When trying to set a key that is invalid.
Config value being read, or the object itself on write operations.
configShallow(string|array $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']);| string|array | $key | The key to set, or a complete array of configs. |
| mixed|null | $value | The value to set. |
__construct(string|callable|null $exceptionRenderer = null, array $config = array())
Constructor
| string|callable|null | $exceptionRenderer | The renderer or class name to use or a callable factory. If null, Configure::read('Error.exceptionRenderer') will be used. |
| array | $config | Configuration options to use. If empty, |
__invoke(\Psr\Http\Message\ServerRequestInterface $request, \Psr\Http\Message\ResponseInterface $response, callable $next) : \Psr\Http\Message\ResponseInterface
Wrap the remaining middleware with error handling.
| \Psr\Http\Message\ServerRequestInterface | $request | The request. |
| \Psr\Http\Message\ResponseInterface | $response | The response. |
| callable | $next | Callback to invoke the next middleware. |
A response
handleException(\Exception $exception, \Psr\Http\Message\ServerRequestInterface $request, \Psr\Http\Message\ResponseInterface $response) : \Psr\Http\Message\ResponseInterface
Handle an exception and generate an error response
| \Exception | $exception | The exception to handle. |
| \Psr\Http\Message\ServerRequestInterface | $request | The request. |
| \Psr\Http\Message\ResponseInterface | $response | The response. |
A response
_configWrite(string|array $key, mixed $value, boolean|string $merge = false) : void
Writes a config key.
| string|array | $key | Key to write to. |
| mixed | $value | Value to write. |
| boolean|string | $merge | True to merge recursively, 'shallow' for simple merge, false to overwrite, defaults to false. |
if attempting to clobber existing config
handleInternalError(\Psr\Http\Message\ResponseInterface $response) : \Psr\Http\Message\ResponseInterface
| \Psr\Http\Message\ResponseInterface | $response | The response |
A response
getRenderer(\Exception $exception, \Psr\Http\Message\ServerRequestInterface $request) : \Cake\Error\ExceptionRendererInterface
Get a renderer instance
| \Exception | $exception | The exception being rendered. |
| \Psr\Http\Message\ServerRequestInterface | $request | The request. |
When the renderer class cannot be found.
The exception renderer.
logException(\Psr\Http\Message\ServerRequestInterface $request, \Exception $exception) : void
Log an error for the exception if applicable.
| \Psr\Http\Message\ServerRequestInterface | $request | The current request. |
| \Exception | $exception | The exception to log a message for. |
getMessage(\Psr\Http\Message\ServerRequestInterface $request, \Exception $exception) : string
Generate the error log message.
| \Psr\Http\Message\ServerRequestInterface | $request | The current request. |
| \Exception | $exception | The exception to log a message for. |
Error message
getMessageForException(\Exception $exception, boolean $isPrevious = false) : string
Generate the message for the exception
| \Exception | $exception | The exception to log a message for. |
| boolean | $isPrevious | False for original exception, true for previous |
Error message