vendor/symfony/console/DependencyInjection/AddConsoleCommandPass.php line 56

Open in your IDE?
  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\Component\Console\DependencyInjection;
  14. use Symfony\Component\Console\Command\Command;
  15. use Symfony\Component\Console\Command\LazyCommand;
  16. use Symfony\Component\Console\CommandLoader\ContainerCommandLoader;
  17. use Symfony\Component\DependencyInjection\Argument\ServiceClosureArgument;
  18. use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
  19. use Symfony\Component\DependencyInjection\Compiler\ServiceLocatorTagPass;
  20. use Symfony\Component\DependencyInjection\ContainerBuilder;
  21. use Symfony\Component\DependencyInjection\Exception\InvalidArgumentException;
  22. use Symfony\Component\DependencyInjection\Reference;
  23. use Symfony\Component\DependencyInjection\TypedReference;
  25. /**
  26.  * Registers console commands.
  27.  *
  28.  * @author Grégoire Pineau <lyrixx@lyrixx.info>
  29.  */
  30. class AddConsoleCommandPass implements CompilerPassInterface
  31. {
  32.     /**
  33.      * @return void
  34.      */
  35.     public function process(ContainerBuilder $container)
  36.     {
  37.         $commandServices = $container->findTaggedServiceIds('console.command', true);
  38.         $lazyCommandMap = [];
  39.         $lazyCommandRefs = [];
  40.         $serviceIds = [];
  42.         foreach ($commandServices as $id => $tags) {
  43.             $definition = $container->getDefinition($id);
  44.             $definition->addTag('container.no_preload');
  45.             $class = $container->getParameterBag()->resolveValue($definition->getClass());
  47.             if (isset($tags[0]['command'])) {
  48.                 $aliases = $tags[0]['command'];
  49.             } else {
  50.                 if (!$r = $container->getReflectionClass($class)) {
  51.                     throw new InvalidArgumentException(sprintf('Class "%s" used for service "%s" cannot be found.', $class, $id));
  52.                 }
  53.                 if (!$r->isSubclassOf(Command::class)) {
  54.                     throw new InvalidArgumentException(sprintf('The service "%s" tagged "%s" must be a subclass of "%s".', $id, 'console.command', Command::class));
  55.                 }
  56.                 $aliases = str_replace('%', '%%', $class::getDefaultName() ?? '');
  57.             }
  59.             $aliases = explode('|', $aliases ?? '');
  60.             $commandName = array_shift($aliases);
  62.             if ($isHidden = '' === $commandName) {
  63.                 $commandName = array_shift($aliases);
  64.             }
  66.             if (null === $commandName) {
  67.                 if (!$definition->isPublic() || $definition->isPrivate() || $definition->hasTag('container.private')) {
  68.                     $commandId = 'console.command.public_alias.'.$id;
  69.                     $container->setAlias($commandId, $id)->setPublic(true);
  70.                     $id = $commandId;
  71.                 }
  72.                 $serviceIds[] = $id;
  74.                 continue;
  75.             }
  77.             $description = $tags[0]['description'] ?? null;
  79.             unset($tags[0]);
  80.             $lazyCommandMap[$commandName] = $id;
  81.             $lazyCommandRefs[$id] = new TypedReference($id, $class);
  83.             foreach ($aliases as $alias) {
  84.                 $lazyCommandMap[$alias] = $id;
  85.             }
  87.             foreach ($tags as $tag) {
  88.                 if (isset($tag['command'])) {
  89.                     $aliases[] = $tag['command'];
  90.                     $lazyCommandMap[$tag['command']] = $id;
  91.                 }
  93.                 $description ??= $tag['description'] ?? null;
  94.             }
  96.             $definition->addMethodCall('setName', [$commandName]);
  98.             if ($aliases) {
  99.                 $definition->addMethodCall('setAliases', [$aliases]);
  100.             }
  102.             if ($isHidden) {
  103.                 $definition->addMethodCall('setHidden', [true]);
  104.             }
  106.             if (!$description) {
  107.                 if (!$r = $container->getReflectionClass($class)) {
  108.                     throw new InvalidArgumentException(sprintf('Class "%s" used for service "%s" cannot be found.', $class, $id));
  109.                 }
  110.                 if (!$r->isSubclassOf(Command::class)) {
  111.                     throw new InvalidArgumentException(sprintf('The service "%s" tagged "%s" must be a subclass of "%s".', $id, 'console.command', Command::class));
  112.                 }
  113.                 $description = str_replace('%', '%%', $class::getDefaultDescription() ?? '');
  114.             }
  116.             if ($description) {
  117.                 $definition->addMethodCall('setDescription', [$description]);
  119.                 $container->register('.'.$id.'.lazy', LazyCommand::class)
  120.                     ->setArguments([$commandName, $aliases, $description, $isHidden, new ServiceClosureArgument($lazyCommandRefs[$id])]);
  122.                 $lazyCommandRefs[$id] = new Reference('.'.$id.'.lazy');
  123.             }
  124.         }
  126.         $container
  127.             ->register('console.command_loader', ContainerCommandLoader::class)
  128.             ->setPublic(true)
  129.             ->addTag('container.no_preload')
  130.             ->setArguments([ServiceLocatorTagPass::register($container, $lazyCommandRefs), $lazyCommandMap]);
  132.         $container->setParameter('console.command.ids', $serviceIds);
  133.     }
  134. }