class CompletionSuggestions

Stores all completion suggestions for the current input.

@author Wouter de Jong <wouter@wouterj.nl>

Hierarchy

class \Symfony\Component\Console\Completion\CompletionSuggestions

Expanded class hierarchy of CompletionSuggestions

18 files declare their use of CompletionSuggestions

Application.php in vendor/symfony/console/Application.php
BaseCommand.php in vendor/composer/composer/src/Composer/Command/BaseCommand.php
BashCompletionOutput.php in vendor/symfony/console/Completion/Output/BashCompletionOutput.php
Command.php in vendor/symfony/console/Command/Command.php
CommandCompletionTester.php in vendor/symfony/console/Tester/CommandCompletionTester.php

... See full list

File

vendor/symfony/console/Completion/CompletionSuggestions.php, line 21

Namespace

Symfony\Component\Console\Completion

View source

final class CompletionSuggestions {
    private array $valueSuggestions = [];
    private array $optionSuggestions = [];
    
    /**
     * Add a suggested value for an input option or argument.
     *
     * @return $this
     */
    public function suggestValue(string|Suggestion $value) : static {
        $this->valueSuggestions[] = !$value instanceof Suggestion ? new Suggestion($value) : $value;
        return $this;
    }
    
    /**
     * Add multiple suggested values at once for an input option or argument.
     *
     * @param list<string|Suggestion> $values
     *
     * @return $this
     */
    public function suggestValues(array $values) : static {
        foreach ($values as $value) {
            $this->suggestValue($value);
        }
        return $this;
    }
    
    /**
     * Add a suggestion for an input option name.
     *
     * @return $this
     */
    public function suggestOption(InputOption $option) : static {
        $this->optionSuggestions[] = $option;
        return $this;
    }
    
    /**
     * Add multiple suggestions for input option names at once.
     *
     * @param InputOption[] $options
     *
     * @return $this
     */
    public function suggestOptions(array $options) : static {
        foreach ($options as $option) {
            $this->suggestOption($option);
        }
        return $this;
    }
    
    /**
     * @return InputOption[]
     */
    public function getOptionSuggestions() : array {
        return $this->optionSuggestions;
    }
    
    /**
     * @return Suggestion[]
     */
    public function getValueSuggestions() : array {
        return $this->valueSuggestions;
    }

}

Members

Title Sort descending	Modifiers	Object type	Summary
CompletionSuggestions::$optionSuggestions	private	property
CompletionSuggestions::$valueSuggestions	private	property
CompletionSuggestions::getOptionSuggestions	public	function
CompletionSuggestions::getValueSuggestions	public	function
CompletionSuggestions::suggestOption	public	function	Add a suggestion for an input option name.
CompletionSuggestions::suggestOptions	public	function	Add multiple suggestions for input option names at once.
CompletionSuggestions::suggestValue	public	function	Add a suggested value for an input option or argument.
CompletionSuggestions::suggestValues	public	function	Add multiple suggested values at once for an input option or argument.