Chris@0
|
1 <?php
|
Chris@0
|
2
|
Chris@0
|
3 /*
|
Chris@0
|
4 * This file is part of the Symfony package.
|
Chris@0
|
5 *
|
Chris@0
|
6 * (c) Fabien Potencier <fabien@symfony.com>
|
Chris@0
|
7 *
|
Chris@0
|
8 * For the full copyright and license information, please view the LICENSE
|
Chris@0
|
9 * file that was distributed with this source code.
|
Chris@0
|
10 */
|
Chris@0
|
11
|
Chris@0
|
12 namespace Symfony\Component\Console\Helper;
|
Chris@0
|
13
|
Chris@0
|
14 use Symfony\Component\Console\Command\Command;
|
Chris@0
|
15 use Symfony\Component\Console\Exception\InvalidArgumentException;
|
Chris@0
|
16
|
Chris@0
|
17 /**
|
Chris@0
|
18 * HelperSet represents a set of helpers to be used with a command.
|
Chris@0
|
19 *
|
Chris@0
|
20 * @author Fabien Potencier <fabien@symfony.com>
|
Chris@0
|
21 */
|
Chris@0
|
22 class HelperSet implements \IteratorAggregate
|
Chris@0
|
23 {
|
Chris@0
|
24 /**
|
Chris@0
|
25 * @var Helper[]
|
Chris@0
|
26 */
|
Chris@17
|
27 private $helpers = [];
|
Chris@0
|
28 private $command;
|
Chris@0
|
29
|
Chris@0
|
30 /**
|
Chris@0
|
31 * @param Helper[] $helpers An array of helper
|
Chris@0
|
32 */
|
Chris@17
|
33 public function __construct(array $helpers = [])
|
Chris@0
|
34 {
|
Chris@0
|
35 foreach ($helpers as $alias => $helper) {
|
Chris@17
|
36 $this->set($helper, \is_int($alias) ? null : $alias);
|
Chris@0
|
37 }
|
Chris@0
|
38 }
|
Chris@0
|
39
|
Chris@0
|
40 /**
|
Chris@0
|
41 * Sets a helper.
|
Chris@0
|
42 *
|
Chris@0
|
43 * @param HelperInterface $helper The helper instance
|
Chris@0
|
44 * @param string $alias An alias
|
Chris@0
|
45 */
|
Chris@0
|
46 public function set(HelperInterface $helper, $alias = null)
|
Chris@0
|
47 {
|
Chris@0
|
48 $this->helpers[$helper->getName()] = $helper;
|
Chris@0
|
49 if (null !== $alias) {
|
Chris@0
|
50 $this->helpers[$alias] = $helper;
|
Chris@0
|
51 }
|
Chris@0
|
52
|
Chris@0
|
53 $helper->setHelperSet($this);
|
Chris@0
|
54 }
|
Chris@0
|
55
|
Chris@0
|
56 /**
|
Chris@0
|
57 * Returns true if the helper if defined.
|
Chris@0
|
58 *
|
Chris@0
|
59 * @param string $name The helper name
|
Chris@0
|
60 *
|
Chris@0
|
61 * @return bool true if the helper is defined, false otherwise
|
Chris@0
|
62 */
|
Chris@0
|
63 public function has($name)
|
Chris@0
|
64 {
|
Chris@0
|
65 return isset($this->helpers[$name]);
|
Chris@0
|
66 }
|
Chris@0
|
67
|
Chris@0
|
68 /**
|
Chris@0
|
69 * Gets a helper value.
|
Chris@0
|
70 *
|
Chris@0
|
71 * @param string $name The helper name
|
Chris@0
|
72 *
|
Chris@0
|
73 * @return HelperInterface The helper instance
|
Chris@0
|
74 *
|
Chris@0
|
75 * @throws InvalidArgumentException if the helper is not defined
|
Chris@0
|
76 */
|
Chris@0
|
77 public function get($name)
|
Chris@0
|
78 {
|
Chris@0
|
79 if (!$this->has($name)) {
|
Chris@0
|
80 throw new InvalidArgumentException(sprintf('The helper "%s" is not defined.', $name));
|
Chris@0
|
81 }
|
Chris@0
|
82
|
Chris@0
|
83 return $this->helpers[$name];
|
Chris@0
|
84 }
|
Chris@0
|
85
|
Chris@0
|
86 public function setCommand(Command $command = null)
|
Chris@0
|
87 {
|
Chris@0
|
88 $this->command = $command;
|
Chris@0
|
89 }
|
Chris@0
|
90
|
Chris@0
|
91 /**
|
Chris@0
|
92 * Gets the command associated with this helper set.
|
Chris@0
|
93 *
|
Chris@0
|
94 * @return Command A Command instance
|
Chris@0
|
95 */
|
Chris@0
|
96 public function getCommand()
|
Chris@0
|
97 {
|
Chris@0
|
98 return $this->command;
|
Chris@0
|
99 }
|
Chris@0
|
100
|
Chris@0
|
101 /**
|
Chris@0
|
102 * @return Helper[]
|
Chris@0
|
103 */
|
Chris@0
|
104 public function getIterator()
|
Chris@0
|
105 {
|
Chris@0
|
106 return new \ArrayIterator($this->helpers);
|
Chris@0
|
107 }
|
Chris@0
|
108 }
|