Chris@0: <?php
Chris@0: 
Chris@0: /*
Chris@0:  * This file is part of the Symfony package.
Chris@0:  *
Chris@0:  * (c) Fabien Potencier <fabien@symfony.com>
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\LogicException;
Chris@0: 
Chris@0: /**
Chris@0:  * Represents a command line argument.
Chris@0:  *
Chris@0:  * @author Fabien Potencier <fabien@symfony.com>
Chris@0:  */
Chris@0: class InputArgument
Chris@0: {
Chris@0:     const REQUIRED = 1;
Chris@0:     const OPTIONAL = 2;
Chris@0:     const IS_ARRAY = 4;
Chris@0: 
Chris@0:     private $name;
Chris@0:     private $mode;
Chris@0:     private $default;
Chris@0:     private $description;
Chris@0: 
Chris@0:     /**
Chris@17:      * @param string               $name        The argument name
Chris@17:      * @param int|null             $mode        The argument mode: self::REQUIRED or self::OPTIONAL
Chris@17:      * @param string               $description A description text
Chris@17:      * @param string|string[]|null $default     The default value (for self::OPTIONAL mode only)
Chris@0:      *
Chris@0:      * @throws InvalidArgumentException When argument mode is not valid
Chris@0:      */
Chris@0:     public function __construct($name, $mode = null, $description = '', $default = null)
Chris@0:     {
Chris@0:         if (null === $mode) {
Chris@0:             $mode = self::OPTIONAL;
Chris@17:         } elseif (!\is_int($mode) || $mode > 7 || $mode < 1) {
Chris@0:             throw new InvalidArgumentException(sprintf('Argument mode "%s" is not valid.', $mode));
Chris@0:         }
Chris@0: 
Chris@0:         $this->name = $name;
Chris@0:         $this->mode = $mode;
Chris@0:         $this->description = $description;
Chris@0: 
Chris@0:         $this->setDefault($default);
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Returns the argument name.
Chris@0:      *
Chris@0:      * @return string The argument name
Chris@0:      */
Chris@0:     public function getName()
Chris@0:     {
Chris@0:         return $this->name;
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Returns true if the argument is required.
Chris@0:      *
Chris@0:      * @return bool true if parameter mode is self::REQUIRED, false otherwise
Chris@0:      */
Chris@0:     public function isRequired()
Chris@0:     {
Chris@0:         return self::REQUIRED === (self::REQUIRED & $this->mode);
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Returns true if the argument can take multiple values.
Chris@0:      *
Chris@0:      * @return bool true if mode is self::IS_ARRAY, false otherwise
Chris@0:      */
Chris@0:     public function isArray()
Chris@0:     {
Chris@0:         return self::IS_ARRAY === (self::IS_ARRAY & $this->mode);
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Sets the default value.
Chris@0:      *
Chris@17:      * @param string|string[]|null $default The default value
Chris@0:      *
Chris@0:      * @throws LogicException When incorrect default value is given
Chris@0:      */
Chris@0:     public function setDefault($default = null)
Chris@0:     {
Chris@0:         if (self::REQUIRED === $this->mode && null !== $default) {
Chris@0:             throw new LogicException('Cannot set a default value except for InputArgument::OPTIONAL mode.');
Chris@0:         }
Chris@0: 
Chris@0:         if ($this->isArray()) {
Chris@0:             if (null === $default) {
Chris@17:                 $default = [];
Chris@17:             } elseif (!\is_array($default)) {
Chris@0:                 throw new LogicException('A default value for an array argument must be an array.');
Chris@0:             }
Chris@0:         }
Chris@0: 
Chris@0:         $this->default = $default;
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Returns the default value.
Chris@0:      *
Chris@17:      * @return string|string[]|null The default value
Chris@0:      */
Chris@0:     public function getDefault()
Chris@0:     {
Chris@0:         return $this->default;
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Returns the description text.
Chris@0:      *
Chris@0:      * @return string The description text
Chris@0:      */
Chris@0:     public function getDescription()
Chris@0:     {
Chris@0:         return $this->description;
Chris@0:     }
Chris@0: }