W3cubDocs

/CakePHP 3.4

Class ConsoleLog

Console logging. Writes logs to console output.

Psr\Log\AbstractLogger
Extended by Cake\Log\Engine\BaseLog uses Cake\Core\InstanceConfigTrait
Extended by Cake\Log\Engine\ConsoleLog
Namespace: Cake\Log\Engine
Location: Log/Engine/ConsoleLog.php

Properties summary

Inherited Properties

Method Summary

  • __construct() public
    Constructs a new Console Logger.
  • log() public
    Implements writing to console.

Method Detail

__construct()source 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

Overrides

Cake\Log\Engine\BaseLog::__construct()

log()source public

log( string $level , string $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

boolean
success of write.

Methods inherited from Cake\Log\Engine\BaseLog

_format()source 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

levels()source public

levels( )

Get the levels this logger is interested in.

Returns

array

scopes()source public

scopes( )

Get the scopes this logger is interested in.

Returns

array

Methods used from Cake\Core\InstanceConfigTrait

_configDelete()source protected

_configDelete( string $key )

Deletes a single config key.

Parameters

string $key
Key to delete.

Throws

Cake\Core\Exception\Exception
if attempting to clobber existing config

_configRead()source protected

_configRead( string|null $key )

Reads a config key.

Parameters

string|null $key
Key to read.

Returns

mixed

_configWrite()source 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

Cake\Core\Exception\Exception
if attempting to clobber existing config

config()source public

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

3.4.0 use setConfig()/getConfig() instead.

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.

configShallow()source 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


$this

getConfig()source public

getConfig( string|null $key 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');

Parameters

string|null $key optional null
The key to get or null for the whole config.

Returns

mixed
Config value being read.

setConfig()source 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

Cake\Core\Exception\Exception
When trying to set a key that is invalid.

Properties detail

$_defaultConfigsource

protected array

Default config for this class

[
    'stream' => 'php://stderr',
    'levels' => null,
    'scopes' => [],
    'outputAs' => 'see constructor'
]

$_outputsource

protected Cake\Console\ConsoleOutput

Output stream

null

© 2005–2017 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.4/class-Cake.Log.Engine.ConsoleLog.html