Symfony\Component\Console\Input\Input
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
- Author: Fabien Potencier <fabien@symfony.com>
Synopsis
class Input
implements
InputInterface
{
- // members
- protected $definition;
- protected $options;
- protected $arguments;
- protected $interactive;
- // methods
- public void __construct()
- public void bind()
- protected abstract void parse()
- public void validate()
- public Boolean isInteractive()
- public void setInteractive()
- 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 string escapeToken()
Hierarchy
Extended by
- Symfony\Component\Console\Input\StringInput
- Symfony\Component\Console\Input\ArrayInput
- Symfony\Component\Console\Input\ArgvInput
Implements
Members
protected
- $arguments
- $definition
- $interactive
- $options
Methods
protected
- parse() — Processes command line arguments.
public
- __construct() — Constructor.
- bind() — Binds the current Input instance with the given arguments and options.
- escapeToken() — Escapes a token through escapeshellarg if it contains unsafe chars
- getArgument() — Returns the argument value for a given argument name.
- getArguments() — Returns the argument values.
- getOption() — Returns the option value for a given option name.
- getOptions() — Returns the options values.
- hasArgument() — Returns true if an InputArgument object exists by name or position.
- hasOption() — Returns true if an InputOption object exists by name.
- isInteractive() — Checks if the input is interactive.
- setArgument() — Sets an argument value by name.
- setInteractive() — Sets the input interactivity.
- setOption() — Sets an option value by name.
- validate() — Validates the input.