ArrayInput.php 5.3 KB

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