ComponentRegistry is a registry for loaded components
Handles loading, constructing and binding events for component class objects.
Cake\Controller\Controller|nullThe controller that this collection was initialized with.
stringDefault class name for new event objects.
Cake\Event\EventManagerInterface|nullInstance of the Cake\Event\EventManager this object is using to dispatch inner events.
array<object>Map of loaded objects.
Constructor.
Debug friendly object properties.
Provide public read access to the loaded objects
Provide isset access to _loaded
Sets an object.
Unsets an object.
Check for duplicate object loading.
Create the component instance.
Resolve a component classname.
Throws an exception when a component is missing.
Returns the number of loaded objects.
Wrapper for creating and dispatching events.
Get loaded object instance.
Get the controller associated with the collection.
Returns the Cake\Event\EventManager manager instance for this object.
Returns an array iterator.
Check whether a given object is loaded.
Loads/constructs an object instance.
Get the list of loaded objects.
Normalizes an object array, creates an array that makes lazy loading easier
Clear loaded instances in the registry.
Set an object directly into the registry by name.
Set the controller associated with the collection.
Returns the Cake\Event\EventManagerInterface instance for this object.
Remove an object from the registry.
__construct(Cake\Controller\Controller|null $controller = null)
Constructor.
Cake\Controller\Controller|null $controller optional Controller instance.
__debugInfo(): array<string, mixed>
Debug friendly object properties.
array<string, mixed>__get(string $name): object|null
Provide public read access to the loaded objects
string $name Name of property to read
object|null__isset(string $name): bool
Provide isset access to _loaded
string $name Name of object being checked.
bool__set(string $name, object $object): void
Sets an object.
string $name Name of a property to set.
object $object Object to set.
void__unset(string $name): void
Unsets an object.
string $name Name of a property to unset.
void_checkDuplicate(string $name, array<string, mixed> $config): void
Check 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.
string $name The name of the alias in the registry.
array<string, mixed> $config The config data for the new instance.
voidRuntimeException_create(object|string $class, string $alias, array<string, mixed> $config): Cake\Controller\Component
Create the component instance.
Part of the template method for {@link \Cake\Core\ObjectRegistry::load()} Enabled components will be registered with the event manager.
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.
Cake\Controller\Component_resolveClassName(string $class): string|null
Resolve a component classname.
Part of the template method for {@link \Cake\Core\ObjectRegistry::load()}.
string $class Partial classname to resolve.
string|null_throwMissingClassError(string $class, string|null $plugin): void
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()}
string $class The classname that is missing.
string|null $plugin The plugin the component is missing in.
voidCake\Controller\Exception\MissingComponentExceptioncount(): int
Returns the number of loaded objects.
intdispatchEvent(string $name, array|null $data = null, object|null $subject = null): Cake\Event\EventInterface
Wrapper for creating and dispatching events.
Returns a dispatched event.
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).
Cake\Event\EventInterfaceget(string $name): object
Get loaded object instance.
string $name Name of object.
objectRuntimeExceptiongetController(): Cake\Controller\Controller
Get the controller associated with the collection.
Cake\Controller\ControllergetEventManager(): Cake\Event\EventManagerInterface
Returns 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.
Cake\Event\EventManagerInterfacegetIterator(): Traversable
Returns an array iterator.
Traversablehas(string $name): bool
Check whether a given object is loaded.
string $name The object name to check for.
boolload(string $name, array<string, mixed> $config = []): mixed
Loads/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.
string $name The name/class of the object to load.
array<string, mixed> $config optional Additional settings to use when loading the object.
mixedExceptionloaded(): array<string>
Get the list of loaded objects.
array<string>normalizeArray(array $objects): array<string, array>
Normalizes an object array, creates an array that makes lazy loading easier
array $objects Array of child objects to normalize.
array<string, array>reset(): $this
Clear loaded instances in the registry.
If the registry subclass has an event manager, the objects will be detached from events as well.
$thisset(string $name, object $object): $this
Set an object directly into the registry by name.
If this collection implements events, the passed object will be attached into the event manager
string $name The name of the object to set in the registry.
object $object instance to store in the registry
$thissetController(Cake\Controller\Controller $controller): $this
Set the controller associated with the collection.
Cake\Controller\Controller $controller Controller instance.
$thissetEventManager(Cake\Event\EventManagerInterface $eventManager): $this
Returns 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.
Cake\Event\EventManagerInterface $eventManager the eventManager to set
$thisunload(string $name): $this
Remove an object from the registry.
If this registry has an event manager, the object will be detached from any events as well.
string $name The name of the object to remove from the registry.
$thisThe controller that this collection was initialized with.
Cake\Controller\Controller|nullDefault class name for new event objects.
stringInstance of the Cake\Event\EventManager this object is using to dispatch inner events.
Cake\Event\EventManagerInterface|nullMap of loaded objects.
array<object>
© 2005–present The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/4.4/class-Cake.Controller.ComponentRegistry.html