Input
Input
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 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. | |
setStream(resource $stream) Sets the input stream to read from when interacting with the user. | ||
resource|null | getStream() Returns the input stream. |
Details
__construct(InputDefinition $definition = null)
Constructor.
Parameters
InputDefinition | $definition | A InputDefinition instance |
bind(InputDefinition $definition)
Binds the current Input instance with the given arguments and options.
Parameters
InputDefinition | $definition | A InputDefinition instance |
validate()
Validates the input.
Exceptions
RuntimeException | When not enough arguments are given |
bool isInteractive()
Is this input means interactive?
Return Value
bool |
setInteractive(bool $interactive)
Sets the input interactivity.
Parameters
bool | $interactive | If the input should be interactive |
array getArguments()
Returns all the given arguments merged with the default values.
Return Value
array |
mixed getArgument(string $name)
Returns the argument value for a given argument name.
Parameters
string | $name | The argument name |
Return Value
mixed | The argument value |
Exceptions
InvalidArgumentException | When argument given doesn't exist |
setArgument(string $name, string $value)
Sets an argument value by name.
Parameters
string | $name | The argument name |
string | $value | The argument value |
Exceptions
InvalidArgumentException | When argument given doesn't exist |
bool hasArgument(string|int $name)
Returns true if an InputArgument object exists by name or position.
Parameters
string|int | $name | The InputArgument name or position |
Return Value
bool | true if the InputArgument object exists, false otherwise |
array getOptions()
Returns all the given options merged with the default values.
Return Value
array |
mixed getOption(string $name)
Returns the option value for a given option name.
Parameters
string | $name | The option name |
Return Value
mixed | The option value |
Exceptions
InvalidArgumentException | When option given doesn't exist |
setOption(string $name, string|bool $value)
Sets an option value by name.
Parameters
string | $name | The option name |
string|bool | $value | The option value |
Exceptions
InvalidArgumentException | When option given doesn't exist |
bool hasOption(string $name)
Returns true if an InputOption object exists by name.
Parameters
string | $name | The InputOption name |
Return Value
bool | true if the InputOption object exists, false otherwise |
string escapeToken(string $token)
Escapes a token through escapeshellarg if it contains unsafe chars.
Parameters
string | $token |
Return Value
string |
setStream(resource $stream)
Sets the input stream to read from when interacting with the user.
This is mainly useful for testing purpose.
Parameters
resource | $stream | The input stream |
resource|null getStream()
Returns the input stream.
Return Value
resource|null |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/3.2/Symfony/Component/Console/Input/Input.html