W3cubDocs

/CakePHP 3.8

Class ObjectRegistry

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

Cake\Core\ObjectRegistry implements Countable, IteratorAggregate

Direct Subclasses

Properties summary

  • $_loaded protected
    object[]
    Map of loaded objects.

Method Summary

  • __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() abstract protected
    Create an instance of a given classname.
  • _resolveClassName() abstract protected
    Should resolve the classname for a given object type.
  • _throwMissingClassError() abstract protected
    Throw an exception when the requested object name is missing.
  • count() public
    Returns the number of loaded objects.
  • get() public
    Get loaded object instance.
  • getIterator() public
    Returns an array iterator.
  • has() public
    Check whether or not a given object is loaded.
  • load() public
    Loads/constructs an object instance.
  • loaded() public
    Get the list of loaded objects.
  • 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.
  • unload() public
    Remove an object from the registry.

Method Detail

__debugInfo()source public

__debugInfo( )

Debug friendly object properties.

Returns

array

__get()source public

__get( string $name )

Provide public read access to the loaded objects

Parameters

string $name
Name of property to read

Returns

mixed

__isset()source public

__isset( string $name )

Provide isset access to _loaded

Parameters

string $name
Name of object being checked.

Returns

boolean

__set()source public

__set( string $name , mixed $object )

Sets an object.

Parameters

string $name
Name of a property to set.
mixed $object
Object to set.

__unset()source public

__unset( string $name )

Unsets an object.

Parameters

string $name
Name of a property to unset.

_checkDuplicate()source protected

_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.

Parameters

string $name
The name of the alias in the registry.
array $config
The config data for the new instance.

Throws

RuntimeException
When a duplicate is found.

_create()source abstract protected

_create( string $class , string $alias , array $config )

Create an instance of a given classname.

This method should construct and do any other initialization logic required.

Parameters

string $class
The class to build.
string $alias
The alias of the object.
array $config
The Configuration settings for construction

Returns

mixed

_resolveClassName()source abstract protected

_resolveClassName( string $class )

Should resolve the classname for a given object type.

Parameters

string $class
The class to resolve.

Returns

string|boolean
The resolved name or false for failure.

_throwMissingClassError()source abstract protected

_throwMissingClassError( string $class , string $plugin )

Throw an exception when the requested object name is missing.

Parameters

string $class
The class that is missing.
string $plugin
The plugin $class is missing from.

Throws

Exception

count()source public

count( )

Returns the number of loaded objects.

Returns

integer

Implementation of

Countable::count()

get()source public

get( string $name )

Get loaded object instance.

Parameters

string $name
Name of object.

Returns

object|null
Object instance if loaded else null.

getIterator()source public

getIterator( )

Returns an array iterator.

Returns

ArrayIterator

Implementation of

IteratorAggregate::getIterator()

has()source public

has( string $name )

Check whether or not a given object is loaded.

Parameters

string $name
The object name to check for.

Returns

boolean
True is object is loaded else false.

load()source public

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.

Parameters

string $objectName
The name/class of the object to load.
array $config optional []
Additional settings to use when loading the object.

Returns

mixed

Throws

Exception
If the class cannot be found.

loaded()source public

loaded( )

Get the list of loaded objects.

Returns

string[]
List of object names.

normalizeArray()source public

normalizeArray( array $objects )

Normalizes an object array, creates an array that makes lazy loading easier

Parameters

array $objects
Array of child objects to normalize.

Returns

array
Array of normalized objects.

reset()source public

reset( )

Clear loaded instances in the registry.

If the registry subclass has an event manager, the objects will be detached from events as well.

Returns


$this

set()source public

set( 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

Parameters

string $objectName
The name of the object to set in the registry.
object $object
instance to store in the registry

Returns


$this

unload()source public

unload( 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.

Parameters

string $objectName
The name of the object to remove from the registry.

Returns


$this

Properties detail

$_loadedsource

protected object[]

Map of loaded objects.

[]

© 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/3.8/class-Cake.Core.ObjectRegistry.html