Class FileLog
File Storage stream for Logging. Writes logs to different files based on the level of log it is.
Property 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
The name of the file to save logs into.
-
$_path protected
string
Path to save log files on.
-
$_size protected
int
Max file size, used for log file rotation.
Method Summary
-
__construct() public
Sets protected properties based on config provided
-
_configDelete() protected
Delete a single config key
-
_configRead() protected
Read a config variable
-
_configWrite() protected
Write a config variable
-
_format() protected
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.
-
_getFilename() protected
Get filename
-
_rotateFile() protected
Rotate log file if size specified in config is reached. Also if
rotate
count is reached oldest file is removed. -
config() public
Usage
-
configShallow() public
Merge provided config with existing config. Unlike
config()
which does a recursive merge for nested keys, this method does a simple merge. -
levels() public
Get the levels this logger is interested in.
-
log() public
Implements writing to log files.
-
scopes() public
Get the scopes this logger is interested in.
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): void
Delete a single config key
Parameters
-
string
$key Key to delete.
Returns
void
Throws
Cake\Core\Exception\Exception
if attempting to clobber existing config
_configRead() ¶ protected
_configRead(string|null $key): mixed
Read a config variable
Parameters
-
string|null
$key Key to read.
Returns
mixed
_configWrite() ¶ protected
_configWrite(string|array $key, mixed $value, bool|string $merge = false): void
Write a config variable
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.
Returns
void
Throws
Cake\Core\Exception\Exception
if attempting to clobber existing config
_format() ¶ protected
_format(mixed $data, array $context = []): 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 optional Additional logging information for the message.
Returns
string
_getFilename() ¶ protected
_getFilename(string $level): string
Get filename
Parameters
-
string
$level The level of log.
Returns
string
_rotateFile() ¶ protected
_rotateFile(string $filename): bool|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
bool|null
config() ¶ public
config(string|array|null $key = null, mixed|null $value = null, bool $merge = true): mixed
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 The key to get/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
mixed
Throws
Cake\Core\Exception\Exception
When trying to set a key that is invalid.
configShallow() ¶ public
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->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 The value to set.
Returns
$this
log() ¶ public
log(string $level, string $message, array $context = []): bool
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
bool
Property Detail
$_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 inscopes
string or array, scopes the engine is interested infile
Log file namepath
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