Class BaseLog
Base log engine class.
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 config for this class
-
$formatter protected
Cake\Log\Formatter\AbstractFormatter
Method Summary
-
__construct() public
__construct method
-
_configDelete() protected
Deletes a single config key.
-
_configRead() protected
Reads a config key.
-
_configWrite() protected
Writes a config key.
-
_format() protected deprecated
Formats the message to be logged.
-
alert() public
Action must be taken immediately.
-
configShallow() public
Merge provided config with existing config. Unlike
config()which does a recursive merge for nested keys, this method does a simple merge. -
critical() public
Critical conditions.
-
debug() public
Detailed debug information.
-
emergency() public
System is unusable.
-
error() public
Runtime errors that do not require immediate action but should typically be logged and monitored.
-
getConfig() public
Returns the config.
-
getConfigOrFail() public
Returns the config for this specific key.
-
info() public
Interesting events.
-
interpolate() protected
Replaces placeholders in message string with context values.
-
levels() public
Get the levels this logger is interested in.
-
log() abstract public
Logs with an arbitrary level.
-
notice() public
Normal but significant events.
-
scopes() public
Get the scopes this logger is interested in.
-
setConfig() public
Sets the config.
-
warning() public
Exceptional occurrences that are not errors.
Method Detail
__construct() ¶ public
__construct(array<string, mixed> $config = [])__construct method
Parameters
-
array<string, mixed>$config optional Configuration 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
_format() ¶ protected
_format(string $message, array $context = []): stringFormats 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.
Parameters
-
string$message The message to be formatted.
-
array$context optional Additional logging information for the message.
Returns
stringalert() ¶ public
alert(string|Stringable $message, mixed[] $context = []): voidAction must be taken immediately.
Example: Entire website down, database unavailable, etc. This should trigger the SMS alerts and wake you up.
Parameters
-
string|Stringable$message -
mixed[]$context optional
Returns
voidconfigShallow() ¶ 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
$thiscritical() ¶ public
critical(string|Stringable $message, mixed[] $context = []): voidCritical conditions.
Example: Application component unavailable, unexpected exception.
Parameters
-
string|Stringable$message -
mixed[]$context optional
Returns
voiddebug() ¶ public
debug(string|Stringable $message, mixed[] $context = []): voidDetailed debug information.
Parameters
-
string|Stringable$message -
mixed[]$context optional
Returns
voidemergency() ¶ public
emergency(string|Stringable $message, mixed[] $context = []): voidSystem is unusable.
Parameters
-
string|Stringable$message -
mixed[]$context optional
Returns
voiderror() ¶ public
error(string|Stringable $message, mixed[] $context = []): voidRuntime errors that do not require immediate action but should typically be logged and monitored.
Parameters
-
string|Stringable$message -
mixed[]$context optional
Returns
voidgetConfig() ¶ 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
mixedConfiguration data at the named key or null if the key does not exist.
getConfigOrFail() ¶ 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
mixedConfiguration data at the named key
Throws
InvalidArgumentExceptioninfo() ¶ public
info(string|Stringable $message, mixed[] $context = []): voidInteresting events.
Example: User logs in, SQL logs.
Parameters
-
string|Stringable$message -
mixed[]$context optional
Returns
voidinterpolate() ¶ protected
interpolate(string $message, array $context = []): stringReplaces placeholders in message string with context values.
Parameters
-
string$message Formatted string
-
array$context optional Context for placeholder values.
Returns
stringlevels() ¶ public
levels(): array<string>Get the levels this logger is interested in.
Returns
array<string>log() ¶ abstract public
log(mixed $level, string|Stringable $message, mixed[] $context = []): voidLogs with an arbitrary level.
Parameters
-
mixed$level -
string|Stringable$message -
mixed[]$context optional
Returns
voidThrows
Psr\Log\InvalidArgumentExceptionnotice() ¶ public
notice(string|Stringable $message, mixed[] $context = []): voidNormal but significant events.
Parameters
-
string|Stringable$message -
mixed[]$context optional
Returns
voidscopes() ¶ public
scopes(): array<string>|falseGet the scopes this logger is interested in.
Returns
array<string>|falsesetConfig() ¶ 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.
warning() ¶ public
warning(string|Stringable $message, mixed[] $context = []): voidExceptional occurrences that are not errors.
Example: Use of deprecated APIs, poor use of an API, undesirable things that are not necessarily wrong.
Parameters
-
string|Stringable$message -
mixed[]$context optional
Returns
voidProperty Detail
$_configInitialized ¶ protected
Whether the config property has already been configured with defaults
Type
bool