-
Notifications
You must be signed in to change notification settings - Fork 3.4k
/
ComponentRegistry.php
126 lines (115 loc) · 4.07 KB
/
ComponentRegistry.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
<?php
declare(strict_types=1);
/**
* CakePHP(tm) : Rapid Development Framework (https://cakephp.org)
* Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
*
* Licensed under The MIT License
* For full copyright and license information, please see the LICENSE.txt
* Redistributions of files must retain the above copyright notice.
*
* @copyright Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
* @link https://cakephp.org CakePHP(tm) Project
* @since 2.0.0
* @license https://opensource.org/licenses/mit-license.php MIT License
*/
namespace Cake\Controller;
use Cake\Controller\Exception\MissingComponentException;
use Cake\Core\App;
use Cake\Core\ObjectRegistry;
use Cake\Event\EventDispatcherInterface;
use Cake\Event\EventDispatcherTrait;
/**
* ComponentRegistry is a registry for loaded components
*
* Handles loading, constructing and binding events for component class objects.
*
* @template TSubject of \Cake\Controller\Controller
* @extends \Cake\Core\ObjectRegistry<\Cake\Controller\Component>
* @implements \Cake\Event\EventDispatcherInterface<TSubject>
*/
class ComponentRegistry extends ObjectRegistry implements EventDispatcherInterface
{
/**
* @use \Cake\Event\EventDispatcherTrait<TSubject>
*/
use EventDispatcherTrait;
/**
* The controller that this collection is associated with.
*
* @var \Cake\Controller\Controller
*/
protected Controller $_Controller;
/**
* Constructor.
*
* @param \Cake\Controller\Controller $controller Controller instance.
*/
public function __construct(Controller $controller)
{
$this->_Controller = $controller;
$this->setEventManager($controller->getEventManager());
}
/**
* Get the controller associated with the collection.
*
* @return \Cake\Controller\Controller Controller instance.
*/
public function getController(): Controller
{
return $this->_Controller;
}
/**
* Resolve a component classname.
*
* Part of the template method for {@link \Cake\Core\ObjectRegistry::load()}.
*
* @param string $class Partial classname to resolve.
* @return class-string<\Cake\Controller\Component>|null Either the correct class name or null.
*/
protected function _resolveClassName(string $class): ?string
{
/** @var class-string<\Cake\Controller\Component>|null */
return App::className($class, 'Controller/Component', 'Component');
}
/**
* Throws an exception when a component is missing.
*
* Part of the template method for {@link \Cake\Core\ObjectRegistry::load()}
* and {@link \Cake\Core\ObjectRegistry::unload()}
*
* @param string $class The classname that is missing.
* @param string|null $plugin The plugin the component is missing in.
* @return void
* @throws \Cake\Controller\Exception\MissingComponentException
*/
protected function _throwMissingClassError(string $class, ?string $plugin): void
{
throw new MissingComponentException([
'class' => $class . 'Component',
'plugin' => $plugin,
]);
}
/**
* Create the component instance.
*
* Part of the template method for {@link \Cake\Core\ObjectRegistry::load()}
* Enabled components will be registered with the event manager.
*
* @param \Cake\Controller\Component|class-string<\Cake\Controller\Component> $class The classname to create.
* @param string $alias The alias of the component.
* @param array<string, mixed> $config An array of config to use for the component.
* @return \Cake\Controller\Component The constructed component class.
*/
protected function _create(object|string $class, string $alias, array $config): Component
{
if (is_object($class)) {
return $class;
}
$instance = new $class($this, $config);
if ($config['enabled'] ?? true) {
$this->getEventManager()->on($instance);
}
return $instance;
}
}