Add extensions priority in sonata_admin config (#4608)

DependencyInjection/Compiler/ExtensionCompilerPass.php

@@ -65,7 +65,7 @@ class ExtensionCompilerPass implements CompilerPassInterface
 
             $extensions = $this->getExtensionsForAdmin($id, $admin, $container, $extensionMap);
 
-            foreach ($extensions as $extension) {
+            foreach ($extensions as $extension => $attributes) {
                 if (!$container->has($extension)) {
                     throw new \InvalidArgumentException(
                         sprintf('Unable to find extension service for id %s', $extension)
@@ -145,7 +145,7 @@ class ExtensionCompilerPass implements CompilerPassInterface
         }
 
         if (isset($excludes[$id])) {
-            $extensions = array_diff($extensions, $excludes[$id]);
+            $extensions = array_diff_key($extensions, $excludes[$id]);
         }
 
         return $extensions;
@@ -167,7 +167,16 @@ class ExtensionCompilerPass implements CompilerPassInterface
     /**
      * @param array $config
      *
-     * @return array
+     * @return array An array with the following structure.
+     *
+     * array(
+     *     'excludes'   => array('<admin_id>'  => array('<extension_id>' => array('priority' => <int>))),
+     *     'admins'     => array('<admin_id>'  => array('<extension_id>' => array('priority' => <int>))),
+     *     'implements' => array('<interface>' => array('<extension_id>' => array('priority' => <int>))),
+     *     'extends'    => array('<class>'     => array('<extension_id>' => array('priority' => <int>))),
+     *     'instanceof' => array('<class>'     => array('<extension_id>' => array('priority' => <int>))),
+     *     'uses'       => array('<trait>'     => array('<extension_id>' => array('priority' => <int>))),
+     * )
      */
     protected function flattenExtensionConfiguration(array $config)
     {
@@ -181,12 +190,14 @@ class ExtensionCompilerPass implements CompilerPassInterface
         );
 
         foreach ($config as $extension => $options) {
-            foreach ($options as $key => $value) {
+            $optionsMap = array_intersect_key($options, $extensionMap);
+
+            foreach ($optionsMap as $key => $value) {
                 foreach ($value as $source) {
                     if (!isset($extensionMap[$key][$source])) {
                         $extensionMap[$key][$source] = array();
                     }
-                    array_push($extensionMap[$key][$source], $extension);
+                    $extensionMap[$key][$source][$extension]['priority'] = $options['priority'];
                 }
             }
         }
@@ -221,7 +232,7 @@ class ExtensionCompilerPass implements CompilerPassInterface
      * @param string $extension
      * @param array  $attributes
      */
-    private function addExtension(array &$targets, $target, $extension, $attributes)
+    private function addExtension(array &$targets, $target, $extension, array $attributes)
     {
         if (!isset($targets[$target])) {
             $targets[$target] = new \SplPriorityQueue();

DependencyInjection/Configuration.php

@@ -425,6 +425,10 @@ class Configuration implements ConfigurationInterface
                                     ->thenInvalid('PHP >= 5.4.0 is required to use traits.')
                                 ->end()
                             ->end()
+                            ->integerNode('priority')
+                                ->info('Positive or negative integer. The higher the priority, the earlier it’s executed.')
+                                ->defaultValue(0)
+                            ->end()
                         ->end()
                     ->end()
                 ->end()

Resources/doc/reference/extensions.rst

@@ -100,6 +100,9 @@ uses:
     Requires PHP >= 5.4.0. Specify one or more traits. If the managed class of an admin uses one of the specified traits the extension will be
     added to that admin.
 
+priority:
+    Can be a positive or negative integer. The higher the priority, the earlier it’s executed.
+
 
 .. configuration-block::
 

Tests/DependencyInjection/Compiler/ExtensionCompilerPassTest.php

@@ -25,12 +25,6 @@ class ExtensionCompilerPassTest extends PHPUnit_Framework_TestCase
     /** @var array $config */
     private $config;
 
-    private $publishExtension;
-    private $historyExtension;
-    private $orderExtension;
-    private $securityExtension;
-    private $filterExtension;
-    private $timestampExtension;
     private $hasTraits;
 
     /**
@@ -46,13 +40,6 @@ class ExtensionCompilerPassTest extends PHPUnit_Framework_TestCase
         $this->config = $this->getConfig();
         $this->root = 'sonata.admin';
         $this->hasTraits = version_compare(PHP_VERSION, '5.4.0', '>=');
-
-        $this->publishExtension = $this->createMock('Sonata\AdminBundle\Admin\AdminExtensionInterface');
-        $this->historyExtension = $this->createMock('Sonata\AdminBundle\Admin\AdminExtensionInterface');
-        $this->orderExtension = $this->createMock('Sonata\AdminBundle\Admin\AdminExtensionInterface');
-        $this->securityExtension = $this->createMock('Sonata\AdminBundle\Admin\AdminExtensionInterface');
-        $this->filterExtension = $this->createMock('Sonata\AdminBundle\Admin\AdminExtensionInterface');
-        $this->timestampExtension = $this->createMock('Sonata\AdminBundle\Admin\AdminExtensionInterface');
     }
 
     /**
@@ -123,7 +110,7 @@ class ExtensionCompilerPassTest extends PHPUnit_Framework_TestCase
         $this->assertArrayHasKey('admins', $extensionMap);
         $this->assertCount(1, $extensionMap['admins']);
 
-        $this->assertContains('sonata_extension_publish', $extensionMap['admins']['sonata_post_admin']);
+        $this->assertArrayHasKey('sonata_extension_publish', $extensionMap['admins']['sonata_post_admin']);
         $this->assertCount(1, $extensionMap['admins']['sonata_post_admin']);
 
         // Excludes
@@ -132,11 +119,11 @@ class ExtensionCompilerPassTest extends PHPUnit_Framework_TestCase
 
         $this->assertArrayHasKey('sonata_article_admin', $extensionMap['excludes']);
         $this->assertCount(1, $extensionMap['excludes']['sonata_article_admin']);
-        $this->assertContains('sonata_extension_history', $extensionMap['excludes']['sonata_article_admin']);
+        $this->assertArrayHasKey('sonata_extension_history', $extensionMap['excludes']['sonata_article_admin']);
 
         $this->assertArrayHasKey('sonata_post_admin', $extensionMap['excludes']);
         $this->assertCount(1, $extensionMap['excludes']['sonata_post_admin']);
-        $this->assertContains('sonata_extension_order', $extensionMap['excludes']['sonata_post_admin']);
+        $this->assertArrayHasKey('sonata_extension_order', $extensionMap['excludes']['sonata_post_admin']);
 
         // Implements
         $this->assertArrayHasKey('implements', $extensionMap);
@@ -144,8 +131,8 @@ class ExtensionCompilerPassTest extends PHPUnit_Framework_TestCase
 
         $this->assertArrayHasKey('Sonata\AdminBundle\Tests\DependencyInjection\Publishable', $extensionMap['implements']);
         $this->assertCount(2, $extensionMap['implements']['Sonata\AdminBundle\Tests\DependencyInjection\Publishable']);
-        $this->assertContains('sonata_extension_publish', $extensionMap['implements']['Sonata\AdminBundle\Tests\DependencyInjection\Publishable']);
-        $this->assertContains('sonata_extension_order', $extensionMap['implements']['Sonata\AdminBundle\Tests\DependencyInjection\Publishable']);
+        $this->assertArrayHasKey('sonata_extension_publish', $extensionMap['implements']['Sonata\AdminBundle\Tests\DependencyInjection\Publishable']);
+        $this->assertArrayHasKey('sonata_extension_order', $extensionMap['implements']['Sonata\AdminBundle\Tests\DependencyInjection\Publishable']);
 
         // Extends
         $this->assertArrayHasKey('extends', $extensionMap);
@@ -153,7 +140,7 @@ class ExtensionCompilerPassTest extends PHPUnit_Framework_TestCase
 
         $this->assertArrayHasKey('Sonata\AdminBundle\Tests\DependencyInjection\Post', $extensionMap['extends']);
         $this->assertCount(1, $extensionMap['extends']['Sonata\AdminBundle\Tests\DependencyInjection\Post']);
-        $this->assertContains('sonata_extension_order', $extensionMap['extends']['Sonata\AdminBundle\Tests\DependencyInjection\Post']);
+        $this->assertArrayHasKey('sonata_extension_order', $extensionMap['extends']['Sonata\AdminBundle\Tests\DependencyInjection\Post']);
 
         // Instanceof
         $this->assertArrayHasKey('instanceof', $extensionMap);
@@ -161,7 +148,7 @@ class ExtensionCompilerPassTest extends PHPUnit_Framework_TestCase
 
         $this->assertArrayHasKey('Sonata\AdminBundle\Tests\DependencyInjection\Post', $extensionMap['instanceof']);
         $this->assertCount(1, $extensionMap['instanceof']['Sonata\AdminBundle\Tests\DependencyInjection\Post']);
-        $this->assertContains('sonata_extension_history', $extensionMap['instanceof']['Sonata\AdminBundle\Tests\DependencyInjection\Post']);
+        $this->assertArrayHasKey('sonata_extension_history', $extensionMap['instanceof']['Sonata\AdminBundle\Tests\DependencyInjection\Post']);
 
         // Uses
         $this->assertArrayHasKey('uses', $extensionMap);
@@ -170,7 +157,7 @@ class ExtensionCompilerPassTest extends PHPUnit_Framework_TestCase
             $this->assertCount(1, $extensionMap['uses']);
             $this->assertArrayHasKey('Sonata\AdminBundle\Tests\Fixtures\DependencyInjection\TimestampableTrait', $extensionMap['uses']);
             $this->assertCount(1, $extensionMap['uses']['Sonata\AdminBundle\Tests\Fixtures\DependencyInjection\TimestampableTrait']);
-            $this->assertContains('sonata_extension_post', $extensionMap['uses']['Sonata\AdminBundle\Tests\Fixtures\DependencyInjection\TimestampableTrait']);
+            $this->assertArrayHasKey('sonata_extension_post', $extensionMap['uses']['Sonata\AdminBundle\Tests\Fixtures\DependencyInjection\TimestampableTrait']);
         } else {
             $this->assertCount(0, $extensionMap['uses']);
             $this->assertArrayNotHasKey('Sonata\AdminBundle\Tests\Fixtures\DependencyInjection\TimestampableTrait', $extensionMap['uses']);
@@ -246,30 +233,36 @@ class ExtensionCompilerPassTest extends PHPUnit_Framework_TestCase
         $this->assertTrue($container->hasDefinition('sonata_article_admin'));
         $this->assertTrue($container->hasDefinition('sonata_news_admin'));
 
+        $securityExtension = $container->get('sonata_extension_security');
+        $publishExtension = $container->get('sonata_extension_publish');
+        $historyExtension = $container->get('sonata_extension_history');
+        $orderExtension = $container->get('sonata_extension_order');
+        $filterExtension = $container->get('sonata_extension_filter');
+
         $def = $container->get('sonata_post_admin');
         $extensions = $def->getExtensions();
         $this->assertCount(4, $extensions);
 
-        $this->assertInstanceOf(get_class($this->securityExtension), $extensions[0]);
-        $this->assertInstanceOf(get_class($this->publishExtension), $extensions[1]);
-        $this->assertInstanceOf(get_class($this->historyExtension), $extensions[2]);
+        $this->assertSame($historyExtension, $extensions[0]);
+        $this->assertSame($publishExtension, $extensions[2]);
+        $this->assertSame($securityExtension, $extensions[3]);
 
         $def = $container->get('sonata_article_admin');
         $extensions = $def->getExtensions();
         $this->assertCount(5, $extensions);
 
-        $this->assertInstanceOf(get_class($this->securityExtension), $extensions[0]);
-        $this->assertInstanceOf(get_class($this->publishExtension), $extensions[1]);
-        $this->assertInstanceOf(get_class($this->orderExtension), $extensions[2]);
-        $this->assertInstanceOf(get_class($this->filterExtension), $extensions[4]);
+        $this->assertSame($filterExtension, $extensions[0]);
+        $this->assertSame($securityExtension, $extensions[1]);
+        $this->assertSame($publishExtension, $extensions[2]);
+        $this->assertSame($orderExtension, $extensions[4]);
 
         $def = $container->get('sonata_news_admin');
         $extensions = $def->getExtensions();
         $this->assertCount(5, $extensions);
-        $this->assertInstanceOf(get_class($this->securityExtension), $extensions[0]);
-        $this->assertInstanceOf(get_class($this->orderExtension), $extensions[1]);
-        $this->assertInstanceOf(get_class($this->historyExtension), $extensions[2]);
-        $this->assertInstanceOf(get_class($this->filterExtension), $extensions[4]);
+        $this->assertSame($historyExtension, $extensions[0]);
+        $this->assertSame($securityExtension, $extensions[1]);
+        $this->assertSame($filterExtension, $extensions[2]);
+        $this->assertSame($orderExtension, $extensions[4]);
     }
 
     public function testProcessThrowsExceptionIfTraitsAreNotAvailable()
@@ -308,11 +301,13 @@ class ExtensionCompilerPassTest extends PHPUnit_Framework_TestCase
                 'sonata_extension_history' => array(
                     'excludes' => array('sonata_article_admin'),
                     'instanceof' => array('Sonata\AdminBundle\Tests\DependencyInjection\Post'),
+                    'priority' => 255,
                 ),
                 'sonata_extension_order' => array(
                     'excludes' => array('sonata_post_admin'),
                     'extends' => array('Sonata\AdminBundle\Tests\DependencyInjection\Post'),
                     'implements' => array('Sonata\AdminBundle\Tests\DependencyInjection\Publishable'),
+                    'priority' => -128,
                 ),
             ),
         );
@@ -390,25 +385,27 @@ class ExtensionCompilerPassTest extends PHPUnit_Framework_TestCase
             ->setClass('Symfony\Component\EventDispatcher\EventDispatcher');
 
         // Add admin extension definition's
+        $extensionClass = get_class($this->createMock('Sonata\AdminBundle\Admin\AdminExtensionInterface'));
+
         $container
             ->register('sonata_extension_publish')
-            ->setClass(get_class($this->publishExtension));
+            ->setClass($extensionClass);
         $container
             ->register('sonata_extension_history')
-            ->setClass(get_class($this->historyExtension));
+            ->setClass($extensionClass);
         $container
             ->register('sonata_extension_order')
-            ->setClass(get_class($this->orderExtension));
+            ->setClass($extensionClass);
         $container
             ->register('sonata_extension_timestamp')
-            ->setClass(get_class($this->timestampExtension));
+            ->setClass($extensionClass);
         $container
             ->register('sonata_extension_security')
-            ->setClass(get_class($this->securityExtension))
+            ->setClass($extensionClass)
             ->addTag('sonata.admin.extension', array('global' => true));
         $container
             ->register('sonata_extension_filter')
-            ->setClass(get_class($this->filterExtension))
+            ->setClass($extensionClass)
             ->addTag('sonata.admin.extension', array('target' => 'sonata_news_admin'))
             ->addTag('sonata.admin.extension', array('target' => 'sonata_article_admin'));