Input\Input (Component\Console)
Symfony\Component\Console\Input\Input
abstract 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() Checks if the input is interactive. | |
setInteractive(bool $interactive) Sets the input interactivity. | ||
array | getArguments() Returns the argument 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 the options 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
public __construct(InputDefinition $definition = null)
Constructor.
public bind(InputDefinition $definition)
Binds the current Input instance with the given arguments and options.
public validate()
Validates the input.
public bool isInteractive()
Checks if the input is interactive.
public setInteractive(bool $interactive)
Sets the input interactivity.
public array getArguments()
Returns the argument values.
public mixed getArgument(string $name)
Returns the argument value for a given argument name.
public setArgument(string $name, string $value)
Sets an argument value by name.
public bool hasArgument(string|int $name)
Returns true if an InputArgument object exists by name or position.
public array getOptions()
Returns the options values.
public mixed getOption(string $name)
Returns the option value for a given option name.
public setOption(string $name, string|bool $value)
Sets an option value by name.
public bool hasOption(string $name)
Returns true if an InputOption object exists by name.
public string escapeToken(string $token)
Escapes a token through escapeshellarg if it contains unsafe chars.
© 2004–2016 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/3.0/Symfony/Component/Console/Input/Input.html