ArrayInput.php 5.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207
  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\Input;
  11. use Symfony\Component\Console\Exception\InvalidArgumentException;
  12. use Symfony\Component\Console\Exception\InvalidOptionException;
  13. /**
  14. * ArrayInput represents an input provided as an array.
  15. *
  16. * Usage:
  17. *
  18. * $input = new ArrayInput(array('name' => 'foo', '--bar' => 'foobar'));
  19. *
  20. * @author Fabien Potencier <fabien@symfony.com>
  21. */
  22. class ArrayInput extends Input
  23. {
  24. private $parameters;
  25. /**
  26. * Constructor.
  27. *
  28. * @param array $parameters An array of parameters
  29. * @param InputDefinition|null $definition A InputDefinition instance
  30. */
  31. public function __construct(array $parameters, InputDefinition $definition = null)
  32. {
  33. $this->parameters = $parameters;
  34. parent::__construct($definition);
  35. }
  36. /**
  37. * {@inheritdoc}
  38. */
  39. public function getFirstArgument()
  40. {
  41. foreach ($this->parameters as $key => $value) {
  42. if ($key && '-' === $key[0]) {
  43. continue;
  44. }
  45. return $value;
  46. }
  47. }
  48. /**
  49. * {@inheritdoc}
  50. */
  51. public function hasParameterOption($values, $onlyParams = false)
  52. {
  53. $values = (array) $values;
  54. foreach ($this->parameters as $k => $v) {
  55. if (!is_int($k)) {
  56. $v = $k;
  57. }
  58. if ($onlyParams && $v === '--') {
  59. return false;
  60. }
  61. if (in_array($v, $values)) {
  62. return true;
  63. }
  64. }
  65. return false;
  66. }
  67. /**
  68. * {@inheritdoc}
  69. */
  70. public function getParameterOption($values, $default = false, $onlyParams = false)
  71. {
  72. $values = (array) $values;
  73. foreach ($this->parameters as $k => $v) {
  74. if ($onlyParams && ($k === '--' || (is_int($k) && $v === '--'))) {
  75. return false;
  76. }
  77. if (is_int($k)) {
  78. if (in_array($v, $values)) {
  79. return true;
  80. }
  81. } elseif (in_array($k, $values)) {
  82. return $v;
  83. }
  84. }
  85. return $default;
  86. }
  87. /**
  88. * Returns a stringified representation of the args passed to the command.
  89. *
  90. * @return string
  91. */
  92. public function __toString()
  93. {
  94. $params = array();
  95. foreach ($this->parameters as $param => $val) {
  96. if ($param && '-' === $param[0]) {
  97. $params[] = $param.('' != $val ? '='.$this->escapeToken($val) : '');
  98. } else {
  99. $params[] = $this->escapeToken($val);
  100. }
  101. }
  102. return implode(' ', $params);
  103. }
  104. /**
  105. * {@inheritdoc}
  106. */
  107. protected function parse()
  108. {
  109. foreach ($this->parameters as $key => $value) {
  110. if ($key === '--') {
  111. return;
  112. }
  113. if (0 === strpos($key, '--')) {
  114. $this->addLongOption(substr($key, 2), $value);
  115. } elseif ('-' === $key[0]) {
  116. $this->addShortOption(substr($key, 1), $value);
  117. } else {
  118. $this->addArgument($key, $value);
  119. }
  120. }
  121. }
  122. /**
  123. * Adds a short option value.
  124. *
  125. * @param string $shortcut The short option key
  126. * @param mixed $value The value for the option
  127. *
  128. * @throws InvalidOptionException When option given doesn't exist
  129. */
  130. private function addShortOption($shortcut, $value)
  131. {
  132. if (!$this->definition->hasShortcut($shortcut)) {
  133. throw new InvalidOptionException(sprintf('The "-%s" option does not exist.', $shortcut));
  134. }
  135. $this->addLongOption($this->definition->getOptionForShortcut($shortcut)->getName(), $value);
  136. }
  137. /**
  138. * Adds a long option value.
  139. *
  140. * @param string $name The long option key
  141. * @param mixed $value The value for the option
  142. *
  143. * @throws InvalidOptionException When option given doesn't exist
  144. * @throws InvalidOptionException When a required value is missing
  145. */
  146. private function addLongOption($name, $value)
  147. {
  148. if (!$this->definition->hasOption($name)) {
  149. throw new InvalidOptionException(sprintf('The "--%s" option does not exist.', $name));
  150. }
  151. $option = $this->definition->getOption($name);
  152. if (null === $value) {
  153. if ($option->isValueRequired()) {
  154. throw new InvalidOptionException(sprintf('The "--%s" option requires a value.', $name));
  155. }
  156. if (!$option->isValueOptional()) {
  157. $value = true;
  158. }
  159. }
  160. $this->options[$name] = $value;
  161. }
  162. /**
  163. * Adds an argument value.
  164. *
  165. * @param string $name The argument name
  166. * @param mixed $value The value for the argument
  167. *
  168. * @throws InvalidArgumentException When argument given doesn't exist
  169. */
  170. private function addArgument($name, $value)
  171. {
  172. if (!$this->definition->hasArgument($name)) {
  173. throw new InvalidArgumentException(sprintf('The "%s" argument does not exist.', $name));
  174. }
  175. $this->arguments[$name] = $value;
  176. }
  177. }