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:     /**
 29:      * Shell to use to set params to tasks.
 30:      *
 31:      * @var \Cake\Console\ConsoleIo
 32:      */
 33:     protected $_io;
 34: 
 35:     /**
 36:      * Sets The IO instance that should be passed to the shell helpers
 37:      *
 38:      * @param \Cake\Console\ConsoleIo $io An io instance.
 39:      * @return void
 40:      */
 41:     public function setIo(ConsoleIo $io)
 42:     {
 43:         $this->_io = $io;
 44:     }
 45: 
 46:     /**
 47:      * Resolve a helper classname.
 48:      *
 49:      * Will prefer helpers defined in Command\Helper over those
 50:      * defined in Shell\Helper.
 51:      *
 52:      * Part of the template method for Cake\Core\ObjectRegistry::load()
 53:      *
 54:      * @param string $class Partial classname to resolve.
 55:      * @return string|false Either the correct classname or false.
 56:      */
 57:     protected function _resolveClassName($class)
 58:     {
 59:         $name = App::className($class, 'Command/Helper', 'Helper');
 60:         if ($name) {
 61:             return $name;
 62:         }
 63: 
 64:         return App::className($class, 'Shell/Helper', 'Helper');
 65:     }
 66: 
 67:     /**
 68:      * Throws an exception when a helper is missing.
 69:      *
 70:      * Part of the template method for Cake\Core\ObjectRegistry::load()
 71:      * and Cake\Core\ObjectRegistry::unload()
 72:      *
 73:      * @param string $class The classname that is missing.
 74:      * @param string $plugin The plugin the helper is missing in.
 75:      * @return void
 76:      * @throws \Cake\Console\Exception\MissingHelperException
 77:      */
 78:     protected function _throwMissingClassError($class, $plugin)
 79:     {
 80:         throw new MissingHelperException([
 81:             'class' => $class,
 82:             'plugin' => $plugin
 83:         ]);
 84:     }
 85: 
 86:     /**
 87:      * Create the helper instance.
 88:      *
 89:      * Part of the template method for Cake\Core\ObjectRegistry::load()
 90:      *
 91:      * @param string $class The classname to create.
 92:      * @param string $alias The alias of the helper.
 93:      * @param array $settings An array of settings to use for the helper.
 94:      * @return \Cake\Console\Helper The constructed helper class.
 95:      */
 96:     protected function _create($class, $alias, $settings)
 97:     {
 98:         return new $class($this->_io, $settings);
 99:     }
100: }
101: