Class ComponentRegistry
ComponentRegistry is a registry for loaded components
Handles loading, constructing and binding events for component class objects.
Property Summary
-
$_Controller protected
Cake\Controller\Controller|nullThe controller that this collection was initialized with.
-
$_eventClass protected
stringDefault class name for new event objects.
-
$_eventManager protected
Cake\Event\EventManagerInterface|nullInstance of the Cake\Event\EventManager this object is using to dispatch inner events.
-
$_loaded protected
array<object>Map of loaded objects.
Method Summary
-
__construct() public
Constructor.
-
__debugInfo() public
Debug friendly object properties.
-
__get() public
Provide public read access to the loaded objects
-
__isset() public
Provide isset access to _loaded
-
__set() public
Sets an object.
-
__unset() public
Unsets an object.
-
_checkDuplicate() protected
Check for duplicate object loading.
-
_create() protected
Create the component instance.
-
_resolveClassName() protected
Resolve a component classname.
-
_throwMissingClassError() protected
Throws an exception when a component is missing.
-
count() public
Returns the number of loaded objects.
-
dispatchEvent() public
Wrapper for creating and dispatching events.
-
get() public
Get loaded object instance.
-
getController() public
Get the controller associated with the collection.
-
getEventManager() public
Returns the Cake\Event\EventManager manager instance for this object.
-
getIterator() public
Returns an array iterator.
-
has() public
Check whether a given object is loaded.
-
load() public
Loads/constructs an object instance.
-
loaded() public
Get the list of loaded objects.
-
normalizeArray() public
Normalizes an object array, creates an array that makes lazy loading easier
-
reset() public
Clear loaded instances in the registry.
-
set() public
Set an object directly into the registry by name.
-
setController() public
Set the controller associated with the collection.
-
setEventManager() public
Returns the Cake\Event\EventManagerInterface instance for this object.
-
unload() public
Remove an object from the registry.
Method Detail
__construct() ¶ public
__construct(Cake\Controller\Controller|null $controller = null)Constructor.
Parameters
-
Cake\Controller\Controller|null$controller optional Controller instance.
__debugInfo() ¶ public
__debugInfo(): array<string, mixed>Debug friendly object properties.
Returns
array<string, mixed>__get() ¶ public
__get(string $name): object|nullProvide public read access to the loaded objects
Parameters
-
string$name Name of property to read
Returns
object|null__isset() ¶ public
__isset(string $name): boolProvide isset access to _loaded
Parameters
-
string$name Name of object being checked.
Returns
bool__set() ¶ public
__set(string $name, object $object): voidSets an object.
Parameters
-
string$name Name of a property to set.
-
object$object Object to set.
Returns
void__unset() ¶ public
__unset(string $name): voidUnsets an object.
Parameters
-
string$name Name of a property to unset.
Returns
void_checkDuplicate() ¶ protected
_checkDuplicate(string $name, array<string, mixed> $config): voidCheck for duplicate object loading.
If a duplicate is being loaded and has different configuration, that is bad and an exception will be raised.
An exception is raised, as replacing the object will not update any references other objects may have. Additionally, simply updating the runtime configuration is not a good option as we may be missing important constructor logic dependent on the configuration.
Parameters
-
string$name The name of the alias in the registry.
-
array<string, mixed>$config The config data for the new instance.
Returns
voidThrows
RuntimeExceptionWhen a duplicate is found.
_create() ¶ protected
_create(object|string $class, string $alias, array<string, mixed> $config): Cake\Controller\ComponentCreate the component instance.
Part of the template method for {@link \Cake\Core\ObjectRegistry::load()} Enabled components will be registered with the event manager.
Parameters
-
object|string$class The classname to create.
-
string$alias The alias of the component.
-
array<string, mixed>$config An array of config to use for the component.
Returns
Cake\Controller\ComponentThe constructed component class.
_resolveClassName() ¶ protected
_resolveClassName(string $class): string|nullResolve a component classname.
Part of the template method for {@link \Cake\Core\ObjectRegistry::load()}.
Parameters
-
string$class Partial classname to resolve.
Returns
string|nullEither the correct class name or null.
_throwMissingClassError() ¶ protected
_throwMissingClassError(string $class, string|null $plugin): voidThrows an exception when a component is missing.
Part of the template method for {@link \Cake\Core\ObjectRegistry::load()} and {@link \Cake\Core\ObjectRegistry::unload()}
Parameters
-
string$class The classname that is missing.
-
string|null$plugin The plugin the component is missing in.
Returns
voidThrows
Cake\Controller\Exception\MissingComponentExceptiondispatchEvent() ¶ public
dispatchEvent(string $name, array|null $data = null, object|null $subject = null): Cake\Event\EventInterfaceWrapper for creating and dispatching events.
Returns a dispatched event.
Parameters
-
string$name Name of the event.
-
array|null$data optional Any value you wish to be transported with this event to it can be read by listeners.
-
object|null$subject optional The object that this event applies to ($this by default).
Returns
Cake\Event\EventInterfaceget() ¶ public
get(string $name): objectGet loaded object instance.
Parameters
-
string$name Name of object.
Returns
objectObject instance.
Throws
RuntimeExceptionIf not loaded or found.
getController() ¶ public
getController(): Cake\Controller\ControllerGet the controller associated with the collection.
Returns
Cake\Controller\ControllerController instance or null if not set.
getEventManager() ¶ public
getEventManager(): Cake\Event\EventManagerInterfaceReturns the Cake\Event\EventManager manager instance for this object.
You can use this instance to register any new listeners or callbacks to the object events, or create your own events and trigger them at will.
Returns
Cake\Event\EventManagerInterfacehas() ¶ public
has(string $name): boolCheck whether a given object is loaded.
Parameters
-
string$name The object name to check for.
Returns
boolTrue is object is loaded else false.
load() ¶ public
load(string $name, array<string, mixed> $config = []): mixedLoads/constructs an object instance.
Will return the instance in the registry if it already exists.
If a subclass provides event support, you can use $config['enabled'] = false
to exclude constructed objects from being registered for events.
Using {@link \Cake\Controller\Component::$components} as an example. You can alias an object by setting the 'className' key, i.e.,
protected $components = [
'Email' => [
'className' => 'App\Controller\Component\AliasedEmailComponent'
];
];All calls to the Email component would use AliasedEmail instead.
Parameters
-
string$name The name/class of the object to load.
-
array<string, mixed>$config optional Additional settings to use when loading the object.
Returns
mixedThrows
ExceptionIf the class cannot be found.
loaded() ¶ public
loaded(): array<string>Get the list of loaded objects.
Returns
array<string>List of object names.
normalizeArray() ¶ public
normalizeArray(array $objects): array<string, array>Normalizes an object array, creates an array that makes lazy loading easier
Parameters
-
array$objects Array of child objects to normalize.
Returns
array<string, array>Array of normalized objects.
reset() ¶ public
reset(): $thisClear loaded instances in the registry.
If the registry subclass has an event manager, the objects will be detached from events as well.
Returns
$thisset() ¶ public
set(string $name, object $object): $thisSet an object directly into the registry by name.
If this collection implements events, the passed object will be attached into the event manager
Parameters
-
string$name The name of the object to set in the registry.
-
object$object instance to store in the registry
Returns
$thissetController() ¶ public
setController(Cake\Controller\Controller $controller): $thisSet the controller associated with the collection.
Parameters
-
Cake\Controller\Controller$controller Controller instance.
Returns
$thissetEventManager() ¶ public
setEventManager(Cake\Event\EventManagerInterface $eventManager): $thisReturns the Cake\Event\EventManagerInterface instance for this object.
You can use this instance to register any new listeners or callbacks to the object events, or create your own events and trigger them at will.
Parameters
-
Cake\Event\EventManagerInterface$eventManager the eventManager to set
Returns
$thisunload() ¶ public
unload(string $name): $thisRemove an object from the registry.
If this registry has an event manager, the object will be detached from any events as well.
Parameters
-
string$name The name of the object to remove from the registry.
Returns
$this