$_loaded
$_loaded : array<mixed,object>
Map of loaded objects.
Registry for Helpers. Provides features for lazily loading helpers.
Provides registry & factory functionality for object types. Used as a super class for various composition based re-use features in CakePHP.
Each subclass needs to implement the various abstract methods to complete the template method load().
The ObjectRegistry is EventManager aware, but each extending class will need to use \Cake\Event\EventDispatcherTrait to attach and detach on set and bind
$_io : \Cake\Console\ConsoleIo
Shell to use to set params to tasks.
load(string $objectName, array $config = array()) : mixed
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 | Additional settings to use when loading the object. |
If the class cannot be found.
set(string $objectName, object $object) : $this
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 |
setIo(\Cake\Console\ConsoleIo $io) : void
Sets The IO instance that should be passed to the shell helpers
| \Cake\Console\ConsoleIo | $io | An io instance. |
_checkDuplicate(string $name, array $config) : void
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. |
When a duplicate is found.
_resolveClassName(string $class) : string|false
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()
| string | $class | Partial classname to resolve. |
Either the correct classname or false.
_throwMissingClassError(string $class, string $plugin) : void
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 | $plugin | The plugin the helper is missing in. |
_create(string $class, string $alias, array $settings) : \Cake\Console\Helper
Create the helper instance.
Part of the template method for Cake\Core\ObjectRegistry::load()
| string | $class | The classname to create. |
| string | $alias | The alias of the helper. |
| array | $settings | An array of settings to use for the helper. |
The constructed helper class.
<?php
/**
* CakePHP(tm) : Rapid Development Framework (https://cakephp.org)
* Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
*
* Licensed under The MIT License
* For full copyright and license information, please see the LICENSE.txt
* Redistributions of files must retain the above copyright notice.
*
* @copyright Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
* @link https://cakephp.org CakePHP(tm) Project
* @since 3.1.0
* @license https://opensource.org/licenses/mit-license.php MIT License
*/
namespace Cake\Console;
use Cake\Console\Exception\MissingHelperException;
use Cake\Core\App;
use Cake\Core\ObjectRegistry;
/**
* Registry for Helpers. Provides features
* for lazily loading helpers.
*/
class HelperRegistry extends ObjectRegistry
{
/**
* Shell to use to set params to tasks.
*
* @var \Cake\Console\ConsoleIo
*/
protected $_io;
/**
* Sets The IO instance that should be passed to the shell helpers
*
* @param \Cake\Console\ConsoleIo $io An io instance.
* @return void
*/
public function setIo(ConsoleIo $io)
{
$this->_io = $io;
}
/**
* 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()
*
* @param string $class Partial classname to resolve.
* @return string|false Either the correct classname or false.
*/
protected function _resolveClassName($class)
{
$name = App::className($class, 'Command/Helper', 'Helper');
if ($name) {
return $name;
}
return App::className($class, 'Shell/Helper', 'Helper');
}
/**
* Throws an exception when a helper is missing.
*
* Part of the template method for Cake\Core\ObjectRegistry::load()
* and Cake\Core\ObjectRegistry::unload()
*
* @param string $class The classname that is missing.
* @param string $plugin The plugin the helper is missing in.
* @return void
* @throws \Cake\Console\Exception\MissingHelperException
*/
protected function _throwMissingClassError($class, $plugin)
{
throw new MissingHelperException([
'class' => $class,
'plugin' => $plugin
]);
}
/**
* Create the helper instance.
*
* Part of the template method for Cake\Core\ObjectRegistry::load()
*
* @param string $class The classname to create.
* @param string $alias The alias of the helper.
* @param array $settings An array of settings to use for the helper.
* @return \Cake\Console\Helper The constructed helper class.
*/
protected function _create($class, $alias, $settings)
{
return new $class($this->_io, $settings);
}
}