Class FileLog
File Storage stream for Logging. Writes logs to different files based on the level of log it is.
Property Summary
-
$_config protected
arrayRuntime config
-
$_configInitialized protected
boolWhether the config property has already been configured with defaults
-
$_defaultConfig protected
arrayDefault config for this class
-
$_file protected
string|nullThe name of the file to save logs into.
-
$_path protected
string|nullPath to save log files on.
-
$_size protected
int|nullMax 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
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
rotatecount is reached oldest file is removed. -
alert() public
Action must be taken immediately.
-
config() public deprecated
Gets/Sets the config.
-
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): voidDeletes a single config key.
Parameters
-
string$key Key to delete.
Returns
voidThrows
Cake\Core\Exception\Exceptionif attempting to clobber existing config
_configRead() ¶ protected
_configRead(string|null $key): mixedReads a config key.
Parameters
-
string|null$key Key to read.
Returns
mixed_configWrite() ¶ protected
_configWrite(string|array $key, mixed $value, bool|string $merge = false): voidWrites 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.
Returns
voidThrows
Cake\Core\Exception\Exceptionif attempting to clobber existing config
_format() ¶ protected
_format(mixed $data, array $context = []): stringConverts 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): stringGet filename
Parameters
-
string$level The level of log.
Returns
string_rotateFile() ¶ protected
_rotateFile(string $filename): bool|nullRotate 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|nullalert() ¶ public
alert(string $message, mixed[] $context = array()): voidAction must be taken immediately.
Example: Entire website down, database unavailable, etc. This should trigger the SMS alerts and wake you up.
Parameters
-
string$message -
mixed[]$context optional
Returns
voidconfig() ¶ public
config(string|array|null $key = null, mixed|null $value = null, bool $merge = true): mixedGets/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']);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
mixedThrows
Cake\Core\Exception\ExceptionWhen trying to set a key that is invalid.
configShallow() ¶ public
configShallow(string|array $key, mixed|null $value = null): $thisMerge 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
$thiscritical() ¶ public
critical(string $message, mixed[] $context = array()): voidCritical conditions.
Example: Application component unavailable, unexpected exception.
Parameters
-
string$message -
mixed[]$context optional
Returns
voiddebug() ¶ public
debug(string $message, mixed[] $context = array()): voidDetailed debug information.
Parameters
-
string$message -
mixed[]$context optional
Returns
voidemergency() ¶ public
emergency(string $message, mixed[] $context = array()): voidSystem is unusable.
Parameters
-
string$message -
mixed[]$context optional
Returns
voiderror() ¶ public
error(string $message, mixed[] $context = array()): voidRuntime errors that do not require immediate action but should typically be logged and monitored.
Parameters
-
string$message -
mixed[]$context optional
Returns
voidgetConfig() ¶ public
getConfig(string|null $key = null, mixed|null $default = null): mixed|nullReturns 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|null$default optional The return value when the key does not exist.
Returns
mixed|nullgetConfigOrFail() ¶ public
getConfigOrFail(string|null $key): mixedReturns the config for this specific key.
The config value for this key must exist, it can never be null.
Parameters
-
string|null$key The key to get.
Returns
mixedThrows
InvalidArgumentExceptioninfo() ¶ public
info(string $message, mixed[] $context = array()): voidInteresting events.
Example: User logs in, SQL logs.
Parameters
-
string$message -
mixed[]$context optional
Returns
voidlog() ¶ public
log(mixed $level, string $message, mixed[] $context = []): boolImplements writing to log files.
Parameters
-
mixed$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.
-
mixed[]$context optional Additional information about the logged message
Returns
boolnotice() ¶ public
notice(string $message, mixed[] $context = array()): voidNormal but significant events.
Parameters
-
string$message -
mixed[]$context optional
Returns
voidscopes() ¶ public
scopes(): array|falseGet the scopes this logger is interested in.
Returns
array|falsesetConfig() ¶ public
setConfig(string|array $key, mixed|null $value = null, bool $merge = true): $thisSets 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
$thisThrows
Cake\Core\Exception\ExceptionWhen trying to set a key that is invalid.
warning() ¶ public
warning(string $message, mixed[] $context = array()): voidExceptional 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 -
mixed[]$context optional
Returns
voidProperty Detail
$_configInitialized ¶ protected
Whether the config property has already been configured with defaults
Type
bool$_defaultConfig ¶ protected
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.
Type
array