[FrameworkBundle] add support for prioritizing form type extension tags

dmaicher · dmaicher · commit f9f8b574c4a4 · 2016-08-31T19:03:08.000+02:00
diff --git a/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Compiler/FormPass.php b/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Compiler/FormPass.php
@@ -45,7 +45,8 @@ public function process(ContainerBuilder $container)
 
         $definition->replaceArgument(1, $types);
 
-        $typeExtensions = array();
+        /** @var \SplPriorityQueue[] $typeExtensionQueues */
+        $typeExtensionQueues = array();
 
         foreach ($container->findTaggedServiceIds('form.type_extension') as $serviceId => $tag) {
             $serviceDefinition = $container->getDefinition($serviceId);
@@ -59,10 +60,19 @@ public function process(ContainerBuilder $container)
                 throw new \InvalidArgumentException(sprintf('Tagged form type extension must have the extended type configured using the extended_type/extended-type attribute, none was configured for the "%s" service.', $serviceId));
             }
 
-            $typeExtensions[$extendedType][] = $serviceId;
+            if (!isset($typeExtensionQueues[$extendedType])) {
+                $typeExtensionQueues[$extendedType] = new \SplPriorityQueue();
+            }
+
+            $typeExtensionQueues[$extendedType]->insert($serviceId, isset($tag[0]['priority']) ? $tag[0]['priority'] : 0);
+        }
+
+        $sortedTypeExtensions = array();
+        foreach ($typeExtensionQueues as $extendedType => $priorityQueue) {
+            $sortedTypeExtensions[$extendedType] = iterator_to_array($priorityQueue, false);
         }
 
-        $definition->replaceArgument(2, $typeExtensions);
+        $definition->replaceArgument(2, $sortedTypeExtensions);
 
         // Find all services annotated with "form.type_guesser"
         $guessers = array_keys($container->findTaggedServiceIds('form.type_guesser'));
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Compiler/FormPassTest.php b/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Compiler/FormPassTest.php
@@ -59,7 +59,13 @@ public function testAddTaggedTypes()
         ), $extDefinition->getArgument(1));
     }
 
-    public function testAddTaggedTypeExtensions()
+    /**
+     * @dataProvider addTaggedTypeExtensionsDataProvider
+     *
+     * @param array $extensions
+     * @param array $expectedRegisteredExtensions
+     */
+    public function testAddTaggedTypeExtensions(array $extensions, array $expectedRegisteredExtensions)
     {
         $container = new ContainerBuilder();
         $container->addCompilerPass(new FormPass());
@@ -72,26 +78,49 @@ public function testAddTaggedTypeExtensions()
         ));
 
         $container->setDefinition('form.extension', $extDefinition);
-        $container->register('my.type_extension1', 'stdClass')
-            ->addTag('form.type_extension', array('extended_type' => 'type1'));
-        $container->register('my.type_extension2', 'stdClass')
-            ->addTag('form.type_extension', array('extended_type' => 'type1'));
-        $container->register('my.type_extension3', 'stdClass')
-            ->addTag('form.type_extension', array('extended_type' => 'type2'));
+
+        foreach ($extensions as $serviceId => $tag) {
+            $container->register($serviceId, 'stdClass')->addTag('form.type_extension', $tag);
+        }
 
         $container->compile();
 
         $extDefinition = $container->getDefinition('form.extension');
+        $this->assertSame($expectedRegisteredExtensions, $extDefinition->getArgument(2));
+    }
 
-        $this->assertSame(array(
-            'type1' => array(
-                'my.type_extension1',
-                'my.type_extension2',
+    /**
+     * @return array
+     */
+    public function addTaggedTypeExtensionsDataProvider()
+    {
+        return array(
+            array(
+                array(
+                    'my.type_extension1' => array('extended_type' => 'type1'),
+                    'my.type_extension2' => array('extended_type' => 'type1'),
+                    'my.type_extension3' => array('extended_type' => 'type2'),
+                ),
+                array(
+                    'type1' => array('my.type_extension1', 'my.type_extension2'),
+                    'type2' => array('my.type_extension3'),
+                ),
             ),
-            'type2' => array(
-                'my.type_extension3',
+            array(
+                array(
+                    'my.type_extension1' => array('extended_type' => 'type1', 'priority' => 1),
+                    'my.type_extension2' => array('extended_type' => 'type1', 'priority' => 2),
+                    'my.type_extension3' => array('extended_type' => 'type1', 'priority' => -1),
+                    'my.type_extension4' => array('extended_type' => 'type2', 'priority' => 2),
+                    'my.type_extension5' => array('extended_type' => 'type2', 'priority' => 1),
+                    'my.type_extension6' => array('extended_type' => 'type2', 'priority' => 1),
+                ),
+                array(
+                    'type1' => array('my.type_extension2', 'my.type_extension1', 'my.type_extension3'),
+                    'type2' => array('my.type_extension4', 'my.type_extension6', 'my.type_extension5'),
+                ),
             ),
-        ), $extDefinition->getArgument(2));
+        );
     }
 
     /**
