Joomla CMS  4.2.2
Documentation des API du CMS Joomla en version 4.2.2
Référence de la classe CompletionInput
+ Graphe d'héritage de CompletionInput:

Fonctions membres publiques

 bind (InputDefinition $definition)
 getCompletionType ()
 getCompletionName ()
 getCompletionValue ()
 mustSuggestOptionValuesFor (string $optionName)
 mustSuggestArgumentValuesFor (string $argumentName)
 __toString ()
- Fonctions membres publiques hérités de ArgvInput
 __construct (array $argv=null, InputDefinition $definition=null)
 getFirstArgument ()
 hasParameterOption ($values, bool $onlyParams=false)
 getParameterOption ($values, $default=false, bool $onlyParams=false)
 __toString ()
- Fonctions membres publiques hérités de Input
 __construct (InputDefinition $definition=null)
 bind (InputDefinition $definition)
 validate ()
 isInteractive ()
 setInteractive (bool $interactive)
 getArguments ()
 getArgument (string $name)
 setArgument (string $name, $value)
 hasArgument (string $name)
 getOptions ()
 getOption (string $name)
 setOption (string $name, $value)
 hasOption (string $name)
 escapeToken (string $token)
 setStream ($stream)
 getStream ()

Fonctions membres publiques statiques

static fromString (string $inputStr, int $currentIndex)
static fromTokens (array $tokens, int $currentIndex)

Champs de données

const TYPE_ARGUMENT_VALUE = 'argument_value'
const TYPE_OPTION_VALUE = 'option_value'
const TYPE_OPTION_NAME = 'option_name'
const TYPE_NONE = 'none'

Fonctions membres protégées

 parseToken (string $token, bool $parseOptions)
- Fonctions membres protégées hérités de ArgvInput
 setTokens (array $tokens)
 parse ()
 parseToken (string $token, bool $parseOptions)
- Fonctions membres protégées hérités de Input
 parse ()

Fonctions membres privées

 getOptionFromToken (string $optionToken)
 getRelevantToken ()
 isCursorFree ()

Attributs privés

 $completionName = null
 $completionValue = ''

Membres hérités additionnels

- Attributs protégés hérités de Input
 $options = []
 $arguments = []
 $interactive = true

Description détaillée

An input specialized for shell completion.

This input allows unfinished option names or values and exposes what kind of completion is expected.

Wouter de Jong

Documentation des fonctions membres

◆ __toString()

__toString ( )

Références $i.

◆ bind()

bind ( InputDefinition  $definition)

{Binds the current Input instance with the given arguments and options.


Implémente InputInterface.

Références Input\$definition, $option, $optionValue, CompletionInput\getOptionFromToken(), CompletionInput\getRelevantToken(), CompletionInput\isCursorFree(), et null.

◆ fromString()

static fromString ( string  $inputStr,
int  $currentIndex 

Converts a terminal string into tokens.

This is required for shell completions without COMP_WORDS support.

Références CompletionInput\$currentIndex, et CompletionInput\$tokens.

◆ fromTokens()

static fromTokens ( array  $tokens,
int  $currentIndex 

Create an input based on an COMP_WORDS token list.

string[]$tokens the set of split tokens (e.g. COMP_WORDS or argv)
$currentIndexthe index of the cursor (e.g. COMP_CWORD)

Références CompletionInput\$currentIndex, $input, et CompletionInput\$tokens.

Référencé par CommandCompletionTester\complete(), et CompleteCommand\createCompletionInput().

◆ getCompletionName()

getCompletionName ( )

The name of the input option or argument when completing a value.

string|null returns null when completing an option name

Références CompletionInput\$completionName.

Référencé par CompletionInput\mustSuggestArgumentValuesFor(), et CompletionInput\mustSuggestOptionValuesFor().

◆ getCompletionType()

getCompletionType ( )

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

string One of self::TYPE_* constants. TYPE_OPTION_NAME and TYPE_NONE are already implemented by the Console component

Références CompletionInput\$completionType.

Référencé par Application\complete(), CompletionInput\mustSuggestArgumentValuesFor(), et CompletionInput\mustSuggestOptionValuesFor().

◆ getCompletionValue()

getCompletionValue ( )

The value already typed by the user (or empty string).

Références CompletionInput\$completionValue.

◆ getOptionFromToken()

getOptionFromToken ( string  $optionToken)

Références null.

Référencé par CompletionInput\bind().

◆ getRelevantToken()

getRelevantToken ( )

The token of the cursor, or the last token if the cursor is at the end of the input.

Références CompletionInput\$currentIndex, et CompletionInput\isCursorFree().

Référencé par CompletionInput\bind().

◆ isCursorFree()

isCursorFree ( )

Whether the cursor is "free" (i.e. at the end of the input preceded by a space).

Référencé par CompletionInput\bind(), et CompletionInput\getRelevantToken().

◆ mustSuggestArgumentValuesFor()

mustSuggestArgumentValuesFor ( string  $argumentName)

◆ mustSuggestOptionValuesFor()

mustSuggestOptionValuesFor ( string  $optionName)

◆ parseToken()

parseToken ( string  $token,
bool  $parseOptions 

Documentation des champs

◆ $completionName

$completionName = null

◆ $completionType


◆ $completionValue

$completionValue = ''

◆ $currentIndex

◆ $tokens



const TYPE_ARGUMENT_VALUE = 'argument_value'

Référencé par Application\complete().


const TYPE_NONE = 'none'


const TYPE_OPTION_NAME = 'option_name'

Référencé par Application\complete().


const TYPE_OPTION_VALUE = 'option_value'

La documentation de cette classe a été générée à partir du fichier suivant :