Base log engine class.
array
Runtime config
bool
Whether the config property has already been configured with defaults
array
Default config for this class
Merge provided config with existing config. Unlike config()
which does a recursive merge for nested keys, this method does a simple merge.
Runtime errors that do not require immediate action but should typically be logged and monitored.
__construct(array $config)
__construct method
array
$config optional Configuration array
_configDelete(string $key)
Deletes a single config key.
string
$key Key to delete.
Cake\Core\Exception\Exception
_configRead(?string $key)
Reads a config key.
string|null
$key Key to read.
mixed
_configWrite(mixed $key, mixed $value, mixed $merge)
Writes a config key.
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.
Cake\Core\Exception\Exception
_format(string $message, array $context)
Formats the message to be logged.
The context can optionally be used by log engines to interpolate variables or add additional info to the logged message.
string
$message The message to be formatted.
array
$context optional Additional logging information for the message.
string
_getFormattedDate()
Returns date formatted according to given dateFormat
option format.
This function affects FileLog
orConsoleLog
datetime information format.
string
alert(mixed $message, array $context)
Action must be taken immediately.
Example: Entire website down, database unavailable, etc. This should trigger the SMS alerts and wake you up.
string
$message array
$context optional configShallow(mixed $key, mixed $value)
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 optional The value to set.
$this
critical(mixed $message, array $context)
Critical conditions.
Example: Application component unavailable, unexpected exception.
string
$message array
$context optional debug(mixed $message, array $context)
Detailed debug information.
string
$message array
$context optional emergency(mixed $message, array $context)
System is unusable.
string
$message array
$context optional error(mixed $message, array $context)
Runtime errors that do not require immediate action but should typically be logged and monitored.
string
$message array
$context optional getConfig(?string $key, mixed $default)
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 optional The key to get or null for the whole config.
mixed
$default optional The return value when the key does not exist.
mixed
Configuration data at the named key or null if the key does not exist.
getConfigOrFail(string $key)
Returns the config for this specific key.
The config value for this key must exist, it can never be null.
string
$key The key to get.
mixed
Configuration data at the named key
InvalidArgumentException
info(mixed $message, array $context)
Interesting events.
Example: User logs in, SQL logs.
string
$message array
$context optional levels()
Get the levels this logger is interested in.
array
log(mixed $level, mixed $message, array $context)
Logs with an arbitrary level.
mixed
$level string
$message array
$context optional Psr\Log\InvalidArgumentException
notice(mixed $message, array $context)
Normal but significant events.
string
$message array
$context optional scopes()
Get the scopes this logger is interested in.
array|false
setConfig(mixed $key, mixed $value, mixed $merge)
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 optional The value to set.
bool
$merge optional Whether to recursively merge or overwrite existing config, defaults to true.
$this
Cake\Core\Exception\Exception
warning(mixed $message, array $context)
Exceptional occurrences that are not errors.
Example: Use of deprecated APIs, poor use of an API, undesirable things that are not necessarily wrong.
string
$message array
$context optional Runtime config
array
Whether the config property has already been configured with defaults
bool
Default config for this class
array
© 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.1/class-Cake.Log.Engine.BaseLog.html