vendor/symfony/framework-bundle/Command/DebugAutowiringCommand.php line 39

  1. <?php
  3. /*
  4.  * This file is part of the Symfony package.
  5.  *
  6.  * (c) Fabien Potencier <fabien@symfony.com>
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  */
  12. namespace Symfony\Bundle\FrameworkBundle\Command;
  14. use Symfony\Bundle\FrameworkBundle\Console\Descriptor\Descriptor;
  15. use Symfony\Component\Console\Attribute\AsCommand;
  16. use Symfony\Component\Console\Completion\CompletionInput;
  17. use Symfony\Component\Console\Completion\CompletionSuggestions;
  18. use Symfony\Component\Console\Formatter\OutputFormatterStyle;
  19. use Symfony\Component\Console\Input\InputArgument;
  20. use Symfony\Component\Console\Input\InputInterface;
  21. use Symfony\Component\Console\Input\InputOption;
  22. use Symfony\Component\Console\Output\OutputInterface;
  23. use Symfony\Component\Console\Style\SymfonyStyle;
  24. use Symfony\Component\HttpKernel\Debug\FileLinkFormatter;
  26. /**
  27.  * A console command for autowiring information.
  28.  *
  29.  * @author Ryan Weaver <ryan@knpuniversity.com>
  30.  *
  31.  * @internal
  32.  */
  33. #[AsCommand(name: 'debug:autowiring', description: 'List classes/interfaces you can use for autowiring')]
  34. class DebugAutowiringCommand extends ContainerDebugCommand
  35. {
  36.     private bool $supportsHref;
  37.     private ?FileLinkFormatter $fileLinkFormatter;
  39.     public function __construct(string $name = null, FileLinkFormatter $fileLinkFormatter = null)
  40.     {
  41.         $this->supportsHref = method_exists(OutputFormatterStyle::class, 'setHref');
  42.         $this->fileLinkFormatter = $fileLinkFormatter;
  43.         parent::__construct($name);
  44.     }
  46.     protected function configure()
  47.     {
  48.         $this
  49.             ->setDefinition([
  50.                 new InputArgument('search', InputArgument::OPTIONAL, 'A search filter'),
  51.                 new InputOption('all', null, InputOption::VALUE_NONE, 'Show also services that are not aliased'),
  52.             ])
  53.             ->setHelp(<<<'EOF'
  54. The <info>%command.name%</info> command displays the classes and interfaces that
  55. you can use as type-hints for autowiring:
  57.   <info>php %command.full_name%</info>
  59. You can also pass a search term to filter the list:
  61.   <info>php %command.full_name% log</info>
  63. EOF
  64.             )
  65.         ;
  66.     }
  68.     protected function execute(InputInterface $input, OutputInterface $output): int
  69.     {
  70.         $io = new SymfonyStyle($input, $output);
  71.         $errorIo = $io->getErrorStyle();
  73.         $builder = $this->getContainerBuilder($this->getApplication()->getKernel());
  74.         $serviceIds = $builder->getServiceIds();
  75.         $serviceIds = array_filter($serviceIds, $this->filterToServiceTypes(...));
  77.         if ($search = $input->getArgument('search')) {
  78.             $searchNormalized = preg_replace('/[^a-zA-Z0-9\x7f-\xff $]++/', '', $search);
  80.             $serviceIds = array_filter($serviceIds, function ($serviceId) use ($searchNormalized) {
  81.                 return false !== stripos(str_replace('\\', '', $serviceId), $searchNormalized) && !str_starts_with($serviceId, '.');
  82.             });
  84.             if (!$serviceIds) {
  85.                 $errorIo->error(sprintf('No autowirable classes or interfaces found matching "%s"', $search));
  87.                 return 1;
  88.             }
  89.         }
  91.         uasort($serviceIds, 'strnatcmp');
  93.         $io->title('Autowirable Types');
  94.         $io->text('The following classes & interfaces can be used as type-hints when autowiring:');
  95.         if ($search) {
  96.             $io->text(sprintf('(only showing classes/interfaces matching <comment>%s</comment>)', $search));
  97.         }
  98.         $hasAlias = [];
  99.         $all = $input->getOption('all');
  100.         $previousId = '-';
  101.         $serviceIdsNb = 0;
  102.         foreach ($serviceIds as $serviceId) {
  103.             if ($builder->hasDefinition($serviceId) && $builder->getDefinition($serviceId)->hasTag('container.excluded')) {
  104.                 continue;
  105.             }
  106.             $text = [];
  107.             $resolvedServiceId = $serviceId;
  108.             if (!str_starts_with($serviceId, $previousId)) {
  109.                 $text[] = '';
  110.                 if ('' !== $description = Descriptor::getClassDescription($serviceId, $resolvedServiceId)) {
  111.                     if (isset($hasAlias[$serviceId])) {
  112.                         continue;
  113.                     }
  114.                     $text[] = $description;
  115.                 }
  116.                 $previousId = $serviceId.' $';
  117.             }
  119.             $serviceLine = sprintf('<fg=yellow>%s</>', $serviceId);
  120.             if ($this->supportsHref && '' !== $fileLink = $this->getFileLink($serviceId)) {
  121.                 $serviceLine = sprintf('<fg=yellow;href=%s>%s</>', $fileLink, $serviceId);
  122.             }
  124.             if ($builder->hasAlias($serviceId)) {
  125.                 $hasAlias[$serviceId] = true;
  126.                 $serviceAlias = $builder->getAlias($serviceId);
  127.                 $serviceLine .= ' <fg=cyan>('.$serviceAlias.')</>';
  129.                 if ($serviceAlias->isDeprecated()) {
  130.                     $serviceLine .= ' - <fg=magenta>deprecated</>';
  131.                 }
  132.             } elseif (!$all) {
  133.                 ++$serviceIdsNb;
  134.                 continue;
  135.             }
  136.             $text[] = $serviceLine;
  137.             $io->text($text);
  138.         }
  140.         $io->newLine();
  142.         if (0 < $serviceIdsNb) {
  143.             $io->text(sprintf('%s more concrete service%s would be displayed when adding the "--all" option.', $serviceIdsNb, $serviceIdsNb > 1 ? 's' : ''));
  144.         }
  145.         if ($all) {
  146.             $io->text('Pro-tip: use interfaces in your type-hints instead of classes to benefit from the dependency inversion principle.');
  147.         }
  149.         $io->newLine();
  151.         return 0;
  152.     }
  154.     private function getFileLink(string $class): string
  155.     {
  156.         if (null === $this->fileLinkFormatter
  157.             || (null === $r = $this->getContainerBuilder($this->getApplication()->getKernel())->getReflectionClass($class, false))) {
  158.             return '';
  159.         }
  161.         return (string) $this->fileLinkFormatter->format($r->getFileName(), $r->getStartLine());
  162.     }
  164.     public function complete(CompletionInput $input, CompletionSuggestions $suggestions): void
  165.     {
  166.         if ($input->mustSuggestArgumentValuesFor('search')) {
  167.             $builder = $this->getContainerBuilder($this->getApplication()->getKernel());
  169.             $suggestions->suggestValues(array_filter($builder->getServiceIds(), $this->filterToServiceTypes(...)));
  170.         }
  171.     }
  172. }