function CompleteCommand::execute

Overrides Command::execute

File

vendor/symfony/console/Command/CompleteCommand.php, line 71

Class

CompleteCommand

Responsible for providing the values to the shell completion.

Namespace

Symfony\Component\Console\Command

Code

protected function execute(InputInterface $input, OutputInterface $output) : int {
    try {
        // "symfony" must be kept for compat with the shell scripts generated by Symfony Console 5.4 - 6.1
        $version = $input->getOption('symfony') ? '1' : $input->getOption('api-version');
        if ($version && version_compare($version, self::COMPLETION_API_VERSION, '<')) {
            $message = \sprintf('Completion script version is not supported ("%s" given, ">=%s" required).', $version, self::COMPLETION_API_VERSION);
            $this->log($message);
            $output->writeln($message . ' Install the Symfony completion script again by using the "completion" command.');
            return 126;
        }
        $shell = $input->getOption('shell');
        if (!$shell) {
            throw new \RuntimeException('The "--shell" option must be set.');
        }
        if (!($completionOutput = $this->completionOutputs[$shell] ?? false)) {
            throw new \RuntimeException(\sprintf('Shell completion is not supported for your shell: "%s" (supported: "%s").', $shell, implode('", "', array_keys($this->completionOutputs))));
        }
        $completionInput = $this->createCompletionInput($input);
        $suggestions = new CompletionSuggestions();
        $this->log([
            '',
            '<comment>' . date('Y-m-d H:i:s') . '</>',
            '<info>Input:</> <comment>("|" indicates the cursor position)</>',
            '  ' . $completionInput,
            '<info>Command:</>',
            '  ' . implode(' ', $_SERVER['argv']),
            '<info>Messages:</>',
        ]);
        $command = $this->findCommand($completionInput);
        if (null === $command) {
            $this->log('  No command found, completing using the Application class.');
            $this->getApplication()
                ->complete($completionInput, $suggestions);
        }
        elseif ($completionInput->mustSuggestArgumentValuesFor('command') && $command->getName() !== $completionInput->getCompletionValue() && !\in_array($completionInput->getCompletionValue(), $command->getAliases(), true)) {
            $this->log('  No command found, completing using the Application class.');
            // expand shortcut names ("cache:cl<TAB>") into their full name ("cache:clear")
            $suggestions->suggestValues(array_filter(array_merge([
                $command->getName(),
            ], $command->getAliases())));
        }
        else {
            $command->mergeApplicationDefinition();
            $completionInput->bind($command->getDefinition());
            if (CompletionInput::TYPE_OPTION_NAME === $completionInput->getCompletionType()) {
                $this->log('  Completing option names for the <comment>' . ($command instanceof LazyCommand ? $command->getCommand() : $command)::class . '</> command.');
                $suggestions->suggestOptions($command->getDefinition()
                    ->getOptions());
            }
            else {
                $this->log([
                    '  Completing using the <comment>' . ($command instanceof LazyCommand ? $command->getCommand() : $command)::class . '</> class.',
                    '  Completing <comment>' . $completionInput->getCompletionType() . '</> for <comment>' . $completionInput->getCompletionName() . '</>',
                ]);
                if (null !== ($compval = $completionInput->getCompletionValue())) {
                    $this->log('  Current value: <comment>' . $compval . '</>');
                }
                $command->complete($completionInput, $suggestions);
            }
        }
        
        /** @var CompletionOutputInterface $completionOutput */
        $completionOutput = new $completionOutput();
        $this->log('<info>Suggestions:</>');
        if ($options = $suggestions->getOptionSuggestions()) {
            $this->log('  --' . implode(' --', array_map(fn($o) => $o->getName(), $options)));
        }
        elseif ($values = $suggestions->getValueSuggestions()) {
            $this->log('  ' . implode(' ', $values));
        }
        else {
            $this->log('  <comment>No suggestions were provided</>');
        }
        $completionOutput->write($suggestions, $output);
    } catch (\Throwable $e) {
        $this->log([
            '<error>Error!</error>',
            (string) $e,
        ]);
        if ($output->isDebug()) {
            throw $e;
        }
        return 2;
    }
    return 0;
}