\Cake\Log\EngineFileLog

File Storage stream for Logging. Writes logs to different files based on the level of log it is.

It simply delegates all log-level-specific methods to the log method to reduce boilerplate code that a simple Logger that does the same thing with messages regardless of the error level has to implement.

Summary

Methods

Properties

Constants

__construct()
levels()
scopes()
setConfig()
getConfig()
config()
configShallow()
emergency()
alert()
critical()
error()
warning()
notice()
info()
debug()
log()

No public properties found

No constants found

_format()
_configRead()
_configWrite()
_configDelete()
_getFilename()
_rotateFile()

$_defaultConfig
$_config
$_configInitialized
$_path
$_file
$_size

N/A

No private methods found

No private properties found

N/A

Properties

$_defaultConfig

$_defaultConfig : array

Default config for this class

levels string or array, levels the engine is interested in
scopes string or array, scopes the engine is interested in
file Log file name
path The path to save logs on.
size Used to implement basic log file rotation. If log file size reaches specified size the existing file is renamed by appending timestamp to filename and new log file is created. Can be integer bytes value or human readable string values like '10MB', '100KB' etc.
rotate Log files are rotated specified times before being removed. If value is 0, old versions are removed rather then rotated.
mask A mask is applied when log files are created. Left empty no chmod is made.

Type

array

$_config

$_config : array

Runtime config

Type

array

$_configInitialized

$_configInitialized : boolean

Whether the config property has already been configured with defaults

Type

boolean

$_path

$_path : string|null

Path to save log files on.

Type

string|null

$_file

$_file : string|null

The name of the file to save logs into.

Type

string|null

$_size

$_size : integer|null

Max file size, used for log file rotation.

Type

integer|null

Methods

__construct()

__construct(array  $config = array())

Sets protected properties based on config provided

Parameters

array

$config

Configuration array

levels()

levels() : array

Get the levels this logger is interested in.

Returns

array

scopes()

scopes() : array

Get the scopes this logger is interested in.

Returns

array

setConfig()

setConfig(string|array  $key, mixed|null  $value = null, boolean  $merge = true) : $this

Sets 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

string\|array	$key	The key to set, or a complete array of configs.
mixed\|null	$value	The value to set.
boolean	$merge	Whether to recursively merge or overwrite existing config, defaults to true.

Throws

\Cake\Core\Exception\Exception: When trying to set a key that is invalid.

Returns

$this

getConfig()

getConfig(string|null  $key = null, mixed  $default = null) : mixed

Returns 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	The key to get or null for the whole config.
mixed	$default	The return value when the key does not exist.

Returns

mixed —

Config value being read.

config()

config(string|array|null  $key = null, mixed|null  $value = null, boolean  $merge = true) : mixed

Gets/Sets the config.

Usage

Reading the whole config:

$this->config();

Reading a specific value:

$this->config('key');

Reading a nested value:

$this->config('some.nested.key');

Setting a specific value:

$this->config('key', $value);

Setting a nested value:

$this->config('some.nested.key', $value);

Updating multiple config settings at the same time:

$this->config(['one' => 'value', 'another' => 'value']);

Parameters

string\|array\|null	$key	The key to get/set, or a complete array of configs.
mixed\|null	$value	The value to set.
boolean	$merge	Whether to recursively merge or overwrite existing config, defaults to true.

Throws

\Cake\Core\Exception\Exception: When trying to set a key that is invalid.

Returns

mixed —

Config value being read, or the object itself on write operations.

configShallow()

configShallow(string|array  $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']);

Parameters

string\|array	$key	The key to set, or a complete array of configs.
mixed\|null	$value	The value to set.

Returns

$this

emergency()

emergency(string  $message, array  $context = array()) : void

System is unusable.

Parameters

string	$message
array	$context

alert()

alert(string  $message, array  $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.

Parameters

string	$message
array	$context

critical()

critical(string  $message, array  $context = array()) : void

Critical conditions.

Example: Application component unavailable, unexpected exception.

Parameters

string	$message
array	$context

error()

error(string  $message, array  $context = array()) : void

Runtime errors that do not require immediate action but should typically be logged and monitored.

Parameters

string	$message
array	$context

warning()

warning(string  $message, array  $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.

Parameters

string	$message
array	$context

notice()

notice(string  $message, array  $context = array()) : void

Normal but significant events.

Parameters

string	$message
array	$context

info()

info(string  $message, array  $context = array()) : void

Interesting events.

Example: User logs in, SQL logs.

Parameters

string	$message
array	$context

debug()

debug(string  $message, array  $context = array()) : void

Detailed debug information.

Parameters

string	$message
array	$context

log()

log(string  $level, string  $message, array  $context = array()) : boolean

Implements writing to log files.

Parameters

string	$level	The severity level of the message being written. See Cake\Log\Log::$_levels for list of possible levels.
string	$message	The message you want to log.
array	$context	Additional information about the logged message

Returns

boolean —

success of write.

_format()

_format(mixed  $data, array  $context = array()) : string

Converts to string the provided data so it can be logged. The context can optionally be used by log engines to interpolate variables or add additional info to the logged message.

Parameters

mixed	$data	The data to be converted to string and logged.
array	$context	Additional logging information for the message.

Returns

string

_configRead()

_configRead(string|null  $key) : mixed

Reads a config key.

Parameters

string|null

$key

Key to read.

Returns

mixed

_configWrite()

_configWrite(string|array  $key, mixed  $value, boolean|string  $merge = false) : void

Writes a config key.

Parameters

string\|array	$key	Key to write to.
mixed	$value	Value to write.
boolean\|string	$merge	True to merge recursively, 'shallow' for simple merge, false to overwrite, defaults to false.

Throws

\Cake\Core\Exception\Exception: if attempting to clobber existing config

_configDelete()

_configDelete(string  $key) : void

Deletes a single config key.

Parameters

string

$key

Key to delete.

Throws

\Cake\Core\Exception\Exception: if attempting to clobber existing config

_getFilename()

_getFilename(string  $level) : string

Get filename

Parameters

string

$level

The level of log.

Returns

string —

File name

_rotateFile()

_rotateFile(string  $filename) : boolean|null

Rotate log file if size specified in config is reached.

Also if rotate count is reached oldest file is removed.

Parameters

string

$filename

Log file name

Returns

boolean|null —

True if rotated successfully or false in case of error. Null if file doesn't need to be rotated.