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 option.
Chris@0:  *
Chris@0:  * @author Fabien Potencier <fabien@symfony.com>
Chris@0:  */
Chris@0: class InputOption
Chris@0: {
Chris@0:     const VALUE_NONE = 1;
Chris@0:     const VALUE_REQUIRED = 2;
Chris@0:     const VALUE_OPTIONAL = 4;
Chris@0:     const VALUE_IS_ARRAY = 8;
Chris@0: 
Chris@0:     private $name;
Chris@0:     private $shortcut;
Chris@0:     private $mode;
Chris@0:     private $default;
Chris@0:     private $description;
Chris@0: 
Chris@0:     /**
Chris@17:      * @param string                        $name        The option name
Chris@17:      * @param string|array|null             $shortcut    The shortcuts, can be null, a string of shortcuts delimited by | or an array of shortcuts
Chris@17:      * @param int|null                      $mode        The option mode: One of the VALUE_* constants
Chris@17:      * @param string                        $description A description text
Chris@17:      * @param string|string[]|int|bool|null $default     The default value (must be null for self::VALUE_NONE)
Chris@0:      *
Chris@0:      * @throws InvalidArgumentException If option mode is invalid or incompatible
Chris@0:      */
Chris@0:     public function __construct($name, $shortcut = null, $mode = null, $description = '', $default = null)
Chris@0:     {
Chris@0:         if (0 === strpos($name, '--')) {
Chris@0:             $name = substr($name, 2);
Chris@0:         }
Chris@0: 
Chris@0:         if (empty($name)) {
Chris@0:             throw new InvalidArgumentException('An option name cannot be empty.');
Chris@0:         }
Chris@0: 
Chris@0:         if (empty($shortcut)) {
Chris@0:             $shortcut = null;
Chris@0:         }
Chris@0: 
Chris@0:         if (null !== $shortcut) {
Chris@17:             if (\is_array($shortcut)) {
Chris@0:                 $shortcut = implode('|', $shortcut);
Chris@0:             }
Chris@0:             $shortcuts = preg_split('{(\|)-?}', ltrim($shortcut, '-'));
Chris@0:             $shortcuts = array_filter($shortcuts);
Chris@0:             $shortcut = implode('|', $shortcuts);
Chris@0: 
Chris@0:             if (empty($shortcut)) {
Chris@0:                 throw new InvalidArgumentException('An option shortcut cannot be empty.');
Chris@0:             }
Chris@0:         }
Chris@0: 
Chris@0:         if (null === $mode) {
Chris@0:             $mode = self::VALUE_NONE;
Chris@17:         } elseif (!\is_int($mode) || $mode > 15 || $mode < 1) {
Chris@0:             throw new InvalidArgumentException(sprintf('Option mode "%s" is not valid.', $mode));
Chris@0:         }
Chris@0: 
Chris@0:         $this->name = $name;
Chris@0:         $this->shortcut = $shortcut;
Chris@0:         $this->mode = $mode;
Chris@0:         $this->description = $description;
Chris@0: 
Chris@0:         if ($this->isArray() && !$this->acceptValue()) {
Chris@0:             throw new InvalidArgumentException('Impossible to have an option mode VALUE_IS_ARRAY if the option does not accept a value.');
Chris@0:         }
Chris@0: 
Chris@0:         $this->setDefault($default);
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Returns the option shortcut.
Chris@0:      *
Chris@17:      * @return string|null The shortcut
Chris@0:      */
Chris@0:     public function getShortcut()
Chris@0:     {
Chris@0:         return $this->shortcut;
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Returns the option name.
Chris@0:      *
Chris@0:      * @return string The 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 option accepts a value.
Chris@0:      *
Chris@0:      * @return bool true if value mode is not self::VALUE_NONE, false otherwise
Chris@0:      */
Chris@0:     public function acceptValue()
Chris@0:     {
Chris@0:         return $this->isValueRequired() || $this->isValueOptional();
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Returns true if the option requires a value.
Chris@0:      *
Chris@0:      * @return bool true if value mode is self::VALUE_REQUIRED, false otherwise
Chris@0:      */
Chris@0:     public function isValueRequired()
Chris@0:     {
Chris@0:         return self::VALUE_REQUIRED === (self::VALUE_REQUIRED & $this->mode);
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Returns true if the option takes an optional value.
Chris@0:      *
Chris@0:      * @return bool true if value mode is self::VALUE_OPTIONAL, false otherwise
Chris@0:      */
Chris@0:     public function isValueOptional()
Chris@0:     {
Chris@0:         return self::VALUE_OPTIONAL === (self::VALUE_OPTIONAL & $this->mode);
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Returns true if the option can take multiple values.
Chris@0:      *
Chris@0:      * @return bool true if mode is self::VALUE_IS_ARRAY, false otherwise
Chris@0:      */
Chris@0:     public function isArray()
Chris@0:     {
Chris@0:         return self::VALUE_IS_ARRAY === (self::VALUE_IS_ARRAY & $this->mode);
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Sets the default value.
Chris@0:      *
Chris@17:      * @param string|string[]|int|bool|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::VALUE_NONE === (self::VALUE_NONE & $this->mode) && null !== $default) {
Chris@0:             throw new LogicException('Cannot set a default value when using InputOption::VALUE_NONE 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 option must be an array.');
Chris@0:             }
Chris@0:         }
Chris@0: 
Chris@0:         $this->default = $this->acceptValue() ? $default : false;
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Returns the default value.
Chris@0:      *
Chris@17:      * @return string|string[]|int|bool|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: 
Chris@0:     /**
Chris@0:      * Checks whether the given option equals this one.
Chris@0:      *
Chris@0:      * @return bool
Chris@0:      */
Chris@16:     public function equals(self $option)
Chris@0:     {
Chris@0:         return $option->getName() === $this->getName()
Chris@0:             && $option->getShortcut() === $this->getShortcut()
Chris@0:             && $option->getDefault() === $this->getDefault()
Chris@0:             && $option->isArray() === $this->isArray()
Chris@0:             && $option->isValueRequired() === $this->isValueRequired()
Chris@0:             && $option->isValueOptional() === $this->isValueOptional()
Chris@0:         ;
Chris@0:     }
Chris@0: }