类 ConsoleLog

控制台日志记录。将日志写入控制台输出。

命名空间： Cake\Log\Engine

属性摘要

$_config protected

array<string, mixed>

运行时配置
$_configInitialized protected

bool

配置属性是否已使用默认值进行配置
$_defaultConfig protected

array<string, mixed>

此类的默认配置
$_output protected

Cake\Console\ConsoleOutput

输出流
$formatter protected

Cake\Log\Formatter\AbstractFormatter

方法摘要

__construct() public

构造一个新的控制台记录器。
_configDelete() protected

删除单个配置键。
_configRead() protected

读取配置键。
_configWrite() protected

写入配置键。
alert() public

必须立即采取行动。
configShallow() public

将提供的配置与现有配置合并。与 config() 递归合并嵌套键不同，此方法进行简单合并。
critical() public

严重情况。
debug() public

详细的调试信息。
emergency() public

系统无法使用。
error() public

运行时错误，不需要立即采取行动，但通常应记录和监控。
getConfig() public

返回配置。
getConfigOrFail() public

返回此特定键的配置。
info() public

有趣的事件。
interpolate() protected

用上下文值替换消息字符串中的占位符。
levels() public

获取此记录器感兴趣的级别。
log() public

实现写入控制台。
notice() public

正常但重要的事件。
scopes() public

获取此记录器感兴趣的范围。
setConfig() public

设置配置。
warning() public

不是错误的异常情况。

方法详情

__construct() ¶ public

__construct(array<string, mixed> $config = [])

构造一个新的控制台记录器。

配置

levels 字符串或数组，引擎感兴趣的级别
scopes 字符串或数组，引擎感兴趣的范围
stream 保存日志的路径。
outputAs 整数或 ConsoleOutput::[RAW|PLAIN|COLOR]
dateFormat PHP date() 格式。

参数

array<string, mixed> $config 可选: FileLog 的选项，见上文。

抛出

InvalidArgumentException

_configDelete() ¶ protected

_configDelete(string $key): void

删除单个配置键。

参数

string $key: 要删除的键。

返回值

void

抛出

Cake\Core\Exception\CakeException
如果试图覆盖现有配置

_configRead() ¶ protected

_configRead(string|null $key): mixed

读取配置键。

参数

string|null $key: 要读取的键。

返回值

mixed

_configWrite() ¶ protected

_configWrite(array<string, mixed>|string $key, mixed $value, string|bool $merge = false): void

写入配置键。

参数

array<string, mixed>|string $key: 要写入的键。
mixed $value: 要写入的值。
string|bool $merge 可选: 设置为 true 以递归合并，设置为 'shallow' 以进行简单合并，设置为 false 以覆盖，默认为 false。

返回值

void

抛出

Cake\Core\Exception\CakeException
如果试图覆盖现有配置

alert() ¶ public

alert(stringStringable $message, mixed[] $context = []): void

必须立即采取行动。

例如：整个网站宕机，数据库不可用等。这应该触发 SMS 警报并叫醒你。

参数

stringStringable $message
mixed[] $context 可选

返回值

void

configShallow() ¶ public

configShallow(array<string, mixed>|string $key, mixed|null $value = null): $this

将提供的配置与现有配置合并。与 config() 递归合并嵌套键不同，此方法进行简单合并。

设置特定值

$this->configShallow('key', $value);

设置嵌套值

$this->configShallow('some.nested.key', $value);

同时更新多个配置设置

$this->configShallow(['one' => 'value', 'another' => 'value']);

参数

array<string, mixed>|string $key: 要设置的键，或配置的完整数组。
mixed|null $value 可选: 要设置的值。

返回值

$this

critical() ¶ public

critical(stringStringable $message, mixed[] $context = []): void

严重情况。

例如：应用程序组件不可用，意外异常。

参数

stringStringable $message
mixed[] $context 可选

返回值

void

debug() ¶ public

debug(stringStringable $message, mixed[] $context = []): void

详细的调试信息。

参数

stringStringable $message
mixed[] $context 可选

返回值

void

emergency() ¶ public

emergency(stringStringable $message, mixed[] $context = []): void

系统无法使用。

参数

stringStringable $message
mixed[] $context 可选

返回值

void

error() ¶ public

error(stringStringable $message, mixed[] $context = []): void

运行时错误，不需要立即采取行动，但通常应记录和监控。

参数

stringStringable $message
mixed[] $context 可选

返回值

void

getConfig() ¶ public

getConfig(string|null $key = null, mixed $default = null): mixed

返回配置。

用法

读取整个配置

$this->getConfig();

读取特定值

$this->getConfig('key');

读取嵌套值

$this->getConfig('some.nested.key');

使用默认值读取

$this->getConfig('some-key', 'default-value');

参数

string|null $key 可选: 要获取的键，或整个配置的 null。
mixed $default 可选: 键不存在时的返回值。

返回值

mixed

getConfigOrFail() ¶ public

getConfigOrFail(string $key): mixed

返回此特定键的配置。

此键的配置值必须存在，绝不能为 null。

参数

string $key: 要获取的键。

返回值

mixed

抛出

InvalidArgumentException

info() ¶ public

info(stringStringable $message, mixed[] $context = []): void

有趣的事件。

例如：用户登录，SQL 日志。

参数

stringStringable $message
mixed[] $context 可选

返回值

void

interpolate() ¶ protected

interpolate(Stringable|string $message, array $context = []): string

用上下文值替换消息字符串中的占位符。

参数

Stringable|string $message: 格式化后的消息。
array $context 可选: 占位符值的上下文。

返回值

string

levels() ¶ public

levels(): list<string>

获取此记录器感兴趣的级别。

返回值

list<string>

log() ¶ public

log(mixed $level, Stringable|string $message, mixed[] $context = []): void

实现写入控制台。

参数

mixed $level: 您要记录的日志的严重程度级别。
Stringable|string $message: 您要记录的消息。
mixed[] $context 可选: 有关记录消息的附加信息

返回值

void

另请参阅

\Cake\Log\Log::$_levels

notice() ¶ public

notice(stringStringable $message, mixed[] $context = []): void

正常但重要的事件。

参数

stringStringable $message
mixed[] $context 可选

返回值

void

scopes() ¶ public

scopes(): list<string>|null

获取此记录器感兴趣的范围。

返回值

list<string>|null

setConfig() ¶ public

setConfig(array<string, mixed>|string $key, mixed|null $value = null, bool $merge = true): $this

设置配置。

用法

设置特定值

$this->setConfig('key', $value);

设置嵌套值

$this->setConfig('some.nested.key', $value);

同时更新多个配置设置

$this->setConfig(['one' => 'value', 'another' => 'value']);

参数

array<string, mixed>|string $key: 要设置的键，或配置的完整数组。
mixed|null $value 可选: 要设置的值。
bool $merge 可选: 是否递归合并或覆盖现有配置，默认为 true。

返回值

$this

抛出

Cake\Core\Exception\CakeException
当试图设置一个无效的键时。

warning() ¶ public

warning(stringStringable $message, mixed[] $context = []): void

不是错误的异常情况。

例如：使用过时的 API，API 使用不当，并非错误的不理想情况。

参数

stringStringable $message
mixed[] $context 可选

返回值

void

属性详情

`$_config` ¶ protected

运行时配置

类型

array<string, mixed>

`$_configInitialized` ¶ 受保护

配置属性是否已使用默认值进行配置

类型

bool

`$_defaultConfig` ¶ 受保护

此类的默认配置

类型

array<string, mixed>

`$_output` ¶ 受保护

输出流

类型

Cake\Console\ConsoleOutput

`$formatter` ¶ 受保护

类型

Cake\Log\Formatter\AbstractFormatter

命名空间

类 ConsoleLog

属性摘要

方法摘要

__construct() public

_configDelete() protected

_configRead() protected

_configWrite() protected

alert() public

configShallow() public

critical() public

debug() public

emergency() public

error() public

getConfig() public

getConfigOrFail() public

info() public

interpolate() protected

levels() public

log() public

notice() public

scopes() public

setConfig() public

warning() public

方法详情

__construct() ¶ public

参数

抛出

_configDelete() ¶ protected

参数

返回值

抛出

_configRead() ¶ protected

参数

返回值

_configWrite() ¶ protected

参数

返回值

抛出

alert() ¶ public

参数

返回值

configShallow() ¶ public

参数

返回值

critical() ¶ public

参数

返回值

debug() ¶ public

参数

返回值

emergency() ¶ public

参数

返回值

error() ¶ public

参数

返回值

getConfig() ¶ public

用法

参数

返回值

getConfigOrFail() ¶ public

参数

返回值

抛出

info() ¶ public

参数

返回值

interpolate() ¶ protected

参数

返回值

levels() ¶ public

返回值

log() ¶ public

参数

返回值

另请参阅

notice() ¶ public

参数

返回值

`$_config` ¶ protected

`$_configInitialized` ¶ 受保护

`$_defaultConfig` ¶ 受保护

`$_output` ¶ 受保护

`$formatter` ¶ 受保护