Allowed extensions to inline compiler passes

wouterj · wouterj · commit 8d0edd0b9fbb · 2015-02-22T15:59:16.000+01:00
diff --git a/src/Symfony/Component/DependencyInjection/Compiler/InlineCompilePass.php b/src/Symfony/Component/DependencyInjection/Compiler/InlineCompilePass.php
@@ -0,0 +1,28 @@
+<?php
+
+namespace Symfony\Component\DependencyInjection\Compiler;
+
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\Extension\CompilerExtensionInterface;
+
+/**
+ * A pass to execute inline compiler passes in extensions.
+ *
+ * @author Wouter J <wouter@wouterj.nl>
+ */
+class InlineCompilePass implements CompilerPassInterface
+{
+    /**
+     * {@inheritdoc}
+     */
+    public function process(ContainerBuilder $container)
+    {
+        foreach ($container->getExtensions() as $extension) {
+            if (!$extension instanceof CompilerExtensionInterface) {
+                continue;
+            }
+
+            $extension->compile($container);
+        }
+    }
+}
diff --git a/src/Symfony/Component/DependencyInjection/Compiler/PassConfig.php b/src/Symfony/Component/DependencyInjection/Compiler/PassConfig.php
@@ -45,6 +45,7 @@ public function __construct()
         $this->mergePass = new MergeExtensionConfigurationPass();
 
         $this->optimizationPasses = array(
+            new InlineCompilePass(),
             new ResolveDefinitionTemplatesPass(),
             new DecoratorServicePass(),
             new ResolveParameterPlaceHoldersPass(),
diff --git a/src/Symfony/Component/DependencyInjection/Extension/CompilerExtensionInterface.php b/src/Symfony/Component/DependencyInjection/Extension/CompilerExtensionInterface.php
@@ -0,0 +1,22 @@
+<?php
+
+namespace Symfony\Component\DependencyInjection\Extension;
+
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+
+/**
+ * An interface which must be implemented by extensions providing compile functionality.
+ *
+ * Compilers can modify/add/delete definitions when the container is compiled.
+ *
+ * @author Wouter J <wouter@wouterj.nl>
+ */
+interface CompilerExtensionInterface
+{
+    /**
+     * This method is executed by a compiler pass.
+     *
+     * @param ContainerBuilder $container
+     */
+    public function compile(ContainerBuilder $container);
+}
diff --git a/src/Symfony/Component/DependencyInjection/Tests/Compiler/InlineCompilePassTest.php b/src/Symfony/Component/DependencyInjection/Tests/Compiler/InlineCompilePassTest.php
@@ -0,0 +1,42 @@
+<?php
+
+namespace Symfony\Component\DependencyInjection\Tests\Compiler;
+
+use Symfony\Component\DependencyInjection\Compiler\InlineCompilePass;
+
+/**
+ * @author Wouter J <wouter@wouterj.nl>
+ */
+class InlineCompilePassTest extends \PHPUnit_Framework_TestCase
+{
+    private $container;
+    private $pass;
+
+    public function setUp()
+    {
+        $this->container = $this->getMock('Symfony\Component\DependencyInjection\ContainerBuilder');
+        $this->pass = new InlineCompilePass();
+    }
+
+    public function testProcess()
+    {
+        $extension1 = $this->createExtensionMock(true);
+        $extension1->expects($this->once())->method('compile');
+        $extension2 = $this->createExtensionMock(false);
+        $extension3 = $this->createExtensionMock(false);
+        $extension4 = $this->createExtensionMock(true);
+        $extension4->expects($this->once())->method('compile');
+
+        $this->container->expects($this->any())
+            ->method('getExtensions')
+            ->will($this->returnValue(array($extension1, $extension2, $extension3, $extension4)))
+        ;
+
+        $this->pass->process($this->container);
+    }
+
+    private function createExtensionMock($hasInlineCompile)
+    {
+        return $this->getMock('Symfony\Component\DependencyInjection\Extension\\'.($hasInlineCompile ? 'CompilerExtensionInterface' : 'ExtensionInterface'));
+    }
+}
