[FrameworkBundle] add support for prioritizing form type extension tags

dmaicher · dmaicher · commit a3db5f06c9b3 · 2016-09-09T19:24:04.000+02:00
diff --git a/src/Symfony/Bundle/FrameworkBundle/CHANGELOG.md b/src/Symfony/Bundle/FrameworkBundle/CHANGELOG.md
@@ -6,6 +6,7 @@ CHANGELOG
 
  * The `Controller::getUser()` method has been deprecated and will be removed in
    Symfony 4.0; typehint the security user object in the action instead.
+ * Added possibility to prioritize form type extensions with `'priority'` attribute on tags `form.type_extension` 
 
 3.1.0
 -----
diff --git a/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Compiler/FormPass.php b/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Compiler/FormPass.php
@@ -11,6 +11,7 @@
 
 namespace Symfony\Bundle\FrameworkBundle\DependencyInjection\Compiler;
 
+use Symfony\Component\DependencyInjection\Compiler\PriorityTaggedServiceTrait;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
 
@@ -22,6 +23,8 @@
  */
 class FormPass implements CompilerPassInterface
 {
+    use PriorityTaggedServiceTrait;
+
     public function process(ContainerBuilder $container)
     {
         if (!$container->hasDefinition('form.extension')) {
@@ -47,12 +50,14 @@ public function process(ContainerBuilder $container)
 
         $typeExtensions = array();
 
-        foreach ($container->findTaggedServiceIds('form.type_extension') as $serviceId => $tag) {
+        foreach ($this->findAndSortTaggedServices('form.type_extension', $container) as $reference) {
+            $serviceId = (string) $reference;
             $serviceDefinition = $container->getDefinition($serviceId);
             if (!$serviceDefinition->isPublic()) {
                 throw new \InvalidArgumentException(sprintf('The service "%s" must be public as form type extensions are lazy-loaded.', $serviceId));
             }
 
+            $tag = $serviceDefinition->getTag('form.type_extension');
             if (isset($tag[0]['extended_type'])) {
                 $extendedType = $tag[0]['extended_type'];
             } else {
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,10 @@ public function testAddTaggedTypes()
         ), $extDefinition->getArgument(1));
     }
 
-    public function testAddTaggedTypeExtensions()
+    /**
+     * @dataProvider addTaggedTypeExtensionsDataProvider
+     */
+    public function testAddTaggedTypeExtensions(array $extensions, array $expectedRegisteredExtensions)
     {
         $container = new ContainerBuilder();
         $container->addCompilerPass(new FormPass());
@@ -72,26 +75,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_extension5', 'my.type_extension6'),
+                ),
             ),
-        ), $extDefinition->getArgument(2));
+        );
     }
 
     /**
