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
InputInterface.php
137 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\RuntimeException; |
| 15 | /** |
| 16 | * InputInterface is the interface implemented by all input classes. |
| 17 | * |
| 18 | * @author Fabien Potencier <fabien@symfony.com> |
| 19 | * @internal |
| 20 | */ |
| 21 | interface InputInterface |
| 22 | { |
| 23 | /** |
| 24 | * Returns the first argument from the raw parameters (not parsed). |
| 25 | * |
| 26 | * @return string|null |
| 27 | */ |
| 28 | public function getFirstArgument(); |
| 29 | /** |
| 30 | * Returns true if the raw parameters (not parsed) contain a value. |
| 31 | * |
| 32 | * This method is to be used to introspect the input parameters |
| 33 | * before they have been validated. It must be used carefully. |
| 34 | * Does not necessarily return the correct result for short options |
| 35 | * when multiple flags are combined in the same option. |
| 36 | * |
| 37 | * @param string|array $values The values to look for in the raw parameters (can be an array) |
| 38 | * @param bool $onlyParams Only check real parameters, skip those following an end of options (--) signal |
| 39 | * |
| 40 | * @return bool |
| 41 | */ |
| 42 | public function hasParameterOption($values, bool $onlyParams = \false); |
| 43 | /** |
| 44 | * Returns the value of a raw option (not parsed). |
| 45 | * |
| 46 | * This method is to be used to introspect the input parameters |
| 47 | * before they have been validated. It must be used carefully. |
| 48 | * Does not necessarily return the correct result for short options |
| 49 | * when multiple flags are combined in the same option. |
| 50 | * |
| 51 | * @param string|array $values The value(s) to look for in the raw parameters (can be an array) |
| 52 | * @param string|bool|int|float|array|null $default The default value to return if no result is found |
| 53 | * @param bool $onlyParams Only check real parameters, skip those following an end of options (--) signal |
| 54 | * |
| 55 | * @return mixed |
| 56 | */ |
| 57 | public function getParameterOption($values, $default = \false, bool $onlyParams = \false); |
| 58 | /** |
| 59 | * Binds the current Input instance with the given arguments and options. |
| 60 | * |
| 61 | * @throws RuntimeException |
| 62 | */ |
| 63 | public function bind(InputDefinition $definition); |
| 64 | /** |
| 65 | * Validates the input. |
| 66 | * |
| 67 | * @throws RuntimeException When not enough arguments are given |
| 68 | */ |
| 69 | public function validate(); |
| 70 | /** |
| 71 | * Returns all the given arguments merged with the default values. |
| 72 | * |
| 73 | * @return array<string|bool|int|float|array|null> |
| 74 | */ |
| 75 | public function getArguments(); |
| 76 | /** |
| 77 | * Returns the argument value for a given argument name. |
| 78 | * |
| 79 | * @return mixed |
| 80 | * |
| 81 | * @throws InvalidArgumentException When argument given doesn't exist |
| 82 | */ |
| 83 | public function getArgument(string $name); |
| 84 | /** |
| 85 | * Sets an argument value by name. |
| 86 | * |
| 87 | * @param mixed $value The argument value |
| 88 | * |
| 89 | * @throws InvalidArgumentException When argument given doesn't exist |
| 90 | */ |
| 91 | public function setArgument(string $name, $value); |
| 92 | /** |
| 93 | * Returns true if an InputArgument object exists by name or position. |
| 94 | * |
| 95 | * @return bool |
| 96 | */ |
| 97 | public function hasArgument(string $name); |
| 98 | /** |
| 99 | * Returns all the given options merged with the default values. |
| 100 | * |
| 101 | * @return array<string|bool|int|float|array|null> |
| 102 | */ |
| 103 | public function getOptions(); |
| 104 | /** |
| 105 | * Returns the option value for a given option name. |
| 106 | * |
| 107 | * @return mixed |
| 108 | * |
| 109 | * @throws InvalidArgumentException When option given doesn't exist |
| 110 | */ |
| 111 | public function getOption(string $name); |
| 112 | /** |
| 113 | * Sets an option value by name. |
| 114 | * |
| 115 | * @param mixed $value The option value |
| 116 | * |
| 117 | * @throws InvalidArgumentException When option given doesn't exist |
| 118 | */ |
| 119 | public function setOption(string $name, $value); |
| 120 | /** |
| 121 | * Returns true if an InputOption object exists by name. |
| 122 | * |
| 123 | * @return bool |
| 124 | */ |
| 125 | public function hasOption(string $name); |
| 126 | /** |
| 127 | * Is this input means interactive? |
| 128 | * |
| 129 | * @return bool |
| 130 | */ |
| 131 | public function isInteractive(); |
| 132 | /** |
| 133 | * Sets the input interactivity. |
| 134 | */ |
| 135 | public function setInteractive(bool $interactive); |
| 136 | } |
| 137 |