Chris@0: Chris@0: * Chris@0: * For the full copyright and license information, please view the LICENSE Chris@0: * file that was distributed with this source code. Chris@0: */ Chris@0: Chris@0: namespace Symfony\Component\Console\Input; Chris@0: Chris@0: use Symfony\Component\Console\Exception\InvalidArgumentException; Chris@0: use Symfony\Component\Console\Exception\InvalidOptionException; Chris@0: Chris@0: /** Chris@0: * ArrayInput represents an input provided as an array. Chris@0: * Chris@0: * Usage: Chris@0: * Chris@18: * $input = new ArrayInput(['command' => 'foo:bar', 'foo' => 'bar', '--bar' => 'foobar']); Chris@0: * Chris@0: * @author Fabien Potencier Chris@0: */ Chris@0: class ArrayInput extends Input Chris@0: { Chris@0: private $parameters; Chris@0: Chris@0: public function __construct(array $parameters, InputDefinition $definition = null) Chris@0: { Chris@0: $this->parameters = $parameters; Chris@0: Chris@0: parent::__construct($definition); Chris@0: } Chris@0: Chris@0: /** Chris@0: * {@inheritdoc} Chris@0: */ Chris@0: public function getFirstArgument() Chris@0: { Chris@0: foreach ($this->parameters as $key => $value) { Chris@0: if ($key && '-' === $key[0]) { Chris@0: continue; Chris@0: } Chris@0: Chris@0: return $value; Chris@0: } Chris@0: } Chris@0: Chris@0: /** Chris@0: * {@inheritdoc} Chris@0: */ Chris@0: public function hasParameterOption($values, $onlyParams = false) Chris@0: { Chris@0: $values = (array) $values; Chris@0: Chris@0: foreach ($this->parameters as $k => $v) { Chris@17: if (!\is_int($k)) { Chris@0: $v = $k; Chris@0: } Chris@0: Chris@14: if ($onlyParams && '--' === $v) { Chris@0: return false; Chris@0: } Chris@0: Chris@17: if (\in_array($v, $values)) { Chris@0: return true; Chris@0: } Chris@0: } Chris@0: Chris@0: return false; Chris@0: } Chris@0: Chris@0: /** Chris@0: * {@inheritdoc} Chris@0: */ Chris@0: public function getParameterOption($values, $default = false, $onlyParams = false) Chris@0: { Chris@0: $values = (array) $values; Chris@0: Chris@0: foreach ($this->parameters as $k => $v) { Chris@17: if ($onlyParams && ('--' === $k || (\is_int($k) && '--' === $v))) { Chris@17: return $default; Chris@0: } Chris@0: Chris@17: if (\is_int($k)) { Chris@17: if (\in_array($v, $values)) { Chris@0: return true; Chris@0: } Chris@17: } elseif (\in_array($k, $values)) { Chris@0: return $v; Chris@0: } Chris@0: } Chris@0: Chris@0: return $default; Chris@0: } Chris@0: Chris@0: /** Chris@0: * Returns a stringified representation of the args passed to the command. Chris@0: * Chris@0: * @return string Chris@0: */ Chris@0: public function __toString() Chris@0: { Chris@17: $params = []; Chris@0: foreach ($this->parameters as $param => $val) { Chris@0: if ($param && '-' === $param[0]) { Chris@17: if (\is_array($val)) { Chris@14: foreach ($val as $v) { Chris@14: $params[] = $param.('' != $v ? '='.$this->escapeToken($v) : ''); Chris@14: } Chris@14: } else { Chris@14: $params[] = $param.('' != $val ? '='.$this->escapeToken($val) : ''); Chris@14: } Chris@0: } else { Chris@17: $params[] = \is_array($val) ? implode(' ', array_map([$this, 'escapeToken'], $val)) : $this->escapeToken($val); Chris@0: } Chris@0: } Chris@0: Chris@0: return implode(' ', $params); Chris@0: } Chris@0: Chris@0: /** Chris@0: * {@inheritdoc} Chris@0: */ Chris@0: protected function parse() Chris@0: { Chris@0: foreach ($this->parameters as $key => $value) { Chris@14: if ('--' === $key) { Chris@0: return; Chris@0: } Chris@0: if (0 === strpos($key, '--')) { Chris@0: $this->addLongOption(substr($key, 2), $value); Chris@0: } elseif ('-' === $key[0]) { Chris@0: $this->addShortOption(substr($key, 1), $value); Chris@0: } else { Chris@0: $this->addArgument($key, $value); Chris@0: } Chris@0: } Chris@0: } Chris@0: Chris@0: /** Chris@0: * Adds a short option value. Chris@0: * Chris@0: * @param string $shortcut The short option key Chris@0: * @param mixed $value The value for the option Chris@0: * Chris@0: * @throws InvalidOptionException When option given doesn't exist Chris@0: */ Chris@0: private function addShortOption($shortcut, $value) Chris@0: { Chris@0: if (!$this->definition->hasShortcut($shortcut)) { Chris@0: throw new InvalidOptionException(sprintf('The "-%s" option does not exist.', $shortcut)); Chris@0: } Chris@0: Chris@0: $this->addLongOption($this->definition->getOptionForShortcut($shortcut)->getName(), $value); Chris@0: } Chris@0: Chris@0: /** Chris@0: * Adds a long option value. Chris@0: * Chris@0: * @param string $name The long option key Chris@0: * @param mixed $value The value for the option Chris@0: * Chris@0: * @throws InvalidOptionException When option given doesn't exist Chris@0: * @throws InvalidOptionException When a required value is missing Chris@0: */ Chris@0: private function addLongOption($name, $value) Chris@0: { Chris@0: if (!$this->definition->hasOption($name)) { Chris@0: throw new InvalidOptionException(sprintf('The "--%s" option does not exist.', $name)); Chris@0: } Chris@0: Chris@0: $option = $this->definition->getOption($name); Chris@0: Chris@0: if (null === $value) { Chris@0: if ($option->isValueRequired()) { Chris@0: throw new InvalidOptionException(sprintf('The "--%s" option requires a value.', $name)); Chris@0: } Chris@0: Chris@14: if (!$option->isValueOptional()) { Chris@14: $value = true; Chris@14: } Chris@0: } Chris@0: Chris@0: $this->options[$name] = $value; Chris@0: } Chris@0: Chris@0: /** Chris@0: * Adds an argument value. Chris@0: * Chris@0: * @param string $name The argument name Chris@0: * @param mixed $value The value for the argument Chris@0: * Chris@0: * @throws InvalidArgumentException When argument given doesn't exist Chris@0: */ Chris@0: private function addArgument($name, $value) Chris@0: { Chris@0: if (!$this->definition->hasArgument($name)) { Chris@0: throw new InvalidArgumentException(sprintf('The "%s" argument does not exist.', $name)); Chris@0: } Chris@0: Chris@0: $this->arguments[$name] = $value; Chris@0: } Chris@0: }