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

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\IteratorArgument;
  12. use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
  13. use Symfony\Component\DependencyInjection\Compiler\PriorityTaggedServiceTrait;
  14. use Symfony\Component\DependencyInjection\Compiler\ServiceLocatorTagPass;
  15. use Symfony\Component\DependencyInjection\ContainerBuilder;
  16. use Symfony\Component\DependencyInjection\Exception\InvalidArgumentException;
  17. use Symfony\Component\DependencyInjection\Reference;
  18. use Symfony\Component\Form\FormTypeExtensionInterface;
  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.         $this->formExtensionService $formExtensionService;
  36.         $this->formTypeTag $formTypeTag;
  37.         $this->formTypeExtensionTag $formTypeExtensionTag;
  38.         $this->formTypeGuesserTag $formTypeGuesserTag;
  39.         $this->formDebugCommandService $formDebugCommandService;
  40.     }
  41.     public function process(ContainerBuilder $container)
  42.     {
  43.         if (!$container->hasDefinition($this->formExtensionService)) {
  44.             return;
  45.         }
  46.         $definition $container->getDefinition($this->formExtensionService);
  47.         if (new IteratorArgument([]) != $definition->getArgument(2)) {
  48.             return;
  49.         }
  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)
  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->formTypeTagtrue) 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($formType0strrpos($formType'\\'))] = true;
  65.         }
  66.         if ($container->hasDefinition($this->formDebugCommandService)) {
  67.             $commandDefinition $container->getDefinition($this->formDebugCommandService);
  68.             $commandDefinition->setArgument(1array_keys($namespaces));
  69.             $commandDefinition->setArgument(2array_keys($servicesMap));
  70.         }
  71.         return ServiceLocatorTagPass::register($container$servicesMap);
  72.     }
  73.     private function processFormTypeExtensions(ContainerBuilder $container)
  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.                 if (!method_exists($typeExtensionClass'getExtendedTypes')) {
  84.                     @trigger_error(sprintf('Not implementing the static getExtendedTypes() method in %s when implementing the %s is deprecated since Symfony 4.2. The method will be added to the interface in 5.0.'$typeExtensionClassFormTypeExtensionInterface::class), E_USER_DEPRECATED);
  85.                 }
  86.                 $typeExtensions[$tag[0]['extended_type']][] = new Reference($serviceId);
  87.                 $typeExtensionsClasses[] = $typeExtensionClass;
  88.             } elseif (method_exists($typeExtensionClass'getExtendedTypes')) {
  89.                 $extendsTypes false;
  90.                 $typeExtensionsClasses[] = $typeExtensionClass;
  91.                 foreach ($typeExtensionClass::getExtendedTypes() as $extendedType) {
  92.                     $typeExtensions[$extendedType][] = new Reference($serviceId);
  93.                     $extendsTypes true;
  94.                 }
  95.                 if (!$extendsTypes) {
  96.                     throw new InvalidArgumentException(sprintf('The getExtendedTypes() method for service "%s" does not return any extended types.'$serviceId));
  97.                 }
  98.             } else {
  99.                 throw new InvalidArgumentException(sprintf('"%s" tagged services have to implement the static getExtendedTypes() method. Class "%s" for service "%s" does not implement it.'$this->formTypeExtensionTag$typeExtensionClass$serviceId));
  100.             }
  101.         }
  102.         foreach ($typeExtensions as $extendedType => $extensions) {
  103.             $typeExtensions[$extendedType] = new IteratorArgument($extensions);
  104.         }
  105.         if ($container->hasDefinition($this->formDebugCommandService)) {
  106.             $commandDefinition $container->getDefinition($this->formDebugCommandService);
  107.             $commandDefinition->setArgument(3$typeExtensionsClasses);
  108.         }
  109.         return $typeExtensions;
  110.     }
  111.     private function processFormTypeGuessers(ContainerBuilder $container)
  112.     {
  113.         $guessers = [];
  114.         $guessersClasses = [];
  115.         foreach ($container->findTaggedServiceIds($this->formTypeGuesserTagtrue) as $serviceId => $tags) {
  116.             $guessers[] = new Reference($serviceId);
  117.             $serviceDefinition $container->getDefinition($serviceId);
  118.             $guessersClasses[] = $serviceDefinition->getClass();
  119.         }
  120.         if ($container->hasDefinition($this->formDebugCommandService)) {
  121.             $commandDefinition $container->getDefinition($this->formDebugCommandService);
  122.             $commandDefinition->setArgument(4$guessersClasses);
  123.         }
  124.         return new IteratorArgument($guessers);
  125.     }
  126. }