| [ Index ] |
PHP Cross Reference of phpBB-3.3.11-deutsch |
[Source view] [Print] [Project Stats]
(no description)
| File Size: | 404 lines (11 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
InputDefinition:: (22 methods):
__construct()
setDefinition()
setArguments()
addArguments()
addArgument()
getArgument()
hasArgument()
getArguments()
getArgumentCount()
getArgumentRequiredCount()
getArgumentDefaults()
setOptions()
addOptions()
addOption()
getOption()
hasOption()
getOptions()
hasShortcut()
getOptionForShortcut()
getOptionDefaults()
shortcutToName()
getSynopsis()
Class: InputDefinition - X-Ref
A InputDefinition represents a set of valid command line arguments and options.| __construct(array $definition = []) X-Ref |
param: array $definition An array of InputArgument and InputOption instance |
| setDefinition(array $definition) X-Ref |
| Sets the definition of the input. |
| setArguments($arguments = []) X-Ref |
| Sets the InputArgument objects. param: InputArgument[] $arguments An array of InputArgument objects |
| addArguments($arguments = []) X-Ref |
| Adds an array of InputArgument objects. param: InputArgument[] $arguments An array of InputArgument objects |
| addArgument(InputArgument $argument) X-Ref |
| getArgument($name) X-Ref |
| Returns an InputArgument by name or by position. return: InputArgument An InputArgument object param: string|int $name The InputArgument name or position |
| hasArgument($name) X-Ref |
| Returns true if an InputArgument object exists by name or position. return: bool true if the InputArgument object exists, false otherwise param: string|int $name The InputArgument name or position |
| getArguments() X-Ref |
| Gets the array of InputArgument objects. return: InputArgument[] An array of InputArgument objects |
| getArgumentCount() X-Ref |
| Returns the number of InputArguments. return: int The number of InputArguments |
| getArgumentRequiredCount() X-Ref |
| Returns the number of required InputArguments. return: int The number of required InputArguments |
| getArgumentDefaults() X-Ref |
| Gets the default values. return: array An array of default values |
| setOptions($options = []) X-Ref |
| Sets the InputOption objects. param: InputOption[] $options An array of InputOption objects |
| addOptions($options = []) X-Ref |
| Adds an array of InputOption objects. param: InputOption[] $options An array of InputOption objects |
| addOption(InputOption $option) X-Ref |
| getOption($name) X-Ref |
| Returns an InputOption by name. return: InputOption A InputOption object param: string $name The InputOption name |
| hasOption($name) X-Ref |
| Returns true if an InputOption object exists by name. This method can't be used to check if the user included the option when executing the command (use getOption() instead). return: bool true if the InputOption object exists, false otherwise param: string $name The InputOption name |
| getOptions() X-Ref |
| Gets the array of InputOption objects. return: InputOption[] An array of InputOption objects |
| hasShortcut($name) X-Ref |
| Returns true if an InputOption object exists by shortcut. return: bool true if the InputOption object exists, false otherwise param: string $name The InputOption shortcut |
| getOptionForShortcut($shortcut) X-Ref |
| Gets an InputOption by shortcut. return: InputOption An InputOption object param: string $shortcut The Shortcut name |
| getOptionDefaults() X-Ref |
| Gets an array of default values. return: array An array of all default values |
| shortcutToName($shortcut) X-Ref |
| Returns the InputOption name given a shortcut. return: string The InputOption name param: string $shortcut The shortcut |
| getSynopsis($short = false) X-Ref |
| Gets the synopsis. return: string The synopsis param: bool $short Whether to return the short version (with options folded) or not |
| Generated: Sat Nov 4 14:26:03 2023 | Cross-referenced by PHPXref 0.7.1 |