Fr3nch13/CakePHP Utilities

HelperRegistry extends ObjectRegistry
in package

Application

implements EventDispatcherInterface uses EventDispatcherTrait

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

Interfaces

EventDispatcherInterface: Objects implementing this interface can emit events.

Properties

$_eventClass : string: Default class name for new event objects.
$_eventManager : EventManagerInterface|null: Instance of the Cake\Event\EventManager this object is using to dispatch inner events.
$_loaded : array<string|int, object>: Map of loaded objects.
$_View : View: View object to use when making helpers.

Methods

__construct() : mixed: Constructor
__debugInfo() : array<string, mixed>: Debug friendly object properties.
__get() : Helper|null: Provide public read access to the loaded objects
__isset() : bool: 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
__set() : void: Sets an object.
__unset() : void: Unsets an object.
count() : int: Returns the number of loaded objects.
dispatchEvent() : EventInterface: Wrapper for creating and dispatching events.
get() : object: Get loaded object instance.
getEventManager() : EventManagerInterface: Returns the Cake\Event\EventManager manager instance for this object.
getIterator() : Traversable: Returns an array iterator.
has() : bool: Check whether a given object is loaded.
load() : mixed: Loads/constructs an object instance.
loaded() : array<string|int, string>: Get the list of loaded objects.
normalizeArray() : array<string, array<string|int, mixed>>: Normalizes an object array, creates an array that makes lazy loading easier
reset() : $this: Clear loaded instances in the registry.
set() : $this: Set an object directly into the registry by name.
setEventManager() : $this: Returns the Cake\Event\EventManagerInterface instance for this object.
unload() : $this: Remove an object from the registry.
_checkDuplicate() : void: Check for duplicate object loading.
_create() : Helper: Create the helper instance.
_resolveClassName() : string|null: Resolve a helper classname.
_throwMissingClassError() : void: Throws an exception when a helper is missing.

$_eventClass

Default class name for new event objects.


    protected
        string
    $_eventClass
     = \Cake\Event\Event::class

$_eventManager

Instance of the Cake\Event\EventManager this object is using to dispatch inner events.


    protected
        EventManagerInterface|null
    $_eventManager

$_loaded

Map of loaded objects.


    protected
        array<string|int, object>
    $_loaded
     = []

$_View

View object to use when making helpers.


    protected
        View
    $_View

__construct()

Constructor


    public
                    __construct(View $view) : mixed

Parameters

$view : View: View object.

__debugInfo()

Debug friendly object properties.


    public
                    __debugInfo() : array<string, mixed>

Return values

array<string, mixed>

__get()

Provide public read access to the loaded objects


    public
                    __get(string $name) : Helper|null

Parameters

$name : string: Name of property to read

Return values

Helper|null

__isset()

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


    public
                    __isset(string $helper) : bool

Parameters

$helper : string: The helper name to be loaded

Return values

bool —

whether the helper could be loaded or not

__set()

Sets an object.


    public
                    __set(string $name, object $object) : void

Parameters

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

__unset()

Unsets an object.


    public
                    __unset(string $name) : void

Parameters

$name : string: Name of a property to unset.

count()

Returns the number of loaded objects.


    public
                    count() : int

Return values

int

dispatchEvent()

Wrapper for creating and dispatching events.


    public
                    dispatchEvent(string $name[, array<string|int, mixed>|null $data = null ][, object|null $subject = null ]) : EventInterface

Returns a dispatched event.

Parameters

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

Return values

EventInterface

get()

Get loaded object instance.


    public
                    get(string $name) : object

Parameters

$name : string: Name of object.

Return values

object —

Object instance.

getEventManager()

Returns the Cake\Event\EventManager manager instance for this object.


    public
                    getEventManager() : EventManagerInterface

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.

Return values

EventManagerInterface

getIterator()

Returns an array iterator.


    public
                    getIterator() : Traversable

Return values

Traversable

has()

Check whether a given object is loaded.


    public
                    has(string $name) : bool

Parameters

$name : string: The object name to check for.

Return values

bool —

True is object is loaded else false.

load()

Loads/constructs an object instance.


    public
                    load(string $name[, array<string, mixed> $config = [] ]) : mixed

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 as an example. You can alias an object by setting the 'className' key, i.e.,

protected $components = [
  'Email' => [
    'className' => 'App\Controller\Component\AliasedEmailComponent'
  ];
];

All calls to the Email component would use AliasedEmail instead.

Parameters

$name : string: The name/class of the object to load.
$config : array<string, mixed> = []: Additional settings to use when loading the object.

loaded()

Get the list of loaded objects.


    public
                    loaded() : array<string|int, string>

Return values

array<string|int, string> —

List of object names.

normalizeArray()

Normalizes an object array, creates an array that makes lazy loading easier


    public
                    normalizeArray(array<string|int, mixed> $objects) : array<string, array<string|int, mixed>>

Parameters

$objects : array<string|int, mixed>: Array of child objects to normalize.

Return values

array<string, array<string|int, mixed>> —

Array of normalized objects.

reset()

Clear loaded instances in the registry.


    public
                    reset() : $this

If the registry subclass has an event manager, the objects will be detached from events as well.

Return values

$this

set()

Set an object directly into the registry by name.


    public
                    set(string $name, object $object) : $this

If this collection implements events, the passed object will be attached into the event manager

Parameters

$name : string: The name of the object to set in the registry.
$object : object: instance to store in the registry

Return values

$this

setEventManager()

Returns the Cake\Event\EventManagerInterface instance for this object.


    public
                    setEventManager(EventManagerInterface $eventManager) : $this

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

$eventManager : EventManagerInterface: the eventManager to set

Return values

$this

unload()

Remove an object from the registry.


    public
                    unload(string $name) : $this

If this registry has an event manager, the object will be detached from any events as well.

Parameters

$name : string: The name of the object to remove from the registry.

Return values

$this

_checkDuplicate()

Check for duplicate object loading.


    protected
                    _checkDuplicate(string $name, array<string, mixed> $config) : void

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

$name : string: The name of the alias in the registry.
$config : array<string, mixed>: The config data for the new instance.

_create()

Create the helper instance.


    protected
                    _create(string $class, string $alias, array<string, mixed> $config) : Helper

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

Parameters

$class : string: The class to create.
$alias : string: The alias of the loaded helper.
$config : array<string, mixed>: An array of settings to use for the helper.

Return values

Helper —

The constructed helper class.

_resolveClassName()

Resolve a helper classname.


    protected
                    _resolveClassName(string $class) : string|null

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

Parameters

$class : string: Partial classname to resolve.

Return values

string|null —

Either the correct class name or null.

_throwMissingClassError()

Throws an exception when a helper is missing.


    protected
                    _throwMissingClassError(string $class, string|null $plugin) : void

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

Parameters

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

HelperRegistry extends ObjectRegistry in package Application implements EventDispatcherInterface uses EventDispatcherTrait

Tags

Table of Contents

Interfaces

Properties

Methods

Properties

$_eventClass

$_eventManager

$_loaded

Tags

$_View

Methods

__construct()

Parameters

__debugInfo()

Return values

__get()

Parameters

Return values

__isset()

Parameters

Tags

Return values

__set()

Parameters

Tags

__unset()

Parameters

count()

Return values

dispatchEvent()

Parameters

Return values

get()

Parameters

Tags

Return values

getEventManager()

Return values

getIterator()

Tags

Return values

has()

Parameters

Return values

load()

Parameters

Tags

loaded()

Return values

normalizeArray()

Parameters

Return values

reset()

Return values

set()

Parameters

Tags

Return values

setEventManager()

Parameters

Return values

unload()

Parameters

Tags

Return values

_checkDuplicate()

Parameters

Tags

_create()

Parameters

Tags

Return values

_resolveClassName()

Parameters

Tags

Return values

_throwMissingClassError()

Parameters

HelperRegistry extends ObjectRegistry
in package

Application

implements EventDispatcherInterface uses EventDispatcherTrait