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
object[]Map of loaded objects.
Throw an exception when the requested object name is missing.
__debugInfo()
Debug friendly object properties.
array__get(string $name)
Provide public read access to the loaded objects
string $name Name of property to read
object|null__isset(string $name)
Provide isset access to _loaded
string $name Name of object being checked.
bool__set(string $name, mixed $object)
Sets an object.
string $name Name of a property to set.
object $object Object to set.
__unset(string $name)
Unsets an object.
string $name Name of a property to unset.
_checkDuplicate(string $name, array $config)
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 $config The config data for the new instance.
RuntimeException_create(mixed $class, string $alias, array $config)
Create an instance of a given classname.
This method should construct and do any other initialization logic required.
string|object $class The class to build.
string $alias The alias of the object.
array $config The Configuration settings for construction
object_resolveClassName(string $class)
Should resolve the classname for a given object type.
string $class The class to resolve.
string|nullThe resolved name or null for failure.
_throwMissingClassError(string $class, ?string $plugin)
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.
Exceptioncount()
Returns the number of loaded objects.
intget(string $name)
Get loaded object instance.
string $name Name of object.
objectObject instance.
RuntimeExceptiongetIterator()
Returns an array iterator.
\Traversablehas(string $name)
Check whether or not a given object is loaded.
string $name The object name to check for.
boolTrue is object is loaded else false.
load(string $objectName, array $config)
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 Cake\Controller\Controller::$components as an example. You can alias an object by setting the 'className' key, i.e.,
public $components = [
'Email' => [
'className' => '\App\Controller\Component\AliasedEmailComponent'
];
]; All calls to the Email component would use AliasedEmail instead.
string $objectName The name/class of the object to load.
array $config optional Additional settings to use when loading the object.
mixedExceptionloaded()
Get the list of loaded objects.
string[]List of object names.
normalizeArray(array $objects)
Normalizes an object array, creates an array that makes lazy loading easier
array $objects Array of child objects to normalize.
array[]Array of normalized objects.
reset()
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 $objectName, object $object)
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 $objectName The name of the object to set in the registry.
object $object instance to store in the registry
$thisunload(string $objectName)
Remove an object from the registry.
If this registry has an event manager, the object will be detached from any events as well.
string $objectName The name of the object to remove from the registry.
$thisMap of loaded objects.
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.1/class-Cake.Core.ObjectRegistry.html