Class ComponentRegistry

ComponentRegistry is a registry for loaded components

Handles loading, constructing and binding events for component class objects.

Cake\Core\ObjectRegistry implements Countable, IteratorAggregate

Cake\Controller\ComponentRegistry implements Cake\Event\EventDispatcherInterface uses Cake\Event\EventDispatcherTrait

Namespace: Cake\Controller
Location: Controller/ComponentRegistry.php

Properties summary

$_Controller protected

Cake\Controller\Controller

The controller that this collection was initialized with.

Inherited Properties

_loaded _eventClass, _eventManager

Method Summary

__construct() public

Constructor.
_create() protected

Create the component instance.
_resolveClassName() protected

Resolve a component classname.
_throwMissingClassError() protected

Throws an exception when a component is missing.
getController() public

Get the controller associated with the collection.
setController() public

Set the controller associated with the collection.

Method Detail

__construct() public ¶

__construct( Cake\Controller\Controller $controller null )

Constructor.

Parameters

Cake\Controller\Controller $controller optional null: Controller instance.

_create() protected ¶

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

Create the component instance.

Part of the template method for Cake\Core\ObjectRegistry::load() Enabled components will be registered with the event manager.

Parameters

string $class: The classname to create.
string $alias: The alias of the component.
array $config: An array of config to use for the component.

Returns

Cake\Controller\Component
The constructed component class.

_resolveClassName() protected ¶

_resolveClassName( string $class )

Resolve a component classname.

Part of the template method for Cake\Core\ObjectRegistry::load()

Parameters

string $class: Partial classname to resolve.

Returns

string|false
Either the correct classname or false.

_throwMissingClassError() protected ¶

_throwMissingClassError( string $class , string $plugin )

Throws an exception when a component is missing.

Part of the template method for Cake\Core\ObjectRegistry::load() and Cake\Core\ObjectRegistry::unload()

Parameters

string $class: The classname that is missing.
string $plugin: The plugin the component is missing in.

Throws

Cake\Controller\Exception\MissingComponentException

getController() public ¶

getController( )

Get the controller associated with the collection.

Returns

Cake\Controller\Controller
Controller instance

setController() public ¶

setController( Cake\Controller\Controller $controller )

Set the controller associated with the collection.

Parameters

Cake\Controller\Controller $controller: Controller instance.

Methods inherited from Cake\Core\ObjectRegistry

__debugInfo() public ¶

__debugInfo( )

Debug friendly object properties.

Returns

array

__get() public ¶

__get( string $name )

Provide public read access to the loaded objects

Parameters

string $name: Name of property to read

Returns

mixed

__isset() public ¶

__isset( string $name )

Provide isset access to _loaded

Parameters

string $name: Name of object being checked.

Returns

boolean

__set() public ¶

__set( string $name , mixed $object )

Sets an object.

Parameters

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

__unset() public ¶

__unset( string $name )

Unsets an object.

Parameters

string $name: Name of a property to unset.

_checkDuplicate() 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.

count() public ¶

count( )

Returns the number of loaded objects.

Returns

integer

Implementation of

Countable::count()

get() public ¶

get( string $name )

Get loaded object instance.

Parameters

string $name: Name of object.

Returns

object|null
Object instance if loaded else null.

getIterator() public ¶

getIterator( )

Returns an array iterator.

Returns

ArrayIterator

Implementation of

IteratorAggregate::getIterator()

has() 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() 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() public ¶

loaded( )

Get the list of loaded objects.

Returns

string[]
List of object names.

normalizeArray() 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() 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() 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() 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

Methods used from Cake\Event\EventDispatcherTrait

dispatchEvent() public ¶

dispatchEvent( string $name , array|null $data null , object|null $subject null )

Wrapper for creating and dispatching events.

Returns a dispatched event.

Parameters

string $name: Name of the event.
array|null $data optional null: Any value you wish to be transported with this event to it can be read by listeners.
object|null $subject optional null: The object that this event applies to ($this by default).

Returns

Cake\Event\Event

eventManager() public ¶

eventManager( Cake\Event\EventManager $eventManager null )

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.

Deprecated

3.5.0 Use getEventManager()/setEventManager() instead.

Parameters

Cake\Event\EventManager $eventManager optional null: the eventManager to set

Returns

Cake\Event\EventManager

getEventManager() public ¶

getEventManager( )

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.

Returns

Cake\Event\EventManager

setEventManager() public ¶

setEventManager( Cake\Event\EventManager $eventManager )

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.

Parameters

Cake\Event\EventManager $eventManager: the eventManager to set

Returns

$this

Magic methods inherited from Cake\Event\EventDispatcherInterface


				getEventManager()

Properties detail

`$_Controller` ¶

protected Cake\Controller\Controller

The controller that this collection was initialized with.

Namespaces

Classes

Class ComponentRegistry

Properties summary

Inherited Properties

Method Summary

__construct() public

_create() protected

_resolveClassName() protected

_throwMissingClassError() protected

getController() public

setController() public

Method Detail

__construct() public ¶

Parameters

_create() protected ¶

Parameters

Returns

_resolveClassName() protected ¶

Parameters

Returns

_throwMissingClassError() protected ¶

Parameters

Throws

getController() public ¶

Returns

setController() public ¶

Parameters

Methods inherited from Cake\Core\ObjectRegistry

__debugInfo() public ¶

Returns

__get() public ¶

Parameters

Returns

__isset() public ¶

Parameters

Returns

__set() public ¶

Parameters

__unset() public ¶

Parameters

_checkDuplicate() protected ¶

Parameters

Throws

count() public ¶

Returns

Implementation of

get() public ¶

Parameters

Returns

getIterator() public ¶

Returns

Implementation of

has() public ¶

Parameters

Returns

load() public ¶

Parameters

Returns

Throws

loaded() public ¶

Returns

normalizeArray() public ¶

Parameters

Returns

reset() public ¶

Returns

set() public ¶

Parameters

Returns

unload() public ¶

Parameters

Returns

Methods used from Cake\Event\EventDispatcherTrait

dispatchEvent() public ¶

Parameters

Returns

eventManager() public ¶

Deprecated

Parameters

`$_Controller` ¶