Skip to main content
Drupal API
User account menu
  • Log in

Breadcrumb

  1. Drupal Core 11.1.x
  2. InputDefinition.php

class InputDefinition

A InputDefinition represents a set of valid command line arguments and options.

Usage:

$definition = new InputDefinition([ new InputArgument('name', InputArgument::REQUIRED), new InputOption('foo', 'f', InputOption::VALUE_REQUIRED), ]);

@author Fabien Potencier <fabien@symfony.com>

Hierarchy

  • class \Symfony\Component\Console\Input\InputDefinition

Expanded class hierarchy of InputDefinition

14 files declare their use of InputDefinition
Application.php in vendor/composer/composer/src/Composer/Console/Application.php
Application.php in vendor/symfony/console/Application.php
Command.php in vendor/symfony/console/Command/Command.php
CompletionInput.php in vendor/symfony/console/Completion/CompletionInput.php
DbDumpApplication.php in core/lib/Drupal/Core/Command/DbDumpApplication.php

... See full list

File

vendor/symfony/console/Input/InputDefinition.php, line 29

Namespace

Symfony\Component\Console\Input
View source
class InputDefinition {
    private array $arguments = [];
    private int $requiredCount = 0;
    private ?InputArgument $lastArrayArgument = null;
    private ?InputArgument $lastOptionalArgument = null;
    private array $options = [];
    private array $negations = [];
    private array $shortcuts = [];
    
    /**
     * @param array $definition An array of InputArgument and InputOption instance
     */
    public function __construct(array $definition = []) {
        $this->setDefinition($definition);
    }
    
    /**
     * Sets the definition of the input.
     */
    public function setDefinition(array $definition) : void {
        $arguments = [];
        $options = [];
        foreach ($definition as $item) {
            if ($item instanceof InputOption) {
                $options[] = $item;
            }
            else {
                $arguments[] = $item;
            }
        }
        $this->setArguments($arguments);
        $this->setOptions($options);
    }
    
    /**
     * Sets the InputArgument objects.
     *
     * @param InputArgument[] $arguments An array of InputArgument objects
     */
    public function setArguments(array $arguments = []) : void {
        $this->arguments = [];
        $this->requiredCount = 0;
        $this->lastOptionalArgument = null;
        $this->lastArrayArgument = null;
        $this->addArguments($arguments);
    }
    
    /**
     * Adds an array of InputArgument objects.
     *
     * @param InputArgument[] $arguments An array of InputArgument objects
     */
    public function addArguments(?array $arguments = []) : void {
        if (null !== $arguments) {
            foreach ($arguments as $argument) {
                $this->addArgument($argument);
            }
        }
    }
    
    /**
     * @throws LogicException When incorrect argument is given
     */
    public function addArgument(InputArgument $argument) : void {
        if (isset($this->arguments[$argument->getName()])) {
            throw new LogicException(\sprintf('An argument with name "%s" already exists.', $argument->getName()));
        }
        if (null !== $this->lastArrayArgument) {
            throw new LogicException(\sprintf('Cannot add a required argument "%s" after an array argument "%s".', $argument->getName(), $this->lastArrayArgument
                ->getName()));
        }
        if ($argument->isRequired() && null !== $this->lastOptionalArgument) {
            throw new LogicException(\sprintf('Cannot add a required argument "%s" after an optional one "%s".', $argument->getName(), $this->lastOptionalArgument
                ->getName()));
        }
        if ($argument->isArray()) {
            $this->lastArrayArgument = $argument;
        }
        if ($argument->isRequired()) {
            ++$this->requiredCount;
        }
        else {
            $this->lastOptionalArgument = $argument;
        }
        $this->arguments[$argument->getName()] = $argument;
    }
    
    /**
     * Returns an InputArgument by name or by position.
     *
     * @throws InvalidArgumentException When argument given doesn't exist
     */
    public function getArgument(string|int $name) : InputArgument {
        if (!$this->hasArgument($name)) {
            throw new InvalidArgumentException(\sprintf('The "%s" argument does not exist.', $name));
        }
        $arguments = \is_int($name) ? array_values($this->arguments) : $this->arguments;
        return $arguments[$name];
    }
    
    /**
     * Returns true if an InputArgument object exists by name or position.
     */
    public function hasArgument(string|int $name) : bool {
        $arguments = \is_int($name) ? array_values($this->arguments) : $this->arguments;
        return isset($arguments[$name]);
    }
    
    /**
     * Gets the array of InputArgument objects.
     *
     * @return InputArgument[]
     */
    public function getArguments() : array {
        return $this->arguments;
    }
    
    /**
     * Returns the number of InputArguments.
     */
    public function getArgumentCount() : int {
        return null !== $this->lastArrayArgument ? \PHP_INT_MAX : \count($this->arguments);
    }
    
    /**
     * Returns the number of required InputArguments.
     */
    public function getArgumentRequiredCount() : int {
        return $this->requiredCount;
    }
    
    /**
     * @return array<string|bool|int|float|array|null>
     */
    public function getArgumentDefaults() : array {
        $values = [];
        foreach ($this->arguments as $argument) {
            $values[$argument->getName()] = $argument->getDefault();
        }
        return $values;
    }
    
    /**
     * Sets the InputOption objects.
     *
     * @param InputOption[] $options An array of InputOption objects
     */
    public function setOptions(array $options = []) : void {
        $this->options = [];
        $this->shortcuts = [];
        $this->negations = [];
        $this->addOptions($options);
    }
    
    /**
     * Adds an array of InputOption objects.
     *
     * @param InputOption[] $options An array of InputOption objects
     */
    public function addOptions(array $options = []) : void {
        foreach ($options as $option) {
            $this->addOption($option);
        }
    }
    
    /**
     * @throws LogicException When option given already exist
     */
    public function addOption(InputOption $option) : void {
        if (isset($this->options[$option->getName()]) && !$option->equals($this->options[$option->getName()])) {
            throw new LogicException(\sprintf('An option named "%s" already exists.', $option->getName()));
        }
        if (isset($this->negations[$option->getName()])) {
            throw new LogicException(\sprintf('An option named "%s" already exists.', $option->getName()));
        }
        if ($option->getShortcut()) {
            foreach (explode('|', $option->getShortcut()) as $shortcut) {
                if (isset($this->shortcuts[$shortcut]) && !$option->equals($this->options[$this->shortcuts[$shortcut]])) {
                    throw new LogicException(\sprintf('An option with shortcut "%s" already exists.', $shortcut));
                }
            }
        }
        $this->options[$option->getName()] = $option;
        if ($option->getShortcut()) {
            foreach (explode('|', $option->getShortcut()) as $shortcut) {
                $this->shortcuts[$shortcut] = $option->getName();
            }
        }
        if ($option->isNegatable()) {
            $negatedName = 'no-' . $option->getName();
            if (isset($this->options[$negatedName])) {
                throw new LogicException(\sprintf('An option named "%s" already exists.', $negatedName));
            }
            $this->negations[$negatedName] = $option->getName();
        }
    }
    
    /**
     * Returns an InputOption by name.
     *
     * @throws InvalidArgumentException When option given doesn't exist
     */
    public function getOption(string $name) : InputOption {
        if (!$this->hasOption($name)) {
            throw new InvalidArgumentException(\sprintf('The "--%s" option does not exist.', $name));
        }
        return $this->options[$name];
    }
    
    /**
     * Returns true if an InputOption object exists by name.
     *
     * This method can't be used to check if the user included the option when
     * executing the command (use getOption() instead).
     */
    public function hasOption(string $name) : bool {
        return isset($this->options[$name]);
    }
    
    /**
     * Gets the array of InputOption objects.
     *
     * @return InputOption[]
     */
    public function getOptions() : array {
        return $this->options;
    }
    
    /**
     * Returns true if an InputOption object exists by shortcut.
     */
    public function hasShortcut(string $name) : bool {
        return isset($this->shortcuts[$name]);
    }
    
    /**
     * Returns true if an InputOption object exists by negated name.
     */
    public function hasNegation(string $name) : bool {
        return isset($this->negations[$name]);
    }
    
    /**
     * Gets an InputOption by shortcut.
     */
    public function getOptionForShortcut(string $shortcut) : InputOption {
        return $this->getOption($this->shortcutToName($shortcut));
    }
    
    /**
     * @return array<string|bool|int|float|array|null>
     */
    public function getOptionDefaults() : array {
        $values = [];
        foreach ($this->options as $option) {
            $values[$option->getName()] = $option->getDefault();
        }
        return $values;
    }
    
    /**
     * Returns the InputOption name given a shortcut.
     *
     * @throws InvalidArgumentException When option given does not exist
     *
     * @internal
     */
    public function shortcutToName(string $shortcut) : string {
        if (!isset($this->shortcuts[$shortcut])) {
            throw new InvalidArgumentException(\sprintf('The "-%s" option does not exist.', $shortcut));
        }
        return $this->shortcuts[$shortcut];
    }
    
    /**
     * Returns the InputOption name given a negation.
     *
     * @throws InvalidArgumentException When option given does not exist
     *
     * @internal
     */
    public function negationToName(string $negation) : string {
        if (!isset($this->negations[$negation])) {
            throw new InvalidArgumentException(\sprintf('The "--%s" option does not exist.', $negation));
        }
        return $this->negations[$negation];
    }
    
    /**
     * Gets the synopsis.
     */
    public function getSynopsis(bool $short = false) : string {
        $elements = [];
        if ($short && $this->getOptions()) {
            $elements[] = '[options]';
        }
        elseif (!$short) {
            foreach ($this->getOptions() as $option) {
                $value = '';
                if ($option->acceptValue()) {
                    $value = \sprintf(' %s%s%s', $option->isValueOptional() ? '[' : '', strtoupper($option->getName()), $option->isValueOptional() ? ']' : '');
                }
                $shortcut = $option->getShortcut() ? \sprintf('-%s|', $option->getShortcut()) : '';
                $negation = $option->isNegatable() ? \sprintf('|--no-%s', $option->getName()) : '';
                $elements[] = \sprintf('[%s--%s%s%s]', $shortcut, $option->getName(), $value, $negation);
            }
        }
        if (\count($elements) && $this->getArguments()) {
            $elements[] = '[--]';
        }
        $tail = '';
        foreach ($this->getArguments() as $argument) {
            $element = '<' . $argument->getName() . '>';
            if ($argument->isArray()) {
                $element .= '...';
            }
            if (!$argument->isRequired()) {
                $element = '[' . $element;
                $tail .= ']';
            }
            $elements[] = $element;
        }
        return implode(' ', $elements) . $tail;
    }

}

Members

Title Sort descending Modifiers Object type Summary
InputDefinition::$arguments private property
InputDefinition::$lastArrayArgument private property
InputDefinition::$lastOptionalArgument private property
InputDefinition::$negations private property
InputDefinition::$options private property
InputDefinition::$requiredCount private property
InputDefinition::$shortcuts private property
InputDefinition::addArgument public function
InputDefinition::addArguments public function Adds an array of InputArgument objects.
InputDefinition::addOption public function
InputDefinition::addOptions public function Adds an array of InputOption objects.
InputDefinition::getArgument public function Returns an InputArgument by name or by position.
InputDefinition::getArgumentCount public function Returns the number of InputArguments.
InputDefinition::getArgumentDefaults public function
InputDefinition::getArgumentRequiredCount public function Returns the number of required InputArguments.
InputDefinition::getArguments public function Gets the array of InputArgument objects.
InputDefinition::getOption public function Returns an InputOption by name.
InputDefinition::getOptionDefaults public function
InputDefinition::getOptionForShortcut public function Gets an InputOption by shortcut.
InputDefinition::getOptions public function Gets the array of InputOption objects.
InputDefinition::getSynopsis public function Gets the synopsis.
InputDefinition::hasArgument public function Returns true if an InputArgument object exists by name or position.
InputDefinition::hasNegation public function Returns true if an InputOption object exists by negated name.
InputDefinition::hasOption public function Returns true if an InputOption object exists by name.
InputDefinition::hasShortcut public function Returns true if an InputOption object exists by shortcut.
InputDefinition::negationToName public function Returns the InputOption name given a negation.
InputDefinition::setArguments public function Sets the InputArgument objects.
InputDefinition::setDefinition public function Sets the definition of the input.
InputDefinition::setOptions public function Sets the InputOption objects.
InputDefinition::shortcutToName public function Returns the InputOption name given a shortcut.
InputDefinition::__construct public function

API Navigation

  • Drupal Core 11.1.x
  • Topics
  • Classes
  • Functions
  • Constants
  • Globals
  • Files
  • Namespaces
  • Deprecated
  • Services
RSS feed
Powered by Drupal