| [ Index ] |
PHP Cross Reference of Joomla 4.2.2 documentation |
[Source view] [Print] [Project Stats]
An input specialized for shell completion. This input allows unfinished option names or values and exposes what kind of completion is expected.
| Author: | Wouter de Jong <[email protected]> |
| File Size: | 249 lines (8 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
| fromString(string $inputStr, int $currentIndex) X-Ref |
| Converts a terminal string into tokens. This is required for shell completions without COMP_WORDS support. |
| fromTokens(array $tokens, int $currentIndex) X-Ref |
| Create an input based on an COMP_WORDS token list. param: string[] $tokens the set of split tokens (e.g. COMP_WORDS or argv) param: $currentIndex the index of the cursor (e.g. COMP_CWORD) |
| bind(InputDefinition $definition) X-Ref |
| {@inheritdoc} |
| getCompletionType() X-Ref |
| Returns the type of completion required. TYPE_ARGUMENT_VALUE when completing the value of an input argument TYPE_OPTION_VALUE when completing the value of an input option TYPE_OPTION_NAME when completing the name of an input option TYPE_NONE when nothing should be completed return: string One of self::TYPE_* constants. TYPE_OPTION_NAME and TYPE_NONE are already implemented by the Console component |
| getCompletionName() X-Ref |
| The name of the input option or argument when completing a value. return: string|null returns null when completing an option name |
| getCompletionValue() X-Ref |
| The value already typed by the user (or empty string). |
| mustSuggestOptionValuesFor(string $optionName) X-Ref |
| No description |
| mustSuggestArgumentValuesFor(string $argumentName) X-Ref |
| No description |
| parseToken(string $token, bool $parseOptions) X-Ref |
| No description |
| getOptionFromToken(string $optionToken) X-Ref |
| No description |
| getRelevantToken() X-Ref |
| The token of the cursor, or the last token if the cursor is at the end of the input. |
| isCursorFree() X-Ref |
| Whether the cursor is "free" (i.e. at the end of the input preceded by a space). |
| __toString() X-Ref |
| No description |
| Generated: Wed Sep 7 05:41:13 2022 | Chilli.vc Blog - For Webmaster,Blog-Writer,System Admin and Domainer |