vendor/symfony/form/DependencyInjection/FormPass.php line 60

Open in your IDE?
  1. <?php
  2. /*
  3.  * This file is part of the Symfony package.
  4.  *
  5.  * (c) Fabien Potencier <fabien@symfony.com>
  6.  *
  7.  * For the full copyright and license information, please view the LICENSE
  8.  * file that was distributed with this source code.
  9.  */
  10. namespace Symfony\Component\Form\DependencyInjection;
  11. use Symfony\Component\DependencyInjection\Argument\ArgumentInterface;
  12. use Symfony\Component\DependencyInjection\Argument\IteratorArgument;
  13. use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
  14. use Symfony\Component\DependencyInjection\Compiler\PriorityTaggedServiceTrait;
  15. use Symfony\Component\DependencyInjection\Compiler\ServiceLocatorTagPass;
  16. use Symfony\Component\DependencyInjection\ContainerBuilder;
  17. use Symfony\Component\DependencyInjection\Exception\InvalidArgumentException;
  18. use Symfony\Component\DependencyInjection\Reference;
  19. /**
  20.  * Adds all services with the tags "form.type", "form.type_extension" and
  21.  * "form.type_guesser" as arguments of the "form.extension" service.
  22.  *
  23.  * @author Bernhard Schussek <bschussek@gmail.com>
  24.  */
  25. class FormPass implements CompilerPassInterface
  26. {
  27.     use PriorityTaggedServiceTrait;
  28.     private $formExtensionService;
  29.     private $formTypeTag;
  30.     private $formTypeExtensionTag;
  31.     private $formTypeGuesserTag;
  32.     private $formDebugCommandService;
  33.     public function __construct(string $formExtensionService = 'form.extension', string $formTypeTag = 'form.type', string $formTypeExtensionTag = 'form.type_extension', string $formTypeGuesserTag = 'form.type_guesser', string $formDebugCommandService = 'console.command.form_debug')
  34.     {
  35.         if (0 < \func_num_args()) {
  36.             trigger_deprecation('symfony/http-kernel', '5.3', 'Configuring "%s" is deprecated.', __CLASS__);
  37.         }
  38.         $this->formExtensionService = $formExtensionService;
  39.         $this->formTypeTag = $formTypeTag;
  40.         $this->formTypeExtensionTag = $formTypeExtensionTag;
  41.         $this->formTypeGuesserTag = $formTypeGuesserTag;
  42.         $this->formDebugCommandService = $formDebugCommandService;
  43.     }
  44.     public function process(ContainerBuilder $container)
  45.     {
  46.         if (!$container->hasDefinition($this->formExtensionService)) {
  47.             return;
  48.         }
  49.         $definition = $container->getDefinition($this->formExtensionService);
  50.         $definition->replaceArgument(0, $this->processFormTypes($container));
  51.         $definition->replaceArgument(1, $this->processFormTypeExtensions($container));
  52.         $definition->replaceArgument(2, $this->processFormTypeGuessers($container));
  53.     }
  54.     private function processFormTypes(ContainerBuilder $container): Reference
  55.     {
  56.         // Get service locator argument
  57.         $servicesMap = [];
  58.         $namespaces = ['Symfony\Component\Form\Extension\Core\Type' => true];
  59.         // Builds an array with fully-qualified type class names as keys and service IDs as values
  60.         foreach ($container->findTaggedServiceIds($this->formTypeTag, true) as $serviceId => $tag) {
  61.             // Add form type service to the service locator
  62.             $serviceDefinition = $container->getDefinition($serviceId);
  63.             $servicesMap[$formType = $serviceDefinition->getClass()] = new Reference($serviceId);
  64.             $namespaces[substr($formType, 0, strrpos($formType, '\\'))] = true;
  65.         }
  66.         if ($container->hasDefinition($this->formDebugCommandService)) {
  67.             $commandDefinition = $container->getDefinition($this->formDebugCommandService);
  68.             $commandDefinition->setArgument(1, array_keys($namespaces));
  69.             $commandDefinition->setArgument(2, array_keys($servicesMap));
  70.         }
  71.         return ServiceLocatorTagPass::register($container, $servicesMap);
  72.     }
  73.     private function processFormTypeExtensions(ContainerBuilder $container): array
  74.     {
  75.         $typeExtensions = [];
  76.         $typeExtensionsClasses = [];
  77.         foreach ($this->findAndSortTaggedServices($this->formTypeExtensionTag, $container) as $reference) {
  78.             $serviceId = (string) $reference;
  79.             $serviceDefinition = $container->getDefinition($serviceId);
  80.             $tag = $serviceDefinition->getTag($this->formTypeExtensionTag);
  81.             $typeExtensionClass = $container->getParameterBag()->resolveValue($serviceDefinition->getClass());
  82.             if (isset($tag[0]['extended_type'])) {
  83.                 $typeExtensions[$tag[0]['extended_type']][] = new Reference($serviceId);
  84.                 $typeExtensionsClasses[] = $typeExtensionClass;
  85.             } else {
  86.                 $extendsTypes = false;
  87.                 $typeExtensionsClasses[] = $typeExtensionClass;
  88.                 foreach ($typeExtensionClass::getExtendedTypes() as $extendedType) {
  89.                     $typeExtensions[$extendedType][] = new Reference($serviceId);
  90.                     $extendsTypes = true;
  91.                 }
  92.                 if (!$extendsTypes) {
  93.                     throw new InvalidArgumentException(sprintf('The getExtendedTypes() method for service "%s" does not return any extended types.', $serviceId));
  94.                 }
  95.             }
  96.         }
  97.         foreach ($typeExtensions as $extendedType => $extensions) {
  98.             $typeExtensions[$extendedType] = new IteratorArgument($extensions);
  99.         }
  100.         if ($container->hasDefinition($this->formDebugCommandService)) {
  101.             $commandDefinition = $container->getDefinition($this->formDebugCommandService);
  102.             $commandDefinition->setArgument(3, $typeExtensionsClasses);
  103.         }
  104.         return $typeExtensions;
  105.     }
  106.     private function processFormTypeGuessers(ContainerBuilder $container): ArgumentInterface
  107.     {
  108.         $guessers = [];
  109.         $guessersClasses = [];
  110.         foreach ($container->findTaggedServiceIds($this->formTypeGuesserTag, true) as $serviceId => $tags) {
  111.             $guessers[] = new Reference($serviceId);
  112.             $serviceDefinition = $container->getDefinition($serviceId);
  113.             $guessersClasses[] = $serviceDefinition->getClass();
  114.         }
  115.         if ($container->hasDefinition($this->formDebugCommandService)) {
  116.             $commandDefinition = $container->getDefinition($this->formDebugCommandService);
  117.             $commandDefinition->setArgument(4, $guessersClasses);
  118.         }
  119.         return new IteratorArgument($guessers);
  120.     }
  121. }