| [ Index ] |
PHP Cross Reference of Joomla 4.2.2 documentation |
[Source view] [Print] [Project Stats]
(no description)
| File Size: | 424 lines (12 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
InputDefinition:: (24 methods):
__construct()
setDefinition()
setArguments()
addArguments()
addArgument()
getArgument()
hasArgument()
getArguments()
getArgumentCount()
getArgumentRequiredCount()
getArgumentDefaults()
setOptions()
addOptions()
addOption()
getOption()
hasOption()
getOptions()
hasShortcut()
hasNegation()
getOptionForShortcut()
getOptionDefaults()
shortcutToName()
negationToName()
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(array $arguments = []) X-Ref |
| Sets the InputArgument objects. param: InputArgument[] $arguments An array of InputArgument objects |
| addArguments(?array $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. param: string|int $name The InputArgument name or position return: InputArgument |
| hasArgument($name) X-Ref |
| Returns true if an InputArgument object exists by name or position. param: string|int $name The InputArgument name or position return: bool |
| getArguments() X-Ref |
| Gets the array of InputArgument objects. return: InputArgument[] |
| getArgumentCount() X-Ref |
| Returns the number of InputArguments. return: int |
| getArgumentRequiredCount() X-Ref |
| Returns the number of required InputArguments. return: int |
| getArgumentDefaults() X-Ref |
return: array<string|bool|int|float|array|null> |
| setOptions(array $options = []) X-Ref |
| Sets the InputOption objects. param: InputOption[] $options An array of InputOption objects |
| addOptions(array $options = []) X-Ref |
| Adds an array of InputOption objects. param: InputOption[] $options An array of InputOption objects |
| addOption(InputOption $option) X-Ref |
| getOption(string $name) X-Ref |
| Returns an InputOption by name. return: InputOption |
| hasOption(string $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 |
| getOptions() X-Ref |
| Gets the array of InputOption objects. return: InputOption[] |
| hasShortcut(string $name) X-Ref |
| Returns true if an InputOption object exists by shortcut. return: bool |
| hasNegation(string $name) X-Ref |
| Returns true if an InputOption object exists by negated name. |
| getOptionForShortcut(string $shortcut) X-Ref |
| Gets an InputOption by shortcut. return: InputOption |
| getOptionDefaults() X-Ref |
return: array<string|bool|int|float|array|null> |
| shortcutToName(string $shortcut) X-Ref |
| Returns the InputOption name given a shortcut. |
| negationToName(string $negation) X-Ref |
| Returns the InputOption name given a negation. |
| getSynopsis(bool $short = false) X-Ref |
| Gets the synopsis. return: string |
| Generated: Wed Sep 7 05:41:13 2022 | Chilli.vc Blog - For Webmaster,Blog-Writer,System Admin and Domainer |