Class ErrorLogger
Log errors and unhandled exceptions to Cake\Log\Log
Property Summary
-
$_config protected
array<string, mixed>Runtime config
-
$_configInitialized protected
boolWhether the config property has already been configured with defaults
-
$_defaultConfig protected
array<string, mixed>Default configuration values.
Method Summary
-
__construct() public
Constructor
-
_configDelete() protected
Deletes a single config key.
-
_configRead() protected
Reads a config key.
-
_configWrite() protected
Writes a config key.
-
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.
-
getConfigOrFail() public
Returns the config for this specific key.
-
getMessage() protected
Generate the message for the exception
-
getRequestContext() public
Get the request context for an error/exception trace.
-
log() public deprecated
Log an error for an exception with optional request context.
-
logError() public
Log an error to Cake's Log subsystem
-
logException() public
Log an exception to Cake's Log subsystem
-
logMessage() public deprecated
Log a an error message to the error logger.
-
setConfig() public
Sets the config.
Method Detail
__construct() ¶ public
__construct(array<string, mixed> $config = [])Constructor
Parameters
-
array<string, mixed>$config optional Config array.
_configDelete() ¶ protected
_configDelete(string $key): voidDeletes a single config key.
Parameters
-
string$key Key to delete.
Returns
voidThrows
Cake\Core\Exception\CakeExceptionif 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(array<string, mixed>|string $key, mixed $value, string|bool $merge = false): voidWrites 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
voidThrows
Cake\Core\Exception\CakeExceptionif attempting to clobber existing config
configShallow() ¶ public
configShallow(array<string, mixed>|string $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
-
array<string, mixed>|string$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
mixedgetConfigOrFail() ¶ public
getConfigOrFail(string $key): mixedReturns 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
mixedThrows
InvalidArgumentExceptiongetMessage() ¶ protected
getMessage(Throwable $exception, bool $isPrevious = false, bool $includeTrace = false): stringGenerate the message for the exception
Parameters
-
Throwable$exception The exception to log a message for.
-
bool$isPrevious optional False for original exception, true for previous
-
bool$includeTrace optional Whether or not to include a stack trace.
Returns
stringgetRequestContext() ¶ public
getRequestContext(Psr\Http\Message\ServerRequestInterface $request): stringGet the request context for an error/exception trace.
Parameters
-
Psr\Http\Message\ServerRequestInterface$request The request to read from.
Returns
stringlog() ¶ public
log(Throwable $exception, Psr\Http\Message\ServerRequestInterface|null $request = null): boolLog an error for an exception with optional request context.
Parameters
-
Throwable$exception The exception to log a message for.
-
Psr\Http\Message\ServerRequestInterface|null$request optional The current request if available.
Returns
boollogError() ¶ public
logError(Cake\Error\PhpError $error, Psr\Http\Message\ServerRequestInterface $request = null, bool $includeTrace = false): voidLog an error to Cake's Log subsystem
Parameters
-
Cake\Error\PhpError$error The error to log
-
Psr\Http\Message\ServerRequestInterface$request optional The request if in an HTTP context.
-
bool$includeTrace optional Should the log message include a stacktrace
Returns
voidlogException() ¶ public
logException(Throwable $exception, Psr\Http\Message\ServerRequestInterface|null $request = null, bool $includeTrace = false): voidLog an exception to Cake's Log subsystem
Parameters
-
Throwable$exception The exception to log a message for.
-
Psr\Http\Message\ServerRequestInterface|null$request optional The current request if available.
-
bool$includeTrace optional Whether or not a stack trace should be logged.
Returns
voidlogMessage() ¶ public
logMessage(string|int $level, string $message, array $context = []): boolLog a an error message to the error logger.
Parameters
-
string|int$level The logging level
-
string$message The message to be logged.
-
array$context optional Context.
Returns
boolsetConfig() ¶ public
setConfig(array<string, mixed>|string $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
-
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
$thisThrows
Cake\Core\Exception\CakeExceptionWhen trying to set a key that is invalid.