类 QueryLogger
此类是一个桥梁,用于将 LoggedQuery 对象写入真正的日志。默认情况下,此类使用内置的 CakePHP Log 类来完成此操作。
属性摘要
-
$_config protected
array<string, mixed>
运行时配置
-
$_configInitialized protected
bool
配置属性是否已使用默认值进行配置
-
$_defaultConfig protected
array<string, mixed>
此类的默认配置
-
$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 = [])
构造函数。
参数
-
array<string, mixed>
$config optional 配置数组
_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 optional 如果要递归合并,则为 true,如果要简单合并,则为 'shallow',如果要覆盖,则为 false,默认为 false。
返回值
void
抛出
Cake\Core\Exception\CakeException
如果尝试覆盖现有配置
alert() ¶ public
alert(stringStringable $message, mixed[] $context = []): void
必须立即采取行动。
示例:整个网站宕机,数据库不可用等。这应该触发短信警报并唤醒你。
参数
-
stringStringable
$message -
mixed[]
$context optional
返回值
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 optional 要设置的值。
返回值
$this
critical() ¶ public
critical(stringStringable $message, mixed[] $context = []): void
严重情况。
示例:应用程序组件不可用,意外异常。
参数
-
stringStringable
$message -
mixed[]
$context optional
返回值
void
debug() ¶ public
debug(stringStringable $message, mixed[] $context = []): void
详细调试信息。
参数
-
stringStringable
$message -
mixed[]
$context optional
返回值
void
emergency() ¶ public
emergency(stringStringable $message, mixed[] $context = []): void
系统不可用。
参数
-
stringStringable
$message -
mixed[]
$context optional
返回值
void
error() ¶ public
error(stringStringable $message, mixed[] $context = []): void
运行时错误,不需要立即采取行动,但通常应该记录和监控。
参数
-
stringStringable
$message -
mixed[]
$context optional
返回值
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 optional 要获取的键,或用于整个配置的 null。
-
mixed
$default optional 键不存在时的返回值。
返回值
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 optional
返回值
void
interpolate() ¶ protected
interpolate(Stringable|string $message, array $context = []): string
用上下文值替换消息字符串中的占位符。
参数
-
Stringable|string
$message 格式化消息。
-
array
$context optional 占位符值的上下文。
返回值
string
log() ¶ public
log(mixed $level, string|Stringable $message, mixed[] $context = []): void
使用任意级别记录。
参数
-
mixed
$level -
string|Stringable
$message -
mixed[]
$context optional
返回值
void
notice() ¶ public
notice(stringStringable $message, mixed[] $context = []): void
正常但重要的事件。
参数
-
stringStringable
$message -
mixed[]
$context optional
返回值
void
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 optional 要设置的值。
-
bool
$merge optional 是否递归合并或覆盖现有配置,默认为 true。
返回值
$this
抛出
Cake\Core\Exception\CakeException
当尝试设置无效的键时。
warning() ¶ public
warning(stringStringable $message, mixed[] $context = []): void
不是错误的异常情况。
示例:使用已弃用的 API、不当使用 API 或不理想的行为,这些行为不一定是错误的。
参数
-
stringStringable
$message -
mixed[]
$context optional
返回值
void