Acts as a registry/factory for objects.
Provides registry & factory functionality for object types. Used as a super class for various composition based re-use features in CakePHP.
Each subclass needs to implement the various abstract methods to complete the template method load().
The ObjectRegistry is EventManager aware, but each extending class will need to use \Cake\Event\EventDispatcherTrait to attach and detach on set and bind
array<object>Map of loaded objects.
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 an instance of a given classname.
Should resolve the classname for a given object type.
Throw an exception when the requested object name is missing.
Returns the number of loaded objects.
Get loaded object instance.
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.
Remove an object from the registry.
__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): object
Create an instance of a given classname.
This method should construct and do any other initialization logic required.
object|string $class The class to build.
string $alias The alias of the object.
array<string, mixed> $config The Configuration settings for construction
object_resolveClassName(string $class): string|null
Should resolve the classname for a given object type.
string $class The class to resolve.
string|null_throwMissingClassError(string $class, string|null $plugin): void
Throw an exception when the requested object name is missing.
string $class The class that is missing.
string|null $plugin The plugin $class is missing from.
voidExceptioncount(): int
Returns the number of loaded objects.
intget(string $name): object
Get loaded object instance.
string $name Name of object.
objectRuntimeExceptiongetIterator(): 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
$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.
$thisMap 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.Core.ObjectRegistry.html