Class FileLog

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

Namespace: Cake\Log\Engine

Properties summary

  • $_config protected
    array

    Runtime config

  • $_configInitialized protected
    bool

    Whether the config property has already been configured with defaults

  • $_defaultConfig protected
    array

    Default config for this class

  • $_file protected
    string|null

    The name of the file to save logs into.

  • $_path protected
    string

    Path to save log files on.

  • $_size protected
    int|null

    Max file size, used for log file rotation.

Method Summary

  • __construct() public

    Sets protected properties based on config provided

  • _configDelete() protected

    Deletes a single config key.

  • _configRead() protected

    Reads a config key.

  • _configWrite() protected

    Writes a config key.

  • _format() protected

    Formats the message to be logged.

  • _getFilename() protected

    Get filename

  • _rotateFile() protected

    Rotate log file if size specified in config is reached.

  • 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.

  • levels() public

    Get the levels this logger is interested in.

  • log() public

    Implements writing to log files.

  • 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 $config)

Sets protected properties based on config provided

Parameters

array $config optional

Configuration array

_configDelete() protected 

_configDelete(string $key)

Deletes a single config key.

Parameters

string $key

Key to delete.

Throws

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

_configRead() protected 

_configRead(?string $key)

Reads a config key.

Parameters

string|null $key

Key to read.

Returns

mixed

_configWrite() protected 

_configWrite(mixed $key, mixed $value, mixed $merge)

Writes a config key.

Parameters

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.

Throws

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

_format() protected 

_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.

Parameters

string $message

The message to be formatted.

array $context optional

Additional logging information for the message.

Returns

string

_getFilename() protected 

_getFilename(string $level)

Get filename

Parameters

string $level

The level of log.

Returns

string

File name

_rotateFile() protected 

_rotateFile(string $filename)

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

bool|null

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

alert() public 

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.

Parameters

string $message
array $context optional

configShallow() public 

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']);

Parameters

string|array $key

The key to set, or a complete array of configs.

mixed|null $value optional

The value to set.

Returns

$this

critical() public 

critical(mixed $message, array $context)

Critical conditions.

Example: Application component unavailable, unexpected exception.

Parameters

string $message
array $context optional

debug() public 

debug(mixed $message, array $context)

Detailed debug information.

Parameters

string $message
array $context optional

emergency() public 

emergency(mixed $message, array $context)

System is unusable.

Parameters

string $message
array $context optional

error() public 

error(mixed $message, array $context)

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

Parameters

string $message
array $context optional

getConfig() public 

getConfig(?string $key, mixed $default)

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 optional

The key to get or null for the whole config.

mixed $default optional

The return value when the key does not exist.

Returns

mixed

Configuration data at the named key or null if the key does not exist.

getConfigOrFail() public 

getConfigOrFail(string $key)

Returns 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

mixed

Configuration data at the named key

Throws

InvalidArgumentException

info() public 

info(mixed $message, array $context)

Interesting events.

Example: User logs in, SQL logs.

Parameters

string $message
array $context optional

levels() public 

levels()

Get the levels this logger is interested in.

Returns

array

log() public 

log(mixed $level, mixed $message, array $context)

Implements writing to log files.

Parameters

mixed $level

The severity level of the message being written.

string $message

The message you want to log.

array $context optional

Additional information about the logged message

See Also

\Cake\Log\Engine\Cake\Log\Log::$_levels

notice() public 

notice(mixed $message, array $context)

Normal but significant events.

Parameters

string $message
array $context optional

scopes() public 

scopes()

Get the scopes this logger is interested in.

Returns

array|false

setConfig() public 

setConfig(mixed $key, mixed $value, mixed $merge)

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 optional

The value to set.

bool $merge optional

Whether to recursively merge or overwrite existing config, defaults to true.

Returns

$this

Throws

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

warning() public 

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.

Parameters

string $message
array $context optional

Property Detail

$_config protected

Runtime config

Type

array

$_configInitialized protected

Whether the config property has already been configured with defaults

Type

bool

$_defaultConfig protected

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

$_file protected

The name of the file to save logs into.

Type

string|null

$_path protected

Path to save log files on.

Type

string

$_size protected

Max file size, used for log file rotation.

Type

int|null

© 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.0/class-Cake.Log.Engine.FileLog.html