Symfony\Component\Console\Input\InputInterface
InputInterface is the interface implemented by all input classes.
- Author: Fabien Potencier <fabien@symfony.com>
Synopsis
interface InputInterface
{
- // methods
- public string getFirstArgument()
- public Boolean hasParameterOption()
- public mixed getParameterOption()
- public void bind()
- public void validate()
- public array getArguments()
- public mixed getArgument()
- public void setArgument()
- public Boolean hasArgument()
- public array getOptions()
- public mixed getOption()
- public void setOption()
- public Boolean hasOption()
- public Boolean isInteractive()
- public void setInteractive()
Methods
public
- bind() — Binds the current Input instance with the given arguments and options.
- getArgument() — Gets argument by name.
- getArguments() — Returns all the given arguments merged with the default values.
- getFirstArgument() — Returns the first argument from the raw parameters (not parsed).
- getOption() — Gets an option by name.
- getOptions() — Returns all the given options merged with the default values.
- getParameterOption() — Returns the value of a raw option (not parsed).
- hasArgument() — Returns true if an InputArgument object exists by name or position.
- hasOption() — Returns true if an InputOption object exists by name.
- hasParameterOption() — Returns true if the raw parameters (not parsed) contain a value.
- isInteractive() — Is this input means interactive?
- setArgument() — Sets an argument value by name.
- setInteractive() — Sets the input interactivity.
- setOption() — Sets an option value by name.
- validate() — Validates if arguments given are correct.