类 LogEngineRegistry
已加载日志引擎的注册表
属性摘要
-
$_loaded protected
array<string, object>
已加载对象的映射。
方法摘要
-
__debugInfo() public
调试友好的对象属性。
-
__get() public
提供对已加载对象的公共读访问权限
-
__isset() public
提供对 _loaded 的 isset 访问
-
__set() public
设置对象。
-
__unset() public
取消设置对象。
-
_checkDuplicate() protected
检查重复的对象加载。
-
_create() protected
创建日志记录器实例。
-
_resolveClassName() protected
解析日志记录器类名。
-
_throwMissingClassError() protected
当日志记录器丢失时抛出异常。
-
count() public
返回已加载对象的个数。
-
get() public
获取已加载的对象实例。
-
getIterator() public
返回数组迭代器。
-
has() public
检查是否加载了给定的对象。
-
load() public
加载/构造对象实例。
-
loaded() public
获取已加载对象的列表。
-
normalizeArray() public
将对象配置数组规范化为关联形式,以方便延迟加载。
-
reset() public
清除注册表中的已加载实例。
-
set() public
直接将对象按名称设置到注册表中。
-
unload() public
从注册表中移除单个日志记录器。
方法详情
__get() ¶ public
__get(string $name): object|null
提供对已加载对象的公共读访问权限
参数
-
string
$name 要读取的属性名称
返回
object|null
__isset() ¶ public
__isset(string $name): bool
提供对 _loaded 的 isset 访问
参数
-
string
$name 要检查的对象的名称。
返回
bool
__set() ¶ public
__set(string $name, object $object): void
设置对象。
参数
-
string
$name 要设置的属性名称。
-
object
$object 要设置的对象。
返回
void
_checkDuplicate() ¶ protected
_checkDuplicate(string $name, array<string, mixed> $config): void
检查重复的对象加载。
如果正在加载重复项且具有不同的配置,则很糟糕,将引发异常。
引发异常,因为替换对象不会更新其他对象可能具有的任何引用。此外,仅仅更新运行时配置不是一个好的选择,因为我们可能会丢失依赖于配置的重要构造逻辑。
参数
-
string
$name 注册表中别名的名称。
-
array<string, mixed>
$config 新实例的配置数据。
返回
void
抛出
Cake\Core\Exception\CakeException
当发现重复项时。
_create() ¶ protected
_create(Psr\Log\LoggerInterface|callable|class-stringPsr\Log\LoggerInterface> $class, string $alias, array<string, mixed> $config): Psr\Log\LoggerInterface
创建日志记录器实例。
Cake\Core\ObjectRegistry::load() 模板方法的一部分
参数
-
Psr\Log\LoggerInterface|callable|class-stringPsr\Log\LoggerInterface>
$class 要制作的类名或对象。
-
string
$alias 对象的别名。
-
array<string, mixed>
$config 用于日志记录器的设置数组。
返回
Psr\Log\LoggerInterface
_resolveClassName() ¶ protected
_resolveClassName(string $class): class-stringPsr\Log\LoggerInterface>|null
解析日志记录器类名。
Cake\Core\ObjectRegistry::load() 模板方法的一部分
参数
-
string
$class 要解析的部分类名。
返回
class-stringPsr\Log\LoggerInterface>|null
_throwMissingClassError() ¶ protected
_throwMissingClassError(string $class, string|null $plugin): void
当日志记录器丢失时抛出异常。
Cake\Core\ObjectRegistry::load() 模板方法的一部分
参数
-
string
$class 丢失的类名。
-
string|null
$plugin 日志记录器丢失的插件。
返回
void
抛出
Cake\Core\Exception\CakeException
get() ¶ public
get(string $name): object
获取已加载的对象实例。
参数
-
string
$name 对象的名称。
返回
object
抛出
Cake\Core\Exception\CakeException
如果未加载或未找到。
load() ¶ public
load(string $name, array<string, mixed> $config = []): object
加载/构造对象实例。
如果注册表中已经存在该实例,则将返回该实例。如果子类提供事件支持,则可以使用 $config['enabled'] = false
将构造的对象排除在事件注册之外。
以 {@link \Cake\Controller\Component::$components} 为例。可以通过设置 'className' 键来为对象设置别名,例如:
protected $components = [
'Email' => [
'className' => 'App\Controller\Component\AliasedEmailComponent'
];
];
对 Email
组件的所有调用将使用 AliasedEmail
代替。
参数
-
string
$name 要加载的对象的名称/类。
-
array<string, mixed>
$config optional 加载对象时要使用的其他设置。
返回
object
抛出
异常
如果找不到类。
normalizeArray() ¶ public
normalizeArray(array $objects): array<string, array>
将对象配置数组规范化为关联形式,以方便延迟加载。
参数
-
array
$objects 要规范化的子对象的数组。
返回
array<string, array>
set() ¶ public
set(string $name, object $object): $this
直接将对象按名称设置到注册表中。
如果此集合实现事件,则传递的对象将附加到事件管理器中
参数
-
string
$name 要在注册表中设置的对象的名称。
-
object
$object 要存储在注册表中的实例
返回
$this
unload() ¶ public
unload(string $name): $this
从注册表中移除单个日志记录器。
如果此注册表具有事件管理器,则该对象也将从任何事件中分离。
参数
-
string
$name 记录器名称。
返回
$this