1: <?php
2: /**
3: * CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
4: * Copyright (c) Cake Software Foundation, Inc. (http://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. (http://cakefoundation.org)
11: * @link http://cakephp.org CakePHP(tm) Project
12: * @since 3.1.0
13: * @license http://www.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: * Part of the template method for Cake\Core\ObjectRegistry::load()
50: *
51: * @param string $class Partial classname to resolve.
52: * @return string|false Either the correct classname or false.
53: */
54: protected function _resolveClassName($class)
55: {
56: return App::className($class, 'Shell/Helper', 'Helper');
57: }
58:
59: /**
60: * Throws an exception when a helper is missing.
61: *
62: * Part of the template method for Cake\Core\ObjectRegistry::load()
63: *
64: * @param string $class The classname that is missing.
65: * @param string $plugin The plugin the helper is missing in.
66: * @return void
67: * @throws \Cake\Console\Exception\MissingHelperException
68: */
69: protected function _throwMissingClassError($class, $plugin)
70: {
71: throw new MissingHelperException([
72: 'class' => $class,
73: 'plugin' => $plugin
74: ]);
75: }
76:
77: /**
78: * Create the helper instance.
79: *
80: * Part of the template method for Cake\Core\ObjectRegistry::load()
81: *
82: * @param string $class The classname to create.
83: * @param string $alias The alias of the helper.
84: * @param array $settings An array of settings to use for the helper.
85: * @return \Cake\Console\Helper The constructed helper class.
86: */
87: protected function _create($class, $alias, $settings)
88: {
89: return new $class($this->_io, $settings);
90: }
91: }
92: