Class FileLog
File Storage stream for Logging. Writes logs to different files based on the level of log it is.
- Psr\Log\AbstractLogger
-
Cake\Log\Engine\BaseLog
uses
Cake\Core\InstanceConfigTrait
-
Cake\Log\Engine\FileLog
Properties summary
-
$_defaultConfigprotectedarrayDefault config for this class -
$_fileprotectedstring|nullThe name of the file to save logs into. -
$_pathprotectedstring|nullPath to save log files on. -
$_sizeprotectedinteger|nullMax file size, used for log file rotation.
Inherited Properties
Method Summary
-
__construct() public
Sets protected properties based on config provided -
_getFilename() protected
Get filename -
_rotateFile() protected
Rotate log file if size specified in config is reached. Also if
rotatecount is reached oldest file is removed. -
log() public
Implements writing to log files.
Method Detail
__construct() public ¶
__construct( array $config = [] )
Sets protected properties based on config provided
Parameters
- array $config optional []
- Configuration array
Overrides
_getFilename() protected ¶
_getFilename( string $level )
Get filename
Parameters
- string $level
- The level of log.
Returns
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
True if rotated successfully or false in case of error. Null if file doesn't need to be rotated.
log() 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
success of write.
Methods inherited from Cake\Log\Engine\BaseLog
_format() 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
Methods used from Cake\Core\InstanceConfigTrait
_configDelete() protected ¶
_configDelete( string $key )
Deletes a single config key.
Parameters
- string $key
- Key to delete.
Throws
_configRead() protected ¶
_configRead( string|null $key )
Reads a config key.
Parameters
- string|null $key
- Key to read.
Returns
_configWrite() protected ¶
_configWrite( string|array $key , mixed $value , boolean|string $merge = false )
Writes a config key.
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
config() public deprecated ¶
config( string|array|null $key = null , mixed|null $value = null , boolean $merge = true )
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']);
Deprecated
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
Config value being read, or the object itself on write operations.
Throws
configShallow() 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->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 null
- The value to set.
Returns
$this
getConfig() public ¶
getConfig( string|null $key = null , mixed $default = null )
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 null
- The key to get or null for the whole config.
- mixed $default optional null
- The return value when the key does not exist.
Returns
Configuration data at the named key or null if the key does not exist.
setConfig() public ¶
setConfig( string|array $key , mixed|null $value = null , boolean $merge = true )
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 null
- The value to set.
- boolean $merge optional true
- Whether to recursively merge or overwrite existing config, defaults to true.
Returns
$this
Throws
Properties detail
$_defaultConfig ¶
Default config for this class
levelsstring or array, levels the engine is interested inscopesstring or array, scopes the engine is interested infileLog file namepathThe path to save logs on.sizeUsed 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.rotateLog files are rotated specified times before being removed. If value is 0, old versions are removed rather then rotated.maskA 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,
]