Class HelperRegistry
HelperRegistry is used as a registry for loaded helpers and handles loading and constructing helper class objects.
Property Summary
-
$_View protected
Cake\View\ViewView object to use when making helpers.
-
$_eventClass protected
stringDefault class name for new event objects.
-
$_eventManager protected
Cake\Event\EventManagerInstance of the Cake\Event\EventManager this object is using to dispatch inner events.
-
$_loaded protected
object[]Map of loaded objects.
Method Summary
-
__construct() public
Constructor
-
__debugInfo() public
Debug friendly object properties.
-
__get() public
Provide public read access to the loaded objects
-
__isset() public
Tries to lazy load a helper based on its name, if it cannot be found in the application folder, then it tries looking under the current plugin if any
-
_checkDuplicate() protected
Check for duplicate object loading.
-
_create() protected
Create the helper instance.
-
_resolveClassName() protected
Resolve a helper classname.
-
_throwMissingClassError() protected
Throws an exception when a helper is missing.
-
dispatchEvent() public
Wrapper for creating and dispatching events.
-
eventManager() public
Returns the Cake\Event\EventManager manager instance for this object.
-
get() public
Get loaded object instance.
-
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.
-
normalizeArray() public
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
__construct() ¶ public
__construct(Cake\View\View $view)Constructor
Parameters
-
Cake\View\View$view View object.
__get() ¶ public
__get(string $name): mixedProvide public read access to the loaded objects
Parameters
-
string$name Name of property to read
Returns
mixed__isset() ¶ public
__isset(string $helper): boolTries to lazy load a helper based on its name, if it cannot be found in the application folder, then it tries looking under the current plugin if any
Parameters
-
string$helper The helper name to be loaded
Returns
boolwhether the helper could be loaded or not
Throws
Cake\View\Exception\MissingHelperExceptionWhen a helper could not be found. App helpers are searched, and then plugin helpers.
_checkDuplicate() ¶ protected
_checkDuplicate(string $name, array $config): voidCheck 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.
Returns
voidThrows
RuntimeExceptionWhen a duplicate is found.
_create() ¶ protected
_create(string $class, string $alias, array $settings): Cake\Controller\ComponentCreate the helper instance.
Part of the template method for Cake\Core\ObjectRegistry::load() Enabled helpers will be registered with the event manager.
Parameters
-
string$class The class to create.
-
string$alias The alias of the loaded helper.
-
array$settings An array of settings to use for the helper.
Returns
Cake\Controller\ComponentThe constructed helper class.
_resolveClassName() ¶ protected
_resolveClassName(string $class): string|falseResolve a helper classname.
Part of the template method for Cake\Core\ObjectRegistry::load()
Parameters
-
string$class Partial classname to resolve.
Returns
string|falseEither the correct classname or false.
_throwMissingClassError() ¶ protected
_throwMissingClassError(string $class, string $plugin): voidThrows an exception when a helper is missing.
Part of the template method for Cake\Core\ObjectRegistry::load()
Parameters
-
string$class The classname that is missing.
-
string$plugin The plugin the helper is missing in.
Returns
voidThrows
Cake\View\Exception\MissingHelperExceptiondispatchEvent() ¶ public
dispatchEvent(string $name, array|null $data = null, object|null $subject = null): Cake\Event\EventWrapper for creating and dispatching events.
Returns a dispatched event.
Parameters
-
string$name Name of the event.
-
array|null$data optional Any value you wish to be transported with this event to it can be read by listeners.
-
object|null$subject optional The object that this event applies to ($this by default).
Returns
Cake\Event\EventeventManager() ¶ public
eventManager(Cake\Event\EventManager|null $eventManager = null): Cake\Event\EventManagerReturns 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|null$eventManager optional the eventManager to set
Returns
Cake\Event\EventManagerget() ¶ public
get(string $name): object|nullGet loaded object instance.
Parameters
-
string$name Name of object.
Returns
object|nullObject instance if loaded else null.
has() ¶ public
has(string $name): boolCheck whether or not a given object is loaded.
Parameters
-
string$name The object name to check for.
Returns
boolTrue is object is loaded else false.
load() ¶ public
load(string $objectName, array $config = []): mixedLoads/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
mixedloaded() ¶ public
loaded(): arrayGet the list of loaded objects.
Returns
arrayList of object names.
normalizeArray() ¶ public
normalizeArray(array $objects): arrayNormalizes an object array, creates an array that makes lazy loading easier
Parameters
-
array$objects Array of child objects to normalize.
Returns
arrayArray of normalized objects.
reset() ¶ public
reset(): voidClear loaded instances in the registry.
If the registry subclass has an event manager, the objects will be detached from events as well.
Returns
voidset() ¶ public
set(string $objectName, object $object): voidSet 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
voidunload() ¶ public
unload(string $objectName): voidRemove 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
voidProperty Detail
$_eventManager ¶ protected
Instance of the Cake\Event\EventManager this object is using to dispatch inner events.
Type
Cake\Event\EventManager