Class HelperRegistry
Registry for Helpers. Provides features for lazily loading helpers.
Properties summary
Method Summary
Method Detail
__debugInfo() public
__debugInfo()
Debug friendly object properties.
Returns
array
__get() public
__get(string $name)
Provide public read access to the loaded objects
Parameters
-
string
$name Name of property to read
Returns
object|null
__isset() public
__isset(string $name)
Provide isset access to _loaded
Parameters
-
string
$name Name of object being checked.
Returns
bool
__set() public
__set(string $name, mixed $object)
Sets an object.
Parameters
-
string
$name Name of a property to set.
-
object
$object Object to set.
__unset() public
__unset(string $name)
Unsets an object.
Parameters
-
string
$name Name of a property to unset.
_checkDuplicate() 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.
_create() protected
_create(mixed $class, string $alias, array $config)
Create the helper instance.
Part of the template method for Cake\Core\ObjectRegistry::load()
Parameters
-
string
$class The classname to create.
-
string
$alias The alias of the helper.
-
array
$config An array of settings to use for the helper.
Returns
\Cake\Console\Helper
The constructed helper class.
_resolveClassName() protected
_resolveClassName(string $class)
Resolve a helper classname.
Will prefer helpers defined in Command\Helper over those defined in Shell\Helper.
Part of the template method for Cake\Core\ObjectRegistry::load()
Parameters
-
string
$class Partial classname to resolve.
Returns
string|null
Either the correct class name or null.
_throwMissingClassError() 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|null
$plugin The plugin the helper is missing in.
Throws
Cake\Console\Exception\MissingHelperException
count() public
count()
Returns the number of loaded objects.
Returns
int
get() public
get(string $name)
Get loaded object instance.
Parameters
-
string
$name Name of object.
Returns
object
Object instance.
Throws
RuntimeException
If not loaded or found.
getIterator() public
getIterator()
Returns an array iterator.
Returns
\Traversable
has() public
has(string $name)
Check whether or not a given object is loaded.
Parameters
-
string
$name The object name to check for.
Returns
bool
True is object is loaded else false.
load() 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() public
loaded()
Get the list of loaded objects.
Returns
string[]
List of object names.
normalizeArray() 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() 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() 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
setIo() public
setIo(\Cake\Console\ConsoleIo $io)
Sets The IO instance that should be passed to the shell helpers
Parameters
-
\Cake\Console\ConsoleIo
$io An io instance.
unload() 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
Property Detail
$_io protected
Shell to use to set params to tasks.
Type
\Cake\Console\ConsoleIo
$_loaded protected
Map of loaded objects.
Type
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.Console.HelperRegistry.html