| [ Index ] |
PHP Cross Reference of phpBB-3.1.12-deutsch |
[Source view] [Print] [Project Stats]
(no description)
| File Size: | 209 lines (6 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
InputOption:: (11 methods):
__construct()
getShortcut()
getName()
acceptValue()
isValueRequired()
isValueOptional()
isArray()
setDefault()
getDefault()
getDescription()
equals()
Class: InputOption - X-Ref
Represents a command line option.| __construct($name, $shortcut = null, $mode = null, $description = '', $default = null) X-Ref |
| Constructor. param: string $name The option name param: string|array $shortcut The shortcuts, can be null, a string of shortcuts delimited by | or an array of shortcuts param: int $mode The option mode: One of the VALUE_* constants param: string $description A description text param: mixed $default The default value (must be null for self::VALUE_NONE) |
| getShortcut() X-Ref |
| Returns the option shortcut. return: string The shortcut |
| getName() X-Ref |
| Returns the option name. return: string The name |
| 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 |
| setDefault($default = null) X-Ref |
| Sets the default value. param: mixed $default The default value |
| getDefault() X-Ref |
| Returns the default value. return: mixed The default value |
| getDescription() X-Ref |
| Returns the description text. return: string The description text |
| equals(InputOption $option) X-Ref |
| Checks whether the given option equals this one. param: InputOption $option option to compare return: bool |
| Generated: Thu Jan 11 00:25:41 2018 | Cross-referenced by PHPXref 0.7.1 |