ArgvInput.php
2 years ago
ArrayInput.php
2 years ago
Input.php
2 years ago
InputArgument.php
2 years ago
InputAwareInterface.php
2 years ago
InputDefinition.php
2 years ago
InputInterface.php
2 years ago
InputOption.php
2 years ago
StreamableInputInterface.php
2 years ago
StringInput.php
2 years ago
InputArgument.php
117 lines
| 1 | <?php |
| 2 | |
| 3 | /* |
| 4 | * This file is part of the Symfony package. |
| 5 | * |
| 6 | * (c) Fabien Potencier <fabien@symfony.com> |
| 7 | * |
| 8 | * For the full copyright and license information, please view the LICENSE |
| 9 | * file that was distributed with this source code. |
| 10 | */ |
| 11 | namespace IAWP_SCOPED\Symfony\Component\Console\Input; |
| 12 | |
| 13 | use IAWP_SCOPED\Symfony\Component\Console\Exception\InvalidArgumentException; |
| 14 | use IAWP_SCOPED\Symfony\Component\Console\Exception\LogicException; |
| 15 | /** |
| 16 | * Represents a command line argument. |
| 17 | * |
| 18 | * @author Fabien Potencier <fabien@symfony.com> |
| 19 | * @internal |
| 20 | */ |
| 21 | class InputArgument |
| 22 | { |
| 23 | public const REQUIRED = 1; |
| 24 | public const OPTIONAL = 2; |
| 25 | public const IS_ARRAY = 4; |
| 26 | private $name; |
| 27 | private $mode; |
| 28 | private $default; |
| 29 | private $description; |
| 30 | /** |
| 31 | * @param string $name The argument name |
| 32 | * @param int|null $mode The argument mode: a bit mask of self::REQUIRED, self::OPTIONAL and self::IS_ARRAY |
| 33 | * @param string $description A description text |
| 34 | * @param string|bool|int|float|array|null $default The default value (for self::OPTIONAL mode only) |
| 35 | * |
| 36 | * @throws InvalidArgumentException When argument mode is not valid |
| 37 | */ |
| 38 | public function __construct(string $name, int $mode = null, string $description = '', $default = null) |
| 39 | { |
| 40 | if (null === $mode) { |
| 41 | $mode = self::OPTIONAL; |
| 42 | } elseif ($mode > 7 || $mode < 1) { |
| 43 | throw new InvalidArgumentException(\sprintf('Argument mode "%s" is not valid.', $mode)); |
| 44 | } |
| 45 | $this->name = $name; |
| 46 | $this->mode = $mode; |
| 47 | $this->description = $description; |
| 48 | $this->setDefault($default); |
| 49 | } |
| 50 | /** |
| 51 | * Returns the argument name. |
| 52 | * |
| 53 | * @return string |
| 54 | */ |
| 55 | public function getName() |
| 56 | { |
| 57 | return $this->name; |
| 58 | } |
| 59 | /** |
| 60 | * Returns true if the argument is required. |
| 61 | * |
| 62 | * @return bool true if parameter mode is self::REQUIRED, false otherwise |
| 63 | */ |
| 64 | public function isRequired() |
| 65 | { |
| 66 | return self::REQUIRED === (self::REQUIRED & $this->mode); |
| 67 | } |
| 68 | /** |
| 69 | * Returns true if the argument can take multiple values. |
| 70 | * |
| 71 | * @return bool true if mode is self::IS_ARRAY, false otherwise |
| 72 | */ |
| 73 | public function isArray() |
| 74 | { |
| 75 | return self::IS_ARRAY === (self::IS_ARRAY & $this->mode); |
| 76 | } |
| 77 | /** |
| 78 | * Sets the default value. |
| 79 | * |
| 80 | * @param string|bool|int|float|array|null $default |
| 81 | * |
| 82 | * @throws LogicException When incorrect default value is given |
| 83 | */ |
| 84 | public function setDefault($default = null) |
| 85 | { |
| 86 | if ($this->isRequired() && null !== $default) { |
| 87 | throw new LogicException('Cannot set a default value except for InputArgument::OPTIONAL mode.'); |
| 88 | } |
| 89 | if ($this->isArray()) { |
| 90 | if (null === $default) { |
| 91 | $default = []; |
| 92 | } elseif (!\is_array($default)) { |
| 93 | throw new LogicException('A default value for an array argument must be an array.'); |
| 94 | } |
| 95 | } |
| 96 | $this->default = $default; |
| 97 | } |
| 98 | /** |
| 99 | * Returns the default value. |
| 100 | * |
| 101 | * @return string|bool|int|float|array|null |
| 102 | */ |
| 103 | public function getDefault() |
| 104 | { |
| 105 | return $this->default; |
| 106 | } |
| 107 | /** |
| 108 | * Returns the description text. |
| 109 | * |
| 110 | * @return string |
| 111 | */ |
| 112 | public function getDescription() |
| 113 | { |
| 114 | return $this->description; |
| 115 | } |
| 116 | } |
| 117 |