This class is a bridge used to write LoggedQuery objects into a real log. by default this class use the built-in CakePHP Log class to accomplish this
array<string, mixed>Runtime config
boolWhether the config property has already been configured with defaults
array<string, mixed>Default config for this class
Cake\Log\Formatter\AbstractFormatterConstructor.
Deletes a single config key.
Reads a config key.
Writes a config key.
Formats the message to be logged.
Action must be taken immediately.
Merge provided config with existing config. Unlike config() which does a recursive merge for nested keys, this method does a simple merge.
Critical conditions.
Detailed debug information.
System is unusable.
Runtime errors that do not require immediate action but should typically be logged and monitored.
Returns the config.
Returns the config for this specific key.
Interesting events.
Replaces placeholders in message string with context values.
Get the levels this logger is interested in.
Logs with an arbitrary level.
Normal but significant events.
Get the scopes this logger is interested in.
Sets the config.
Exceptional occurrences that are not errors.
__construct(array<string, mixed> $config = [])
Constructor.
array<string, mixed> $config optional Configuration array
_configDelete(string $key): void
Deletes a single config key.
string $key Key to delete.
voidCake\Core\Exception\CakeException_configRead(string|null $key): mixed
Reads a config key.
string|null $key Key to read.
mixed_configWrite(array<string, mixed>|string $key, mixed $value, string|bool $merge = false): void
Writes a config key.
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.
voidCake\Core\Exception\CakeException_format(string $message, array $context = []): string
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.
stringalert(string $message, mixed[] $context = array()): void
Action must be taken immediately.
Example: Entire website down, database unavailable, etc. This should trigger the SMS alerts and wake you up.
string $message mixed[] $context optional voidconfigShallow(array<string, mixed>|string $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']);
array<string, mixed>|string $key The key to set, or a complete array of configs.
mixed|null $value optional The value to set.
$thiscritical(string $message, mixed[] $context = array()): void
Critical conditions.
Example: Application component unavailable, unexpected exception.
string $message mixed[] $context optional voiddebug(string $message, mixed[] $context = array()): void
Detailed debug information.
string $message mixed[] $context optional voidemergency(string $message, mixed[] $context = array()): void
System is unusable.
string $message mixed[] $context optional voiderror(string $message, mixed[] $context = array()): void
Runtime errors that do not require immediate action but should typically be logged and monitored.
string $message mixed[] $context optional voidgetConfig(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 optional The key to get or null for the whole config.
mixed $default optional The return value when the key does not exist.
mixedgetConfigOrFail(string $key): mixed
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.
mixedInvalidArgumentExceptioninfo(string $message, mixed[] $context = array()): void
Interesting events.
Example: User logs in, SQL logs.
string $message mixed[] $context optional voidinterpolate(string $message, array $context = []): string
Replaces placeholders in message string with context values.
string $message Formatted string
array $context optional Context for placeholder values.
stringlevels(): array<string>
Get the levels this logger is interested in.
array<string>log(mixed $level, string $message, mixed[] $context = []): void
Logs with an arbitrary level.
mixed $level string $message mixed[] $context optional voidnotice(string $message, mixed[] $context = array()): void
Normal but significant events.
string $message mixed[] $context optional voidscopes(): array<string>|false
Get the scopes this logger is interested in.
array<string>|falsesetConfig(array<string, mixed>|string $key, mixed|null $value = null, bool $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']);
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.
$thisCake\Core\Exception\CakeExceptionwarning(string $message, mixed[] $context = array()): void
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 mixed[] $context optional voidRuntime config
array<string, mixed>Whether the config property has already been configured with defaults
boolDefault config for this class
array<string, mixed>Cake\Log\Formatter\AbstractFormatter
© 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.4/class-Cake.Database.Log.QueryLogger.html