class InputArgument in Zircon Profile 8

Represents a command line argument.

@author Fabien Potencier <[e-mail]>

Hierarchy

• class \Symfony\Component\Console\Input\InputArgument

20 files declare their use of InputArgument

AbstractDescriptorTest.php in vendor/symfony/console/Tests/Descriptor/AbstractDescriptorTest.php

Application.php in vendor/symfony/console/Application.php

ApplicationTest.php in vendor/symfony/console/Tests/ApplicationTest.php

ArgvInputTest.php in vendor/symfony/console/Tests/Input/ArgvInputTest.php

ArrayInputTest.php in vendor/symfony/console/Tests/Input/ArrayInputTest.php

... See full list

File

vendor/symfony/console/Input/InputArgument.php, line 19

Namespace

Symfony\Component\Console\Input

class InputArgument {
  const REQUIRED = 1;
  const OPTIONAL = 2;
  const IS_ARRAY = 4;
  private $name;
  private $mode;
  private $default;
  private $description;

  /**
   * Constructor.
   *
   * @param string $name        The argument name
   * @param int    $mode        The argument mode: self::REQUIRED or self::OPTIONAL
   * @param string $description A description text
   * @param mixed  $default     The default value (for self::OPTIONAL mode only)
   *
   * @throws \InvalidArgumentException When argument mode is not valid
   */
  public function __construct($name, $mode = null, $description = '', $default = null) {
    if (null === $mode) {
      $mode = self::OPTIONAL;
    }
    elseif (!is_int($mode) || $mode > 7 || $mode < 1) {
      throw new \InvalidArgumentException(sprintf('Argument mode "%s" is not valid.', $mode));
    }
    $this->name = $name;
    $this->mode = $mode;
    $this->description = $description;
    $this
      ->setDefault($default);
  }

  /**
   * Returns the argument name.
   *
   * @return string The argument name
   */
  public function getName() {
    return $this->name;
  }

  /**
   * Returns true if the argument is required.
   *
   * @return bool true if parameter mode is self::REQUIRED, false otherwise
   */
  public function isRequired() {
    return self::REQUIRED === (self::REQUIRED & $this->mode);
  }

  /**
   * Returns true if the argument can take multiple values.
   *
   * @return bool true if mode is self::IS_ARRAY, false otherwise
   */
  public function isArray() {
    return self::IS_ARRAY === (self::IS_ARRAY & $this->mode);
  }

  /**
   * Sets the default value.
   *
   * @param mixed $default The default value
   *
   * @throws \LogicException When incorrect default value is given
   */
  public function setDefault($default = null) {
    if (self::REQUIRED === $this->mode && null !== $default) {
      throw new \LogicException('Cannot set a default value except for InputArgument::OPTIONAL mode.');
    }
    if ($this
      ->isArray()) {
      if (null === $default) {
        $default = array();
      }
      elseif (!is_array($default)) {
        throw new \LogicException('A default value for an array argument must be an array.');
      }
    }
    $this->default = $default;
  }

  /**
   * Returns the default value.
   *
   * @return mixed The default value
   */
  public function getDefault() {
    return $this->default;
  }

  /**
   * Returns the description text.
   *
   * @return string The description text
   */
  public function getDescription() {
    return $this->description;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
InputArgument::$default	private	property
InputArgument::$description	private	property
InputArgument::$mode	private	property
InputArgument::$name	private	property
InputArgument::getDefault	public	function	Returns the default value.
InputArgument::getDescription	public	function	Returns the description text.
InputArgument::getName	public	function	Returns the argument name.
InputArgument::isArray	public	function	Returns true if the argument can take multiple values.
InputArgument::isRequired	public	function	Returns true if the argument is required.
InputArgument::IS_ARRAY		constant
InputArgument::OPTIONAL		constant
InputArgument::REQUIRED		constant
InputArgument::setDefault	public	function	Sets the default value.
InputArgument::__construct	public	function	Constructor.