$_eventManager
$_eventManager : \Cake\Event\EventManagerInterface|\Cake\Event\EventManager
Instance of the Cake\Event\EventManager this object is using to dispatch inner events.
HelperRegistry is used as a registry for loaded helpers and handles loading and constructing helper class 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
$_eventManager : \Cake\Event\EventManagerInterface|\Cake\Event\EventManager
Instance of the Cake\Event\EventManager this object is using to dispatch inner events.
$_View : \Cake\View\View
View object to use when making helpers.
eventManager(\Cake\Event\EventManager|null $eventManager = null) : \Cake\Event\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.
| \Cake\Event\EventManager|null | $eventManager | the eventManager to set |
getEventManager() : \Cake\Event\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.
setEventManager(\Cake\Event\EventManager $eventManager) : $this
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.
| \Cake\Event\EventManager | $eventManager | the eventManager to set |
dispatchEvent(string $name, array|null $data = null, object|null $subject = null) : \Cake\Event\Event
Wrapper for creating and dispatching events.
Returns a dispatched event.
| string | $name | Name of the event. |
| array|null | $data | Any value you wish to be transported with this event to it can be read by listeners. |
| object|null | $subject | The object that this event applies to ($this by default). |
load(string $objectName, array $config = array()) : mixed
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 | Additional settings to use when loading the object. |
If the class cannot be found.
__isset(string $helper) : boolean
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
| string | $helper | The helper name to be loaded |
When a helper could not be found. App helpers are searched, and then plugin helpers.
whether the helper could be loaded or not
set(string $objectName, object $object) : $this
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 |
__construct(\Cake\View\View $view)
Constructor
| \Cake\View\View | $view | View object. |
_checkDuplicate(string $name, array $config) : void
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. |
When a duplicate is found.
_throwMissingClassError(string $class, string $plugin) : void
Throws an exception when a helper is missing.
Part of the template method for Cake\Core\ObjectRegistry::load() and Cake\Core\ObjectRegistry::unload()
| string | $class | The classname that is missing. |
| string | $plugin | The plugin the helper is missing in. |
_create(string $class, string $alias, array $settings) : \Cake\View\Helper
Create the helper instance.
Part of the template method for Cake\Core\ObjectRegistry::load() Enabled helpers will be registered with the event manager.
| 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. |
The constructed helper class.