Class Log

_init(): void

Initializes registry and configurations

Returns

_loadConfig(): void

Load the defined configuration and create all the defined logging adapters.

Returns

alert(string $message, string|array $context = []): bool

Convenience method to log alert messages

Parameters

Returns

configured(): string[]

Returns an array containing the named configurations

Returns

critical(string $message, string|array $context = []): bool

Convenience method to log critical messages

Parameters

Returns

debug(string $message, string|array $context = []): bool

Convenience method to log debug messages

Parameters

Returns

drop(string $config): bool

Drops a constructed adapter.

If you wish to modify an existing configuration, you should drop it, change configuration and then re-add it.

If the implementing objects supports a $_registry object the named configuration will also be unloaded from the registry.

Parameters

Returns

emergency(string $message, string|array $context = []): bool

Convenience method to log emergency messages

Parameters

Returns

engine(string $name): Psr\Log\LoggerInterface|null

Get a logging engine.

Parameters

Returns

error(string $message, string|array $context = []): bool

Convenience method to log error messages

Parameters

Returns

getConfig(string $key): mixed|null

Reads existing configuration.

Parameters

Returns

getConfigOrFail(string $key): mixed

Reads existing configuration for a specific key.

The config value for this key must exist, it can never be null.

Parameters

Returns

Throws

getDsnClassMap(): string[]

Returns the DSN class map for this class.

Returns

info(string $message, string|array $context = []): bool

Convenience method to log info messages

Parameters

Returns

levels(): string[]

Gets log levels

Call this method to obtain current level configuration.

Returns

notice(string $message, string|array $context = []): bool

Convenience method to log notice messages

Parameters

Returns

parseDsn(string $dsn): array

Parses a DSN into a valid connection configuration

This method allows setting a DSN using formatting similar to that used by PEAR::DB. The following is an example of its usage:

$dsn = 'mysql://user:pass@localhost/database?';
$config = ConnectionManager::parseDsn($dsn);

$dsn = 'Cake\Log\Engine\FileLog://?types=notice,info,debug&file=debug&path=LOGS';
$config = Log::parseDsn($dsn);

$dsn = 'smtp://user:secret@localhost:25?timeout=30&client=null&tls=null';
$config = Email::parseDsn($dsn);

$dsn = 'file:///?className=\My\Cache\Engine\FileEngine';
$config = Cache::parseDsn($dsn);

$dsn = 'File://?prefix=myapp_cake_core_&serialize=true&duration=+2 minutes&path=/tmp/persistent/';
$config = Cache::parseDsn($dsn);

For all classes, the value of scheme is set as the value of both the className unless they have been otherwise specified.

Note that querystring arguments are also parsed and set as values in the returned configuration.

Parameters

Returns

Throws

reset(): void

Reset all the connected loggers. This is useful to do when changing the logging configuration or during testing when you want to reset the internal state of the Log class.

Resets the configured logging adapters, as well as any custom logging levels. This will also clear the configuration data.

Returns

setConfig(string|array $key, array|object|null $config = null): void

This method can be used to define logging adapters for an application or read existing configuration.

To change an adapter's configuration at runtime, first drop the adapter and then reconfigure it.

Loggers will not be constructed until the first log message is written.

Usage

Setting a cache engine up.

Log::setConfig('default', $settings);

Injecting a constructed adapter in:

Log::setConfig('default', $instance);

Using a factory function to get an adapter:

Log::setConfig('default', function () { return new FileLog(); });

Configure multiple adapters at once:

Log::setConfig($arrayOfConfig);

Parameters

Returns

Throws

setDsnClassMap(string[] $map): void

Updates the DSN class map for this class.

Parameters

Returns

warning(string $message, string|array $context = []): bool

Convenience method to log warning messages

Parameters

Returns

write(int|string $level, string $message, string|array $context = []): bool

Writes the given message and type to all of the configured log adapters. Configured adapters are passed both the $level and $message variables. $level is one of the following strings/values.

Levels:

• LOG_EMERG => 'emergency',
• LOG_ALERT => 'alert',
• LOG_CRIT => 'critical',
• LOG_ERR => 'error',
• LOG_WARNING => 'warning',
• LOG_NOTICE => 'notice',
• LOG_INFO => 'info',
• LOG_DEBUG => 'debug',

Basic usage

Write a 'warning' message to the logs:

Log::write('warning', 'Stuff is broken here');

Using scopes

When writing a log message you can define one or many scopes for the message. This allows you to handle messages differently based on application section/feature.

Log::write('warning', 'Payment failed', ['scope' => 'payment']);

When configuring loggers you can configure the scopes a particular logger will handle. When using scopes, you must ensure that the level of the message, and the scope of the message intersect with the defined levels & scopes for a logger.

Unhandled log messages

If no configured logger can handle a log message (because of level or scope restrictions) then the logged message will be ignored and silently dropped. You can check if this has happened by inspecting the return of write(). If false the message was not handled.

Parameters

Returns

Throws