Class ConsoleLog
Console logging. Writes logs to console output.
Properties 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
- $_output protected
\Cake\Console\ConsoleOutput
Output stream
Method Summary
- _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.
- configShallow() public
Merge provided config with existing config. Unlike
config()
which does a recursive merge for nested keys, this method does a simple merge. - error() public
Runtime errors that do not require immediate action but should typically be logged and monitored.
Method Detail
__construct() public
__construct(array $config)
Constructs a new Console Logger.
Config
-
levels
string or array, levels the engine is interested in -
scopes
string or array, scopes the engine is interested in -
stream
the path to save logs on. -
outputAs
integer or ConsoleOutput::[RAW|PLAIN|COLOR]
Parameters
-
array
$config optional Options for the FileLog, see above.
Throws
InvalidArgumentException
_configDelete() protected
_configDelete(mixed $key)
Deletes a single config key.
Parameters
-
string
$key Key to delete.
Throws
Cake\Core\Exception\Exception
if attempting to clobber existing config
_configRead() protected
_configRead(mixed $key)
Reads a config key.
Parameters
-
string|null
$key Key to read.
Returns
mixed
_configWrite() protected
_configWrite(mixed $key, mixed $value, mixed $merge)
Writes 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.
Throws
Cake\Core\Exception\Exception
if attempting to clobber existing config
_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
string
alert() public
alert(mixed $message, array $context)
Action must be taken immediately.
Example: Entire website down, database unavailable, etc. This should trigger the SMS alerts and wake you up.
Parameters
-
string
$message -
array
$context optional
config() public
config(mixed $key, mixed $value, mixed $merge)
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']);
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
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.
configShallow() public
configShallow(mixed $key, mixed $value)
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 The value to set.
Returns
$this
critical() public
critical(mixed $message, array $context)
Critical conditions.
Example: Application component unavailable, unexpected exception.
Parameters
-
string
$message -
array
$context optional
debug() public
debug(mixed $message, array $context)
Detailed debug information.
Parameters
-
string
$message -
array
$context optional
emergency() public
emergency(mixed $message, array $context)
System is unusable.
Parameters
-
string
$message -
array
$context optional
error() public
error(mixed $message, array $context)
Runtime errors that do not require immediate action but should typically be logged and monitored.
Parameters
-
string
$message -
array
$context optional
getConfig() public
getConfig(mixed $key, mixed $default)
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 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|null
Configuration data at the named key or null if the key does not exist.
getConfigOrFail() public
getConfigOrFail(mixed $key)
Returns 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
mixed
Configuration data at the named key
Throws
InvalidArgumentException
info() public
info(mixed $message, array $context)
Interesting events.
Example: User logs in, SQL logs.
Parameters
-
string
$message -
array
$context optional
levels() public
levels()
Get the levels this logger is interested in.
Returns
array
log() public
log(mixed $level, mixed $message, array $context)
Implements writing to console.
Parameters
-
string
$level The severity level of log you are making.
-
string
$message The message you want to log.
-
array
$context optional Additional information about the logged message
Returns
bool
success of write.
notice() public
notice(mixed $message, array $context)
Normal but significant events.
Parameters
-
string
$message -
array
$context optional
scopes() public
scopes()
Get the scopes this logger is interested in.
Returns
array|false
setConfig() public
setConfig(mixed $key, mixed $value, mixed $merge)
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 The value to set.
-
bool
$merge optional Whether to recursively merge or overwrite existing config, defaults to true.
Returns
$this
Throws
Cake\Core\Exception\Exception
When trying to set a key that is invalid.
warning() public
warning(mixed $message, array $context)
Exceptional 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 -
array
$context optional
Property Detail
$_config protected
Runtime config
Type
array
$_configInitialized protected
Whether the config property has already been configured with defaults
Type
bool
$_defaultConfig protected
Default config for this class
Type
array
$_output protected
Output stream
Type
\Cake\Console\ConsoleOutput
© 2005–present 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.
https://api.cakephp.org/3.9/class-Cake.Log.Engine.ConsoleLog.html