Class ObjectRegistry

__debugInfosource public

__debugInfo( )

Debug friendly object properties.

Returns

__getsource public

__get( string $name )

Provide public read access to the loaded objects

Parameters

string $name

Name of property to read

Returns

__issetsource public

__isset( string $name )

Provide isset access to _loaded

Parameters

string $name

Name of object being checked.

Returns

_checkDuplicatesource 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

_createsource 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

_resolveClassNamesource abstract protected

_resolveClassName( string $class )

Should resolve the classname for a given object type.

Parameters

string $class

The class to resolve.

Returns

_throwMissingClassErrorsource 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

getsource public

get( string $name )

Get loaded object instance.

Parameters

string $name

Name of object.

Returns

hassource public

has( string $name )

Check whether or not a given object is loaded.

Parameters

string $name

The object name to check for.

Returns

loadsource 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

loadedsource public

loaded( )

Get the list of loaded objects.

Returns

normalizeArraysource 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

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

setsource 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

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