HelperRegistry is used as a registry for loaded helpers and handles loading and constructing helper class objects.
\Cake\View\View
View object to use when making helpers.
string
Default class name for new event objects.
\Cake\Event\EventManagerInterface
Instance of the Cake\Event\EventManager this object is using to dispatch inner events.
object[]
Map of loaded objects.
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
__construct(\Cake\View\View $view)
Constructor
\Cake\View\View
$view View object.
__debugInfo()
Debug friendly object properties.
array
__get(string $name)
Provide public read access to the loaded objects
string
$name Name of property to read
\Cake\View\Helper|null
__isset(string $helper)
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
bool
whether the helper could be loaded or not
Cake\View\Exception\MissingHelperException
__set(string $name, mixed $object)
Sets an object.
string
$name Name of a property to set.
object
$object Object to set.
__unset(string $name)
Unsets an object.
string
$name Name of a property to unset.
_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.
string
$name The name of the alias in the registry.
array
$config The config data for the new instance.
RuntimeException
_create(mixed $class, string $alias, array $config)
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
$config An array of settings to use for the helper.
\Cake\View\Helper
The constructed helper class.
_resolveClassName(string $class)
Resolve a helper classname.
Part of the template method for Cake\Core\ObjectRegistry::load()
string
$class Partial classname to resolve.
string|null
Either the correct class name or null.
_throwMissingClassError(string $class, ?string $plugin)
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|null
$plugin The plugin the helper is missing in.
Cake\View\Exception\MissingHelperException
count()
Returns the number of loaded objects.
int
dispatchEvent(string $name, ?array $data, ?object $subject)
Wrapper for creating and dispatching events.
Returns a dispatched event.
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).
\Cake\Event\EventInterface
get(string $name)
Get loaded object instance.
string
$name Name of object.
object
Object instance.
RuntimeException
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.
\Cake\Event\EventManagerInterface
getIterator()
Returns an array iterator.
\Traversable
has(string $name)
Check whether or not a given object is loaded.
string
$name The object name to check for.
bool
True is object is loaded else false.
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.
string
$objectName The name/class of the object to load.
array
$config optional Additional settings to use when loading the object.
mixed
Exception
loaded()
Get the list of loaded objects.
string[]
List of object names.
normalizeArray(array $objects)
Normalizes an object array, creates an array that makes lazy loading easier
array
$objects Array of child objects to normalize.
array[]
Array of normalized objects.
reset()
Clear loaded instances in the registry.
If the registry subclass has an event manager, the objects will be detached from events as well.
$this
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
string
$objectName The name of the object to set in the registry.
object
$object instance to store in the registry
$this
setEventManager(\Cake\Event\EventManagerInterface $eventManager)
Returns the Cake\Event\EventManagerInterface 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\EventManagerInterface
$eventManager the eventManager to set
$this
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.
string
$objectName The name of the object to remove from the registry.
$this
View object to use when making helpers.
\Cake\View\View
Default class name for new event objects.
string
Instance of the Cake\Event\EventManager this object is using to dispatch inner events.
\Cake\Event\EventManagerInterface
Map of loaded objects.
object[]
© 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/4.1/class-Cake.View.HelperRegistry.html