archived-framework-bundle/Command/DebugAutowiringCommand.php

<?php

/*
 * This file is part of the Symfony package.
 *
 * (c) Fabien Potencier <fabien@symfony.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Symfony\Bundle\FrameworkBundle\Command;

use Symfony\Bundle\FrameworkBundle\Console\Descriptor\Descriptor;
use Symfony\Component\Console\Attribute\AsCommand;
use Symfony\Component\Console\Completion\CompletionInput;
use Symfony\Component\Console\Completion\CompletionSuggestions;
use Symfony\Component\Console\Input\InputArgument;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\Console\Style\SymfonyStyle;
use Symfony\Component\ErrorHandler\ErrorRenderer\FileLinkFormatter;

/**
 * A console command for autowiring information.
 *
 * @author Ryan Weaver <ryan@knpuniversity.com>
 *
 * @internal
 */
#[AsCommand(name: 'debug:autowiring', description: 'List classes/interfaces you can use for autowiring')]
class DebugAutowiringCommand extends ContainerDebugCommand
{
    public function __construct(
        ?string $name = null,
        private ?FileLinkFormatter $fileLinkFormatter = null,
    ) {
        parent::__construct($name);
    }

    protected function configure(): void
    {
        $this
            ->setDefinition([
                new InputArgument('search', InputArgument::OPTIONAL, 'A search filter'),
                new InputOption('all', null, InputOption::VALUE_NONE, 'Show also services that are not aliased'),
            ])
            ->setHelp(<<<'EOF'
                The <info>%command.name%</info> command displays the classes and interfaces that
                you can use as type-hints for autowiring:

                  <info>php %command.full_name%</info>

                You can also pass a search term to filter the list:

                  <info>php %command.full_name% log</info>

                EOF
            )
        ;
    }

    protected function execute(InputInterface $input, OutputInterface $output): int
    {
        $io = new SymfonyStyle($input, $output);
        $errorIo = $io->getErrorStyle();

        $container = $this->getContainerBuilder($this->getApplication()->getKernel());
        $serviceIds = $container->getServiceIds();
        $serviceIds = array_filter($serviceIds, $this->filterToServiceTypes(...));

        if ($search = $input->getArgument('search')) {
            $searchNormalized = preg_replace('/[^a-zA-Z0-9\x7f-\xff $]++/', '', $search);

            $serviceIds = array_filter($serviceIds, static fn ($serviceId) => false !== stripos(str_replace('\\', '', $serviceId), $searchNormalized) && !str_starts_with($serviceId, '.'));

            if (!$serviceIds) {
                $errorIo->error(\sprintf('No autowirable classes or interfaces found matching "%s"', $search));

                return 1;
            }
        }

        $reverseAliases = [];

        foreach ($container->getAliases() as $id => $alias) {
            if ('.' === ($id[0] ?? null)) {
                $reverseAliases[(string) $alias][] = $id;
            }
        }

        uasort($serviceIds, 'strnatcmp');

        $io->title('Autowirable Types');
        $io->text('Use the following classes & interfaces as type-hints in constructor arguments to autowire services.');
        $io->text('Add <fg=magenta>#[Target(\'</><fg=cyan>name</><fg=magenta>\')]</> to the argument to select a specific variant.');
        if ($search) {
            $io->text(\sprintf('(only showing classes/interfaces matching <comment>%s</comment>)', $search));
        }
        $hasAlias = [];
        $all = $input->getOption('all');
        $previousId = '-';
        $serviceIdsNb = 0;
        foreach ($serviceIds as $serviceId) {
            if ($container->hasDefinition($serviceId) && $container->getDefinition($serviceId)->hasTag('container.excluded')) {
                continue;
            }
            $text = [];
            $resolvedServiceId = $serviceId;
            $description = '';

            if ($isNewGroup = !str_starts_with($serviceId, $previousId.' $')) {
                $text[] = '';
                $previousId = preg_replace('/ \$.*/', '', $serviceId);
                $description = Descriptor::getClassDescription($previousId, $resolvedServiceId);
                if ('' !== $description && isset($hasAlias[$previousId])) {
                    continue;
                }
            }

            if ($container->hasAlias($serviceId)) {
                $hasAlias[$serviceId] = true;
                $serviceAlias = $container->getAlias($serviceId);
                $alias = (string) $serviceAlias;

                $target = null;
                foreach ($reverseAliases[$alias] ?? [] as $id) {
                    if (!str_starts_with($id, '.'.$previousId.' $') || !str_contains($serviceId, ' $')) {
                        continue;
                    }
                    $target = substr($id, \strlen($previousId) + 3);

                    if ($container->findDefinition($id) === $container->findDefinition($serviceId)) {
                        break;
                    }
                }

                if ($container->hasDefinition($serviceAlias) && $decorated = $container->getDefinition($serviceAlias)->getTag('container.decorator')) {
                    $alias = $decorated[0]['id'];
                }

                if ($isNewGroup) {
                    // Build the main type line with optional file link
                    $typeLine = \sprintf('<fg=yellow>%s</>', $previousId);
                    if ('' !== $fileLink = $this->getFileLink($previousId)) {
                        $typeLine = \sprintf('<fg=yellow;href=%s>%s</>', $fileLink, $previousId);
                    }

                    if (null !== $target) {
                        // Type whose first entry is already targeted (no un-targeted base)
                        $text[] = $typeLine;
                        if ('' !== $description) {
                            $text[] = \sprintf('  %s', $description);
                        }
                        $targetLine = \sprintf('  <fg=magenta>#[Target(\'</><fg=cyan>%s</><fg=magenta>\')]</>', $target);
                        if ($alias !== $target) {
                            $targetLine .= \sprintf(' → <fg=cyan>%s</>', $alias);
                        }
                        if ($serviceAlias->isDeprecated()) {
                            $targetLine .= ' <fg=magenta>[deprecated]</>';
                        }
                        $text[] = $targetLine;
                    } else {
                        // Regular main entry: Type → alias
                        if ($alias !== $target) {
                            $typeLine .= \sprintf(' → <fg=cyan>%s</>', $alias);
                        }
                        if ($serviceAlias->isDeprecated()) {
                            $typeLine .= ' <fg=magenta>[deprecated]</>';
                        }
                        $text[] = $typeLine;
                        if ('' !== $description) {
                            $text[] = \sprintf('  %s', $description);
                        }
                    }
                } else {
                    // Variant entry: indented #[Target] line
                    if (null !== $target) {
                        $variantLine = \sprintf('  <fg=magenta>#[Target(\'</><fg=cyan>%s</><fg=magenta>\')]</>', $target);
                    } else {
                        $variantLine = \sprintf('  <fg=yellow>%s</>', $serviceId);
                    }
                    if ($alias !== $target) {
                        $variantLine .= \sprintf(' → <fg=cyan>%s</>', $alias);
                    }
                    if ($serviceAlias->isDeprecated()) {
                        $variantLine .= ' <fg=magenta>[deprecated]</>';
                    }
                    $text[] = $variantLine;
                }
            } elseif (!$all) {
                ++$serviceIdsNb;
                continue;
            } else {
                // Service without alias (shown with --all)
                $serviceLine = \sprintf('<fg=yellow>%s</>', $previousId);
                if ('' !== $fileLink = $this->getFileLink($previousId)) {
                    $serviceLine = \sprintf('<fg=yellow;href=%s>%s</>', $fileLink, $previousId);
                }
                if ($container->getDefinition($serviceId)->isDeprecated()) {
                    $serviceLine .= ' <fg=magenta>[deprecated]</>';
                }
                $text[] = $serviceLine;
                if ($isNewGroup && '' !== $description) {
                    $text[] = \sprintf('  %s', $description);
                }
            }
            $io->text($text);
        }

        $io->newLine();

        if (0 < $serviceIdsNb) {
            $io->text(\sprintf('%s more concrete service%s would be displayed when adding the "--all" option.', $serviceIdsNb, $serviceIdsNb > 1 ? 's' : ''));
        }
        if ($all) {
            $io->text('Pro-tip: use interfaces in your type-hints instead of classes to benefit from the dependency inversion principle.');
        }

        $io->newLine();

        return 0;
    }

    private function getFileLink(string $class): string
    {
        if (null === $this->fileLinkFormatter
            || (null === $r = $this->getContainerBuilder($this->getApplication()->getKernel())->getReflectionClass($class, false))) {
            return '';
        }

        return $r->getFileName() ? ($this->fileLinkFormatter->format($r->getFileName(), $r->getStartLine()) ?: '') : '';
    }

    public function complete(CompletionInput $input, CompletionSuggestions $suggestions): void
    {
        if ($input->mustSuggestArgumentValuesFor('search')) {
            $container = $this->getContainerBuilder($this->getApplication()->getKernel());

            $suggestions->suggestValues(array_filter($container->getServiceIds(), $this->filterToServiceTypes(...)));
        }
    }
}