__constructsource public

__construct( array $config [] )

Sets protected properties based on config provided

Parameters

array $config optional []

Configuration array

Overrides

Cake\Log\Engine\BaseLog::__construct()

_getFilenamesource protected

_getFilename( string $level )

Get filename

Parameters

string $level

The level of log.

Returns

string
File name

_rotateFilesource 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

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

logsource public

log( string $level , string $message , array $context [] )

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 optional []

Additional information about the logged message

Returns

boolean
success of write.

_formatsource protected

_format( mixed $data , array $context [] )

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 optional []

Additional logging information for the message.

Returns

string
string

levelssource public

levels( )

Get the levels this logger is interested in.

Returns

array
array

scopessource public

scopes( )

Get the scopes this logger is interested in.

Returns

array
array

_configDeletesource protected

_configDelete( string $key )

Delete a single config key

Parameters

string $key

Key to delete.

Throws

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

_configReadsource protected

_configRead( string|null $key )

Read a config variable

Parameters

string|null $key

Key to read.

Returns

mixed
mixed

_configWritesource protected

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

Write a config variable

Parameters

string|array $key

Key to write to.

mixed $value

Value to write.

boolean|string $merge optional false

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

configsource public

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

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 optional null

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

mixed|null $value optional null

The value to set.

boolean $merge optional true

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

Returns

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

Throws

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

configShallowsource public

configShallow( string|array $key , mixed|null $value null )

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->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 $key

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

mixed|null $value optional null

The value to set.

Returns

mixed
$this The object itself.

[
    'path' => null,
    'file' => null,
    'types' => null,
    'levels' => [],
    'scopes' => [],
    'rotate' => 10,
    'size' => 10485760, // 10MB
    'mask' => null,
]

null

null

null

[]

false