class Input implements InputInterface
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 string -
ArrayInput: The input is provided as an array
Methods
| __construct(InputDefinition $definition = null) Constructor. | ||
| bind(InputDefinition $definition) Binds the current Input instance with the given arguments and options. | ||
| 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. | |
| mixed | getArgument(string $name) Returns the argument value for a given argument name. | |
| setArgument(string $name, string $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. | |
| mixed | getOption(string $name) Returns the option value for a given option name. | |
| setOption(string $name, string|bool $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. |
Details
__construct(InputDefinition $definition = null)
Constructor.
bind(InputDefinition $definition)
Binds the current Input instance with the given arguments and options.
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.
mixed getArgument(string $name)
Returns the argument value for a given argument name.
setArgument(string $name, string $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.
mixed getOption(string $name)
Returns the option value for a given option name.
setOption(string $name, string|bool $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.
Please login to continue.