annotate vendor/symfony/console/Input/ArrayInput.php @ 19:fa3358dc1485 tip

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