1: <?php
  2: /**
  3:  * CakePHP(tm) : Rapid Development Framework (https://cakephp.org)
  4:  * Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
  5:  *
  6:  * Licensed under The MIT License
  7:  * For full copyright and license information, please see the LICENSE.txt
  8:  * Redistributions of files must retain the above copyright notice.
  9:  *
 10:  * @copyright     Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
 11:  * @link          https://cakephp.org CakePHP(tm) Project
 12:  * @since         3.1.0
 13:  * @license       https://opensource.org/licenses/mit-license.php MIT License
 14:  */
 15: namespace Cake\Console;
 16: 
 17: use Cake\Console\Exception\MissingHelperException;
 18: use Cake\Core\App;
 19: use Cake\Core\ObjectRegistry;
 20: 
 21: /**
 22:  * Registry for Helpers. Provides features
 23:  * for lazily loading helpers.
 24:  */
 25: class HelperRegistry extends ObjectRegistry
 26: {
 27:     /**
 28:      * Shell to use to set params to tasks.
 29:      *
 30:      * @var \Cake\Console\ConsoleIo
 31:      */
 32:     protected $_io;
 33: 
 34:     /**
 35:      * Sets The IO instance that should be passed to the shell helpers
 36:      *
 37:      * @param \Cake\Console\ConsoleIo $io An io instance.
 38:      * @return void
 39:      */
 40:     public function setIo(ConsoleIo $io)
 41:     {
 42:         $this->_io = $io;
 43:     }
 44: 
 45:     /**
 46:      * Resolve a helper classname.
 47:      *
 48:      * Will prefer helpers defined in Command\Helper over those
 49:      * defined in Shell\Helper.
 50:      *
 51:      * Part of the template method for Cake\Core\ObjectRegistry::load()
 52:      *
 53:      * @param string $class Partial classname to resolve.
 54:      * @return string|false Either the correct classname or false.
 55:      */
 56:     protected function _resolveClassName($class)
 57:     {
 58:         $name = App::className($class, 'Command/Helper', 'Helper');
 59:         if ($name) {
 60:             return $name;
 61:         }
 62: 
 63:         return App::className($class, 'Shell/Helper', 'Helper');
 64:     }
 65: 
 66:     /**
 67:      * Throws an exception when a helper is missing.
 68:      *
 69:      * Part of the template method for Cake\Core\ObjectRegistry::load()
 70:      * and Cake\Core\ObjectRegistry::unload()
 71:      *
 72:      * @param string $class The classname that is missing.
 73:      * @param string $plugin The plugin the helper is missing in.
 74:      * @return void
 75:      * @throws \Cake\Console\Exception\MissingHelperException
 76:      */
 77:     protected function _throwMissingClassError($class, $plugin)
 78:     {
 79:         throw new MissingHelperException([
 80:             'class' => $class,
 81:             'plugin' => $plugin
 82:         ]);
 83:     }
 84: 
 85:     /**
 86:      * Create the helper instance.
 87:      *
 88:      * Part of the template method for Cake\Core\ObjectRegistry::load()
 89:      *
 90:      * @param string $class The classname to create.
 91:      * @param string $alias The alias of the helper.
 92:      * @param array $settings An array of settings to use for the helper.
 93:      * @return \Cake\Console\Helper The constructed helper class.
 94:      */
 95:     protected function _create($class, $alias, $settings)
 96:     {
 97:         return new $class($this->_io, $settings);
 98:     }
 99: }
100: