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 array __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. | |
setStream(resource $stream) Sets the input stream to read from when interacting with the user. | ||
resource|null | getStream() Returns the input stream. |
Constructor.
Binds the current Input instance with the given arguments and options.
Validates the input.
Is this input means interactive?
Sets the input interactivity.
Returns all the given arguments merged with the default values.
Returns the argument value for a given argument name.
Sets an argument value by name.
Returns true if an InputArgument object exists by name or position.
Returns all the given options merged with the default values.
Returns the option value for a given option name.
Sets an option value by name.
Returns true if an InputOption object exists by name.
Escapes a token through escapeshellarg if it contains unsafe chars.
Sets the input stream to read from when interacting with the user.
This is mainly useful for testing purpose.
Returns the input stream.
© 2004–2016 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/3.2/Symfony/Component/Console/Input/Input.html