[Summary view] [Print] [Text view]

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