Input\InputDefinition (Component\Console)
Symfony\Component\Console\Input\InputDefinition
class 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),
));
Methods
__construct(array $definition = array()) Constructor. | ||
setDefinition(array $definition) Sets the definition of the input. | ||
setArguments(InputArgument[] $arguments = array()) Sets the InputArgument objects. | ||
addArguments(InputArgument[] $arguments = array()) Adds an array of InputArgument objects. | ||
addArgument(InputArgument $argument) Adds an InputArgument object. | ||
InputArgument | getArgument(string|int $name) Returns an InputArgument by name or by position. | |
bool | hasArgument(string|int $name) Returns true if an InputArgument object exists by name or position. | |
InputArgument[] | getArguments() Gets the array of InputArgument objects. | |
int | getArgumentCount() Returns the number of InputArguments. | |
int | getArgumentRequiredCount() Returns the number of required InputArguments. | |
array | getArgumentDefaults() Gets the default values. | |
setOptions(InputOption[] $options = array()) Sets the InputOption objects. | ||
addOptions(InputOption[] $options = array()) Adds an array of InputOption objects. | ||
addOption(InputOption $option) Adds an InputOption object. | ||
InputOption | getOption(string $name) Returns an InputOption by name. | |
bool | hasOption(string $name) Returns true if an InputOption object exists by name. | |
InputOption[] | getOptions() Gets the array of InputOption objects. | |
bool | hasShortcut(string $name) Returns true if an InputOption object exists by shortcut. | |
InputOption | getOptionForShortcut(string $shortcut) Gets an InputOption by shortcut. | |
array | getOptionDefaults() Gets an array of default values. | |
string | getSynopsis(bool $short = false) Gets the synopsis. |
Details
public __construct(array $definition = array())
Constructor.
public setDefinition(array $definition)
Sets the definition of the input.
public setArguments(InputArgument[] $arguments = array())
Sets the InputArgument objects.
public addArguments(InputArgument[] $arguments = array())
Adds an array of InputArgument objects.
public addArgument(InputArgument $argument)
Adds an InputArgument object.
public InputArgument getArgument(string|int $name)
Returns an InputArgument by name or by position.
public bool hasArgument(string|int $name)
Returns true if an InputArgument object exists by name or position.
public InputArgument[] getArguments()
Gets the array of InputArgument objects.
public int getArgumentCount()
Returns the number of InputArguments.
public int getArgumentRequiredCount()
Returns the number of required InputArguments.
public array getArgumentDefaults()
Gets the default values.
public setOptions(InputOption[] $options = array())
Sets the InputOption objects.
public addOptions(InputOption[] $options = array())
Adds an array of InputOption objects.
public addOption(InputOption $option)
Adds an InputOption object.
public InputOption getOption(string $name)
Returns an InputOption by name.
public bool hasOption(string $name)
Returns true if an InputOption object exists by name.
public InputOption[] getOptions()
Gets the array of InputOption objects.
public bool hasShortcut(string $name)
Returns true if an InputOption object exists by shortcut.
public InputOption getOptionForShortcut(string $shortcut)
Gets an InputOption by shortcut.
public array getOptionDefaults()
Gets an array of default values.
public string getSynopsis(bool $short = false)
Gets the synopsis.
© 2004–2016 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/3.0/Symfony/Component/Console/Input/InputDefinition.html