Class FileLog

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

Psr\Log\AbstractLogger
Extended by Cake\Log\Engine\BaseLog uses Cake\Core\InstanceConfigTrait
Extended by Cake\Log\Engine\FileLog
Namespace: Cake\Log\Engine
Located at Log/Engine/FileLog.php

Method Detail

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

Methods inherited from Cake\Log\Engine\BaseLog

_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

Methods used from Cake\Core\InstanceConfigTrait

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

Properties summary

$_defaultConfigsource

protected 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.
[
    'path' => null,
    'file' => null,
    'types' => null,
    'levels' => [],
    'scopes' => [],
    'rotate' => 10,
    'size' => 10485760, // 10MB
    'mask' => null,
]

$_filesource

protected string

The name of the file to save logs into.

null

$_pathsource

protected string

Path to save log files on.

null

$_sizesource

protected integer

Max file size, used for log file rotation.

null

Properties used from Cake\Core\InstanceConfigTrait

$_configsource

protected array

Runtime config

[]

$_configInitializedsource

protected boolean

Whether the config property has already been configured with defaults

false

© 2005–2016 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.
http://api.cakephp.org/3.1/class-Cake.Log.Engine.FileLog.html