Symfony\Component\Console\Input\InputDefinition
A InputDefinition represents a set of valid command line arguments and options.
Usage:
$definition = new InputDefinition(array(
new InputArgument('name', InputArgument::REQUIRED),
new InputOption('foo', 'f', InputOption::VALUE_REQUIRED),
));
- Author: Fabien Potencier <fabien@symfony.com>
Synopsis
class InputDefinition
{
- // members
- private $arguments;
- private $requiredCount;
- private $hasAnArrayArgument;
- private $hasOptional;
- private $options;
- private $shortcuts;
- // methods
- public void __construct()
- public void setDefinition()
- public void setArguments()
- public void addArguments()
- public void addArgument()
- public InputArgument getArgument()
- public Boolean hasArgument()
- public array getArguments()
- public integer getArgumentCount()
- public integer getArgumentRequiredCount()
- public array getArgumentDefaults()
- public void setOptions()
- public void addOptions()
- public void addOption()
- public InputOption getOption()
- public Boolean hasOption()
- public array getOptions()
- public Boolean hasShortcut()
- public InputOption getOptionForShortcut()
- public array getOptionDefaults()
- private string shortcutToName()
- public string getSynopsis()
- public string asText()
- public DOMDocument asXml()
Members
private
- $arguments
- $hasAnArrayArgument
- $hasOptional
- $options
- $requiredCount
- $shortcuts
Methods
private
- shortcutToName() — Returns the InputOption name given a shortcut.
public
- __construct() — Constructor.
- addArgument() — Adds an InputArgument object.
- addArguments() — Adds an array of InputArgument objects.
- addOption() — Adds an InputOption object.
- addOptions() — Adds an array of InputOption objects.
- asText() — Returns a textual representation of the InputDefinition.
- asXml() — Returns an XML representation of the InputDefinition.
- getArgument() — Returns an InputArgument by name or by position.
- getArgumentCount() — Returns the number of InputArguments.
- getArgumentDefaults() — Gets the default values.
- getArgumentRequiredCount() — Returns the number of required InputArguments.
- getArguments() — Gets the array of InputArgument objects.
- getOption() — Returns an InputOption by name.
- getOptionDefaults() — Gets an array of default values.
- getOptionForShortcut() — Gets an InputOption by shortcut.
- getOptions() — Gets the array of InputOption objects.
- getSynopsis() — Gets the synopsis.
- hasArgument() — Returns true if an InputArgument object exists by name or position.
- hasOption() — Returns true if an InputOption object exists by name.
- hasShortcut() — Returns true if an InputOption object exists by shortcut.
- setArguments() — Sets the InputArgument objects.
- setDefinition() — Sets the definition of the input.
- setOptions() — Sets the InputOption objects.