W3cubDocs

/CakePHP 3.8

Class HelperRegistry

HelperRegistry is used as a registry for loaded helpers and handles loading and constructing helper class objects.

Cake\Core\ObjectRegistry implements Countable, IteratorAggregate
Extended by Cake\View\HelperRegistry implements Cake\Event\EventDispatcherInterface uses Cake\Event\EventDispatcherTrait
Namespace: Cake\View
Location: View/HelperRegistry.php

Properties summary

Inherited Properties

Method Summary

  • __construct() public
    Constructor
  • __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

  • _create() protected
    Create the helper instance.
  • Resolve a helper classname.
  • Throws an exception when a helper is missing.

Method Detail

__construct()source public

__construct( Cake\View\View $view )

Constructor

Parameters

Cake\View\View $view
View object.

__get()source public

__get( string $name )

Provide public read access to the loaded objects

Parameters

string $name
Name of property to read

Returns

mixed

Overrides

Cake\Core\ObjectRegistry::__get()

__isset()source public

__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

Parameters

string $helper
The helper name to be loaded

Returns

boolean
whether the helper could be loaded or not

Throws

Cake\View\Exception\MissingHelperException

When a helper could not be found. App helpers are searched, and then plugin helpers.


Overrides

Cake\Core\ObjectRegistry::__isset()

_create()source protected

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

Create 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\View\Helper
The constructed helper class.

_resolveClassName()source protected

_resolveClassName( string $class )

Resolve a helper 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()source protected

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

Parameters

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

Throws

Cake\View\Exception\MissingHelperException

Methods inherited from Cake\Core\ObjectRegistry

__debugInfo()source public

__debugInfo( )

Debug friendly object properties.

Returns

array

__set()source public

__set( string $name , mixed $object )

Sets an object.

Parameters

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

__unset()source public

__unset( string $name )

Unsets an object.

Parameters

string $name
Name of a property to unset.

_checkDuplicate()source 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()source public

count( )

Returns the number of loaded objects.

Returns

integer

Implementation of

Countable::count()

get()source public

get( string $name )

Get loaded object instance.

Parameters

string $name
Name of object.

Returns

object|null
Object instance if loaded else null.

getIterator()source public

getIterator( )

Returns an array iterator.

Returns

ArrayIterator

Implementation of

IteratorAggregate::getIterator()

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

loaded( )

Get the list of loaded objects.

Returns

string[]
List of object names.

normalizeArray()source 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()source 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()source 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()source 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()source 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()source public deprecated

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

$_Viewsource

protected Cake\View\View

View object to use when making helpers.

© 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/3.8/class-Cake.View.HelperRegistry.html