HelperSet.php 3.4 KB

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