类 ComponentRegistry

ComponentRegistry 是一个用于加载组件的注册表。

处理组件类对象的加载、构造和绑定事件。

命名空间： Cake\Controller

属性汇总

$_Controller protected

Cake\Controller\Controller|null

与该集合关联的控制器。
$_eventClass protected

string

新事件对象的默认类名。
$_eventManager protected

Cake\Event\EventManagerInterface|null

Cake\Event\EventManager 的实例，该对象用于调度内部事件。
$_loaded protected

array<string, object>

加载对象的映射。
$container protected

Cake\Core\ContainerInterface|null

方法汇总

__construct() public

构造函数。
__debugInfo() public

调试友好的对象属性。
__get() public

提供对加载对象的公共读访问
__isset() public

提供对 _loaded 的 isset 访问
__set() public

设置一个对象。
__unset() public

取消设置一个对象。
_checkDuplicate() protected

检查重复的对象加载。
_create() protected

创建组件实例。
_resolveClassName() protected

解析组件类名。
_throwMissingClassError() protected

在组件缺失时抛出异常。
count() public

返回加载对象的个数。
dispatchEvent() public

创建和调度事件的包装器。
get() public

获取加载的对象实例。
getController() public

获取与集合关联的控制器。
getEventManager() public

返回此对象的 Cake\Event\EventManager 管理器实例。
getIterator() public

返回一个数组迭代器。
has() public

检查是否加载了给定的对象。
load() public

加载/构造对象实例。
loaded() public

获取加载对象的列表。
normalizeArray() public

将对象配置数组规范化为关联形式，以便更轻松地进行延迟加载。
reset() public

清除注册表中加载的实例。
set() public

直接按名称将对象设置到注册表中。
setController() public

设置与集合关联的控制器。
setEventManager() public

返回此对象的 Cake\Event\EventManagerInterface 实例。
unload() public

从注册表中移除一个对象。

方法详情

__construct() ¶ public

__construct(Cake\Controller\Controller|null $controller = null, Cake\Core\ContainerInterface|null $container = null)

构造函数。

参数

Cake\Controller\Controller|null $controller optional: 控制器实例。
Cake\Core\ContainerInterface|null $container optional: 容器实例。

__debugInfo() ¶ public

__debugInfo(): array<string, mixed>

调试友好的对象属性。

array<string, mixed>

__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

__unset() ¶ public

__unset(string $name): void

取消设置一个对象。

参数

string $name: 要取消设置的属性名称。

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\Controller\Component

创建组件实例。

用于 {@link \Cake\Core\ObjectRegistry::load()} 的模板方法的一部分。启用的组件将注册到事件管理器中。

参数

object|string $class: 要创建的类名。
string $alias: 组件的别名。
array<string, mixed> $config: 要用于组件的配置数组。

Cake\Controller\Component

_resolveClassName() ¶ protected

_resolveClassName(string $class): class-stringCake\Controller\Component>|null

解析组件类名。

用于 {@link \Cake\Core\ObjectRegistry::load()} 的模板方法的一部分。

参数

string $class: 要解析的部分类名。

class-stringCake\Controller\Component>|null

_throwMissingClassError() ¶ protected

_throwMissingClassError(string $class, string|null $plugin): void

在组件缺失时抛出异常。

用于 {@link \Cake\Core\ObjectRegistry::load()} 和 {@link \Cake\Core\ObjectRegistry::unload()} 的模板方法的一部分。

参数

string $class: 缺失的类名。
string|null $plugin: 组件缺失的插件。

void

抛出

Cake\Controller\Exception\MissingComponentException

count() ¶ public

count(): int

返回加载对象的个数。

int

dispatchEvent() ¶ public

dispatchEvent(string $name, array $data = [], TSubject|null $subject = null): Cake\Event\EventInterface<TSubject>

创建和调度事件的包装器。

返回一个已分发的事件。

参数

string $name: 事件的名称。
array $data 可选: 任何您希望与该事件一起传递的值，监听器可以读取这些值。
TSubject|null $subject 可选: 该事件适用的对象（默认情况下为 $this）。

Cake\Event\EventInterface<TSubject>

get() ¶ public

get(string $name): object

获取加载的对象实例。

参数

string $name: 对象的名称。

object

抛出

Cake\Core\Exception\CakeException
如果未加载或未找到。

getController() ¶ public

getController(): Cake\Controller\Controller

获取与集合关联的控制器。

Cake\Controller\Controller

getEventManager() ¶ public

getEventManager(): Cake\Event\EventManagerInterface

返回此对象的 Cake\Event\EventManager 管理器实例。

您可以使用此实例向对象事件注册任何新的监听器或回调，或创建您自己的事件并随意触发它们。

Cake\Event\EventManagerInterface

getIterator() ¶ public

getIterator(): Traversable

返回一个数组迭代器。

Traversable

has() ¶ public

has(string $name): bool

检查是否加载了给定的对象。

参数

string $name: 要检查的对象名称。

bool

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 可选: 加载对象时要使用的其他设置。

object

抛出

Exception
如果找不到该类。

loaded() ¶ public

loaded(): list<string>

获取加载对象的列表。

list<string>

normalizeArray() ¶ public

normalizeArray(array $objects): array<string, array>

将对象配置数组规范化为关联形式，以便更轻松地进行延迟加载。

参数

array $objects: 要规范化的子对象数组。

array<string, array>

reset() ¶ public

reset(): $this

清除注册表中加载的实例。

如果注册表子类具有事件管理器，则对象也会从事件中分离。

$this

set() ¶ public

set(string $name, object $object): $this

直接按名称将对象设置到注册表中。

如果此集合实现事件，则传递的对象将附加到事件管理器中

参数

string $name: 要设置在注册表中的对象的名称。
object $object: 要存储在注册表中的实例

$this

setController() ¶ public

setController(Cake\Controller\Controller $controller): $this

设置与集合关联的控制器。

参数

Cake\Controller\Controller $controller: 控制器实例。

$this

setEventManager() ¶ public

setEventManager(Cake\Event\EventManagerInterface $eventManager): $this

返回此对象的 Cake\Event\EventManagerInterface 实例。

您可以使用此实例向对象事件注册任何新的监听器或回调，或创建您自己的事件并随意触发它们。

参数

Cake\Event\EventManagerInterface $eventManager: 要设置的 eventManager

$this

unload() ¶ public

unload(string $name): $this

从注册表中移除一个对象。

如果此注册表具有事件管理器，则对象也将从任何事件中分离。

参数

string $name: 要从注册表中删除的对象的名称。

$this

属性详情

`$_Controller` ¶ protected

与该集合关联的控制器。

类型

Cake\Controller\Controller|null

`$_eventClass` ¶ protected

新事件对象的默认类名。

类型

string

`$_eventManager` ¶ protected

Cake\Event\EventManager 的实例，该对象用于调度内部事件。

类型

Cake\Event\EventManagerInterface|null

`$_loaded` ¶ protected

加载对象的映射。

类型

array<string, object>

`$container` ¶ protected

类型

Cake\Core\ContainerInterface|null

命名空间

类 ComponentRegistry

属性汇总

方法汇总

__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

getController() public

getEventManager() public

getIterator() public

has() public

load() public

loaded() public

normalizeArray() public

reset() public

set() public

setController() public

setEventManager() public

unload() public

方法详情

__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

参数

返回

抛出

getController() ¶ public

返回

getEventManager() ¶ public

返回

getIterator() ¶ public

返回

has() ¶ public

参数

返回

load() ¶ public

参数

`$_Controller` ¶ protected

`$_eventClass` ¶ protected

`$_eventManager` ¶ protected

`$_loaded` ¶ protected

`$container` ¶ protected