Class HelperRegistry
Registry for Helpers. Provides features for lazily loading helpers.
Property Summary
Method Summary
-
__debugInfo() public
Debug friendly object properties.
-
__get() public
Provide public read access to the loaded objects
-
__isset() public
Provide isset access to _loaded
-
__set() public
Sets an object.
-
__unset() public
Unsets an object.
-
_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.
-
count() public
Returns the number of loaded objects.
-
get() public
Get loaded object instance.
-
getIterator() public
Returns an array iterator.
-
has() public
Check whether 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 configuration array into associative form for making lazy loading easier.
-
reset() public
Clear loaded instances in the registry.
-
set() public
Set an object directly into the registry by name.
-
setIo() public
Sets The IO instance that should be passed to the shell helpers
-
unload() public
Remove an object from the registry.
Method Detail
__debugInfo() ¶ public
__debugInfo(): array<string, mixed>Debug friendly object properties.
Returns
array<string, mixed>__get() ¶ public
__get(string $name): object|nullProvide public read access to the loaded objects
Parameters
-
string$name Name of property to read
Returns
object|null__isset() ¶ public
__isset(string $name): boolProvide isset access to _loaded
Parameters
-
string$name Name of object being checked.
Returns
bool__set() ¶ public
__set(string $name, object $object): voidSets an object.
Parameters
-
string$name Name of a property to set.
-
object$object Object to set.
Returns
void__unset() ¶ public
__unset(string $name): voidUnsets an object.
Parameters
-
string$name Name of a property to unset.
Returns
void_checkDuplicate() ¶ protected
_checkDuplicate(string $name, array<string, mixed> $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<string, mixed>$config The config data for the new instance.
Returns
voidThrows
Cake\Core\Exception\CakeExceptionWhen a duplicate is found.
_create() ¶ protected
_create(object|string $class, string $alias, array<string, mixed> $config): Cake\Console\HelperCreate the helper instance.
Part of the template method for Cake\Core\ObjectRegistry::load()
Parameters
-
object|string$class The classname to create.
-
string$alias The alias of the helper.
-
array<string, mixed>$config An array of settings to use for the helper.
Returns
Cake\Console\Helper_resolveClassName() ¶ protected
_resolveClassName(string $class): class-stringCake\Console\Helper>|nullResolve a helper classname.
Part of the template method for {@link \Cake\Core\ObjectRegistry::load()}.
Parameters
-
string$class Partial classname to resolve.
Returns
class-stringCake\Console\Helper>|null_throwMissingClassError() ¶ protected
_throwMissingClassError(string $class, string|null $plugin): voidThrows 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|null$plugin The plugin the helper is missing in.
Returns
voidThrows
Cake\Console\Exception\MissingHelperExceptionget() ¶ public
get(string $name): objectGet loaded object instance.
Parameters
-
string$name Name of object.
Returns
objectThrows
Cake\Core\Exception\CakeExceptionIf not loaded or found.
has() ¶ public
has(string $name): boolCheck whether a given object is loaded.
Parameters
-
string$name The object name to check for.
Returns
boolload() ¶ public
load(string $name, array<string, mixed> $config = []): objectLoads/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 {@link \Cake\Controller\Component::$components} 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
-
string$name The name/class of the object to load.
-
array<string, mixed>$config optional Additional settings to use when loading the object.
Returns
objectThrows
ExceptionIf the class cannot be found.
normalizeArray() ¶ public
normalizeArray(array $objects): array<string, array>Normalizes an object configuration array into associative form for making lazy loading easier.
Parameters
-
array$objects Array of child objects to normalize.
Returns
array<string, array>reset() ¶ public
reset(): $thisClear loaded instances in the registry.
If the registry subclass has an event manager, the objects will be detached from events as well.
Returns
$thisset() ¶ public
set(string $name, object $object): $thisSet 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$name The name of the object to set in the registry.
-
object$object instance to store in the registry
Returns
$thissetIo() ¶ public
setIo(Cake\Console\ConsoleIo $io): voidSets The IO instance that should be passed to the shell helpers
Parameters
-
Cake\Console\ConsoleIo$io An io instance.
Returns
voidunload() ¶ public
unload(string $name): $thisRemove an object from the registry.
If this registry has an event manager, the object will be detached from any events as well.
Parameters
-
string$name The name of the object to remove from the registry.
Returns
$this