abstract class Input implements InputInterface, StreamableInputInterface
Input is the base class for all concrete Input classes.
Three concrete classes are provided by default:
ArgvInput
: The input comes from the CLI arguments (argv)StringInput
: The input is provided as a stringArrayInput
: The input is provided as an arrayprotected | $definition | ||
protected | $stream | ||
protected | $options | ||
protected | $arguments | ||
protected | $interactive |
__construct(InputDefinition $definition = null) | ||
bind(InputDefinition $definition) Binds the current Input instance with the given arguments and options. | ||
parse() Processes command line arguments. | ||
validate() Validates the input. | ||
bool | isInteractive() Is this input means interactive? | |
setInteractive(bool $interactive) Sets the input interactivity. | ||
array | getArguments() Returns all the given arguments merged with the default values. | |
string|string[]|null | getArgument(string $name) Returns the argument value for a given argument name. | |
setArgument(string $name, string|string[]|null $value) Sets an argument value by name. | ||
bool | hasArgument(string|int $name) Returns true if an InputArgument object exists by name or position. | |
array | getOptions() Returns all the given options merged with the default values. | |
string|string[]|bool|null | getOption(string $name) Returns the option value for a given option name. | |
setOption(string $name, string|string[]|bool|null $value) Sets an option value by name. | ||
bool | hasOption(string $name) Returns true if an InputOption object exists by name. | |
string | escapeToken(string $token) Escapes a token through escapeshellarg if it contains unsafe chars. | |
setStream(resource $stream) Sets the input stream to read from when interacting with the user. | ||
resource|null | getStream() Returns the input stream. |
InputDefinition | $definition |
Binds the current Input instance with the given arguments and options.
InputDefinition | $definition |
RuntimeException |
Processes command line arguments.
Validates the input.
RuntimeException | When not enough arguments are given |
Is this input means interactive?
bool |
Sets the input interactivity.
bool | $interactive | If the input should be interactive |
Returns all the given arguments merged with the default values.
array |
Returns the argument value for a given argument name.
string | $name | The argument name |
string|string[]|null | The argument value |
InvalidArgumentException | When argument given doesn't exist |
Sets an argument value by name.
string | $name | The argument name |
string|string[]|null | $value | The argument value |
InvalidArgumentException | When argument given doesn't exist |
Returns true if an InputArgument object exists by name or position.
string|int | $name | The InputArgument name or position |
bool | true if the InputArgument object exists, false otherwise |
Returns all the given options merged with the default values.
array |
Returns the option value for a given option name.
string | $name | The option name |
string|string[]|bool|null | The option value |
InvalidArgumentException | When option given doesn't exist |
Sets an option value by name.
string | $name | The option name |
string|string[]|bool|null | $value | The option value |
InvalidArgumentException | When option given doesn't exist |
Returns true if an InputOption object exists by name.
string | $name | The InputOption name |
bool | true if the InputOption object exists, false otherwise |
Escapes a token through escapeshellarg if it contains unsafe chars.
string | $token |
string |
Sets the input stream to read from when interacting with the user.
This is mainly useful for testing purpose.
resource | $stream | The input stream |
Returns the input stream.
resource|null |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
https://api.symfony.com/4.1/Symfony/Component/Console/Input/Input.html