| [ Index ] |
PHP Cross Reference of Joomla 4.2.2 documentation |
[Source view] [Print] [Project Stats]
(no description)
| File Size: | 231 lines (7 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
InputOption:: (12 methods):
__construct()
getShortcut()
getName()
acceptValue()
isValueRequired()
isValueOptional()
isArray()
isNegatable()
setDefault()
getDefault()
getDescription()
equals()
Class: InputOption - X-Ref
Represents a command line option.| __construct(string $name, $shortcut = null, int $mode = null, string $description = '', $default = null) X-Ref |
param: string|array|null $shortcut The shortcuts, can be null, a string of shortcuts delimited by | or an array of shortcuts param: int|null $mode The option mode: One of the VALUE_* constants param: string|bool|int|float|array|null $default The default value (must be null for self::VALUE_NONE) |
| getShortcut() X-Ref |
| Returns the option shortcut. return: string|null |
| getName() X-Ref |
| Returns the option name. return: string |
| acceptValue() X-Ref |
| Returns true if the option accepts a value. return: bool true if value mode is not self::VALUE_NONE, false otherwise |
| isValueRequired() X-Ref |
| Returns true if the option requires a value. return: bool true if value mode is self::VALUE_REQUIRED, false otherwise |
| isValueOptional() X-Ref |
| Returns true if the option takes an optional value. return: bool true if value mode is self::VALUE_OPTIONAL, false otherwise |
| isArray() X-Ref |
| Returns true if the option can take multiple values. return: bool true if mode is self::VALUE_IS_ARRAY, false otherwise |
| isNegatable() X-Ref |
| No description |
| setDefault($default = null) X-Ref |
param: string|bool|int|float|array|null $default |
| getDefault() X-Ref |
| Returns the default value. return: string|bool|int|float|array|null |
| getDescription() X-Ref |
| Returns the description text. return: string |
| equals(self $option) X-Ref |
| Checks whether the given option equals this one. return: bool |
| Generated: Wed Sep 7 05:41:13 2022 | Chilli.vc Blog - For Webmaster,Blog-Writer,System Admin and Domainer |