类 HelperRegistry
HelperRegistry 用作已加载帮助程序的注册表，并处理加载和构建帮助程序类对象。
属性摘要
-
$_View protected
Cake\View\View用于制作帮助程序的视图对象。
-
$_eventClass protected
string新事件对象的默认类名。
-
$_eventManager protected
Cake\Event\EventManagerInterface|null此对象用于分发内部事件的 Cake\Event\EventManager 的实例。
-
$_loaded protected
array<string, object>已加载对象的映射。
方法摘要
-
__construct() public
构造函数
-
__debugInfo() public
调试友好的对象属性。
-
__get() public
提供对已加载对象的公共读取访问权限
-
__isset() public
尝试根据其名称延迟加载帮助程序，如果在应用程序文件夹中找不到，则尝试在当前插件（如果有）下查找
-
__set() public
设置一个对象。
-
__unset() public
取消设置一个对象。
-
_checkDuplicate() protected
检查重复对象加载。
-
_create() protected
创建帮助程序实例。
-
_resolveClassName() protected
解析帮助程序类名。
-
_throwMissingClassError() protected
当帮助程序丢失时抛出异常。
-
count() public
返回已加载对象的数目。
-
dispatchEvent() public
创建和分发事件的包装器。
-
get() public
获取已加载的对象实例。
-
getEventManager() public
返回此对象的 Cake\Event\EventManager 管理器实例。
-
getIterator() public
返回一个数组迭代器。
-
has() public
检查是否加载了给定对象。
-
load() public
加载/构建对象实例。
-
loaded() public
获取已加载对象的列表。
-
normalizeArray() public
将对象配置数组规范化为关联形式，以便更轻松地进行延迟加载。
-
reset() public
清除注册表中已加载的实例。
-
set() public
直接按名称将对象设置为注册表。
-
setEventManager() public
返回此对象的 Cake\Event\EventManagerInterface 实例。
-
unload() public
从注册表中删除对象。
方法详细信息
__get() ¶ public
__get(string $name): Cake\View\Helper|null提供对已加载对象的公共读取访问权限
参数
-
string$name 要读取的属性名称
返回
Cake\View\Helper|null__isset() ¶ public
__isset(string $helper): bool尝试根据其名称延迟加载帮助程序，如果在应用程序文件夹中找不到，则尝试在当前插件（如果有）下查找
参数
-
string$helper 要加载的帮助程序名称
返回
bool抛出
Cake\View\Exception\MissingHelperException当找不到帮助程序时。将搜索应用程序帮助程序，然后搜索插件帮助程序。
__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(object|string $class, string $alias, array<string, mixed> $config): Cake\View\Helper创建帮助程序实例。
Cake\Core\ObjectRegistry::load() 的模板方法的一部分。已启用的帮助程序将向事件管理器注册。
参数
-
object|string$class 要创建的类。
-
string$alias 已加载帮助程序的别名。
-
array<string, mixed>$config 用于帮助程序的一组设置。
返回
Cake\View\Helper_resolveClassName() ¶ protected
_resolveClassName(string $class): class-stringCake\View\Helper>|null解析帮助程序类名。
Cake\Core\ObjectRegistry::load() 的模板方法的一部分
参数
-
string$class 要解析的部分类名。
返回
class-stringCake\View\Helper>|null_throwMissingClassError() ¶ protected
_throwMissingClassError(string $class, string|null $plugin): void当帮助程序丢失时抛出异常。
Cake\Core\ObjectRegistry::load() 和 Cake\Core\ObjectRegistry::unload() 的模板方法的一部分
参数
-
string$class 缺少的类名。
-
string|null$plugin 帮助程序在其中丢失的插件。
返回
void抛出
Cake\View\Exception\MissingHelperExceptiondispatchEvent() ¶ public
dispatchEvent(string $name, array $data = [], TSubject|null $subject = null): Cake\Event\EventInterface<TSubject>创建和分发事件的包装器。
返回已分发的事件。
参数
-
string$name 事件名称。
-
array$data optional 您希望与该事件一起传输的任何值，监听器可以读取该值。
-
TSubject|null$subject optional 此事件适用的对象（默认情况下为 $this）。
返回
Cake\Event\EventInterface<TSubject>get() ¶ public
get(string $name): object获取已加载的对象实例。
参数
-
string$name 对象名称。
返回
object抛出
Cake\Core\Exception\CakeException如果未加载或未找到。
getEventManager() ¶ public
getEventManager(): Cake\Event\EventManagerInterface返回此对象的 Cake\Event\EventManager 管理器实例。
您可以使用此实例注册任何新的监听器或回调到对象事件，或创建您自己的事件并随意触发它们。
返回
Cake\Event\EventManagerInterfaceload() ¶ 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 可选 加载对象时使用的其他设置。
返回
object抛出
Exception如果找不到类。
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 要存储在注册表中的实例
返回
$thissetEventManager() ¶ public
setEventManager(Cake\Event\EventManagerInterface $eventManager): $this返回此对象的 Cake\Event\EventManagerInterface 实例。
您可以使用此实例注册任何新的监听器或回调到对象事件，或创建您自己的事件并随意触发它们。
参数
-
Cake\Event\EventManagerInterface$eventManager 要设置的 eventManager
返回
$thisunload() ¶ public
unload(string $name): $this从注册表中删除对象。
如果此注册表具有事件管理器，则对象也将从任何事件中分离。
参数
-
string$name 要从注册表中删除的对象的名称。
返回
$this