symfony · alterphp · Mar 11, 2019 · Mar 12, 2019 · Mar 12, 2019 · Mar 12, 2019
diff --git a/src/Symfony/Bundle/TwigBundle/DependencyInjection/Compiler/BundleViewPathPass.php b/src/Symfony/Bundle/TwigBundle/DependencyInjection/Compiler/BundleViewPathPass.php
@@ -0,0 +1,45 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Bundle\TwigBundle\DependencyInjection\Compiler;
+
+use Symfony\Component\Config\Resource\FileExistenceResource;
+use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+
+/**
+ * Registers the bundles view paths.
+ */
+final class BundleViewPathPass implements CompilerPassInterface
+{
+    public function process(ContainerBuilder $container)
+    {
+        $twigFilesystemLoaderDefinition = $container->findDefinition('twig.loader.filesystem');
+
+        foreach ($container->getParameter('kernel.bundles_metadata') as $name => $bundle) {
+            if (file_exists($dir = $bundle['path'].'/Resources/views')) {
+                $namespace = $this->normalizeBundleName($name);
+                $twigFilesystemLoaderDefinition->addMethodCall('addPath', [$dir, $namespace]);
+                $twigFilesystemLoaderDefinition->addMethodCall('addPath', [$dir, '!'.$namespace]);
+            }
+            $container->addResource(new FileExistenceResource($dir));
+        }
+    }
+
+    private function normalizeBundleName(string $name): string
+    {
+        if ('Bundle' === substr($name, -6)) {
+            $name = substr($name, 0, -6);
+        }
+
+        return $name;
+    }
+}
diff --git a/src/Symfony/Bundle/TwigBundle/DependencyInjection/TwigExtension.php b/src/Symfony/Bundle/TwigBundle/DependencyInjection/TwigExtension.php
@@ -113,11 +113,6 @@ public function load(array $configs, ContainerBuilder $container)
             foreach ($paths as $path) {
                 $twigFilesystemLoaderDefinition->addMethodCall('addPath', [$path, $namespace]);
             }
-
-            if ($paths) {
-                // the last path must be the bundle views directory
-                $twigFilesystemLoaderDefinition->addMethodCall('addPath', [$path, '!'.$namespace]);
-            }
         }
 
         if (file_exists($dir = $container->getParameter('kernel.root_dir').'/Resources/views')) {
@@ -187,11 +182,6 @@ private function getBundleTemplatePaths(ContainerBuilder $container, array $conf
                 $bundleHierarchy[$name][] = $defaultOverrideBundlePath;
             }
             $container->addResource(new FileExistenceResource($defaultOverrideBundlePath));
-
-            if (file_exists($dir = $bundle['path'].'/Resources/views')) {
-                $bundleHierarchy[$name][] = $dir;
-            }
-            $container->addResource(new FileExistenceResource($dir));
         }
 
         return $bundleHierarchy;

diff --git a/...wigBundle/Tests/DependencyInjection/Fixtures/templates/bundles/BarBundle/layout.html.twig b/...wigBundle/Tests/DependencyInjection/Fixtures/templates/bundles/BarBundle/layout.html.twig
@@ -1 +1 @@
-This is a layout
+This is user-defined BarBundle layout
diff --git a/...igBundle/Tests/DependencyInjection/Fixtures/templates/bundles/TwigBundle/layout.html.twig b/...igBundle/Tests/DependencyInjection/Fixtures/templates/bundles/TwigBundle/layout.html.twig
@@ -1 +1 @@
-This is a layout
+This is TwigBundle layout
diff --git a/...Tests/DependencyInjection/Fixtures/third-party/BarBundle/Resources/views/layout.html.twig b/...Tests/DependencyInjection/Fixtures/third-party/BarBundle/Resources/views/layout.html.twig
@@ -0,0 +1 @@
+This is base BarBundle layout
diff --git a/.../Tests/DependencyInjection/Fixtures/third-party/BarExtensionBundle/BarExtensionBundle.php b/.../Tests/DependencyInjection/Fixtures/third-party/BarExtensionBundle/BarExtensionBundle.php
@@ -0,0 +1,27 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace ThirdParty\BarExtensionBundle;
+
+use Symfony\Component\DependencyInjection\Compiler\PassConfig;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\HttpKernel\Bundle\Bundle;
+use ThirdParty\BarExtensionBundle\DependencyInjection\Compiler\OverrideBarBundlePathPass;
+
+class BarExtensionBundle extends Bundle
+{
+    public function build(ContainerBuilder $container)
+    {
+        parent::build($container);
+
+        $container->addCompilerPass(new OverrideBarBundlePathPass(), PassConfig::TYPE_BEFORE_OPTIMIZATION);
+    }
+}
diff --git a/...third-party/BarExtensionBundle/DependencyInjection/Compiler/OverrideBarBundlePathPass.php b/...third-party/BarExtensionBundle/DependencyInjection/Compiler/OverrideBarBundlePathPass.php
@@ -0,0 +1,26 @@
+<?php
+
+namespace ThirdParty\BarExtensionBundle\DependencyInjection\Compiler;
+
+use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+use ThirdParty\BarExtensionBundle\BarExtensionBundle;
+
+class OverrideBarBundlePathPass implements CompilerPassInterface
+{
+    public function process(ContainerBuilder $container)
+    {
+        $twigLoaderFilesystemDefinition = $container->findDefinition('twig.loader.filesystem');
+
+        // Replaces native Bar templates
+        $barExtensionBundleRefl = new \ReflectionClass(BarExtensionBundle::class);
+        if ($barExtensionBundleRefl->isUserDefined()) {
+            $barExtensionBundlePath = \dirname((string) $barExtensionBundleRefl->getFileName());
+            $barExtensionBundleTwigPath = $barExtensionBundlePath.'/Resources/views';
+            $twigLoaderFilesystemDefinition->addMethodCall(
+                'addPath',
+                [$barExtensionBundleTwigPath, 'Bar']
+            );
+        }
+    }
+}
diff --git a/...endencyInjection/Fixtures/third-party/BarExtensionBundle/Resources/views/layout.html.twig b/...endencyInjection/Fixtures/third-party/BarExtensionBundle/Resources/views/layout.html.twig
@@ -0,0 +1 @@
+This is BarExtensionBundle override of BarBundle layout
diff --git a/src/Symfony/Bundle/TwigBundle/Tests/DependencyInjection/TwigExtensionTest.php b/src/Symfony/Bundle/TwigBundle/Tests/DependencyInjection/TwigExtensionTest.php
@@ -11,6 +11,8 @@
 
 namespace Symfony\Bundle\TwigBundle\Tests\DependencyInjection;
 
+use Symfony\Bundle\TwigBundle\DependencyInjection\Compiler\BundleViewPathPass;
+use Symfony\Bundle\TwigBundle\DependencyInjection\Compiler\ExtensionPass;
 use Symfony\Bundle\TwigBundle\DependencyInjection\Compiler\RuntimeLoaderPass;
 use Symfony\Bundle\TwigBundle\DependencyInjection\TwigExtension;
 use Symfony\Bundle\TwigBundle\Tests\TestCase;
@@ -22,6 +24,7 @@
 use Symfony\Component\DependencyInjection\Loader\YamlFileLoader;
 use Symfony\Component\DependencyInjection\ParameterBag\ParameterBag;
 use Symfony\Component\DependencyInjection\Reference;
+use ThirdParty\BarExtensionBundle\DependencyInjection\Compiler\OverrideBarBundlePathPass;
 
 class TwigExtensionTest extends TestCase
 {
@@ -177,10 +180,13 @@ public function testTwigLoaderPaths($format)
         $container->registerExtension(new TwigExtension());
         $this->loadFromFile($container, 'full', $format);
         $this->loadFromFile($container, 'extra', $format);
+        $container->addCompilerPass(new ExtensionPass());
+        $container->addCompilerPass(new BundleViewPathPass(), PassConfig::TYPE_BEFORE_OPTIMIZATION, -16);
         $this->compileContainer($container);
 
-        $def = $container->getDefinition('twig.loader.native_filesystem');
+        $def = $container->findDefinition('twig.loader.filesystem');
         $paths = [];
+
         foreach ($def->getMethodCalls() as $call) {
             if ('addPath' === $call[0] && false === strpos($call[1][0], 'Form')) {
                 $paths[] = $call[1];
@@ -194,9 +200,9 @@ public function testTwigLoaderPaths($format)
             ['namespaced_path2', 'namespace2'],
             ['namespaced_path3', 'namespace3'],
             [__DIR__.'/Fixtures/templates/bundles/TwigBundle', 'Twig'],
+            [__DIR__.'/Fixtures/templates'],
             [realpath(__DIR__.'/../..').'/Resources/views', 'Twig'],
             [realpath(__DIR__.'/../..').'/Resources/views', '!Twig'],
-            [__DIR__.'/Fixtures/templates'],
         ], $paths);
     }
 
@@ -212,9 +218,11 @@ public function testLegacyTwigLoaderPaths($format)
         $container->registerExtension(new TwigExtension());
         $this->loadFromFile($container, 'full', $format);
         $this->loadFromFile($container, 'extra', $format);
+        $container->addCompilerPass(new ExtensionPass());
+        $container->addCompilerPass(new BundleViewPathPass(), PassConfig::TYPE_BEFORE_OPTIMIZATION, -16);
         $this->compileContainer($container);
 
-        $def = $container->getDefinition('twig.loader.native_filesystem');
+        $def = $container->findDefinition('twig.loader.filesystem');
         $paths = [];
         foreach ($def->getMethodCalls() as $call) {
             if ('addPath' === $call[0] && false === strpos($call[1][0], 'Form')) {
@@ -230,10 +238,82 @@ public function testLegacyTwigLoaderPaths($format)
             ['namespaced_path3', 'namespace3'],
             [__DIR__.'/../Fixtures/templates/Resources/TwigBundle/views', 'Twig'],
             [__DIR__.'/Fixtures/templates/bundles/TwigBundle', 'Twig'],
-            [realpath(__DIR__.'/../..').'/Resources/views', 'Twig'],
-            [realpath(__DIR__.'/../..').'/Resources/views', '!Twig'],
             [__DIR__.'/../Fixtures/templates/Resources/views'],
             [__DIR__.'/Fixtures/templates'],
+            [realpath(__DIR__.'/../..').'/Resources/views', 'Twig'],
+            [realpath(__DIR__.'/../..').'/Resources/views', '!Twig'],
+        ], $paths);
+    }
+
+    /**
+     * @dataProvider getFormats
+     */
+    public function testThirdPartyBundlesMayOverrideBetweenThem($format)
+    {
+        $container = $this->createContainer();
+        $container->registerExtension(new TwigExtension());
+        $this->loadFromFile($container, 'full', $format);
+        $this->loadFromFile($container, 'extra', $format);
+        $container->addCompilerPass(new ExtensionPass());
+        $container->addCompilerPass(new BundleViewPathPass(), PassConfig::TYPE_BEFORE_OPTIMIZATION, -16);
+        // Adds 2 third-party bundles whom second overrides first one's templates
+        require_once __DIR__.'/Fixtures/third-party/BarExtensionBundle/BarExtensionBundle.php';
+        require_once __DIR__.'/Fixtures/third-party/BarExtensionBundle/DependencyInjection/Compiler/OverrideBarBundlePathPass.php';
+        $container->setParameter(
+            'kernel.bundles',
+            \array_merge(
+                $container->getParameter('kernel.bundles'),
+                [
+                    'BarBundle' => 'ThirdParty\\BarBundle\\BarBundle',
+                    'BarExtensionBundle' => 'ThirdParty\\BarExtensionBundle\\BarExtensionBundle',
+                ]
+            )
+        );
+        $container->setParameter(
+            'kernel.bundles_metadata',
+            \array_merge(
+                $container->getParameter('kernel.bundles_metadata'),
+                [
+                    'BarBundle' => [
+                        'namespace' => 'ThirdParty\\BarBundle',
+                        'path' => __DIR__.'/Fixtures/third-party/BarBundle',
+                    ],
+                    'BarExtensionBundle' => [
+                        'namespace' => 'ThirdParty\\BarExtensionBundle',
+                        'path' => __DIR__.'/Fixtures/third-party/BarExtensionBundle',
+                    ],
+                ]
+            )
+        );
+        $container->addCompilerPass(new OverrideBarBundlePathPass(), PassConfig::TYPE_BEFORE_OPTIMIZATION);
+
+        $this->compileContainer($container);
+
+        $def = $container->findDefinition('twig.loader.filesystem');
+        $paths = [];
+
+        foreach ($def->getMethodCalls() as $call) {
+            if ('addPath' === $call[0] && false === strpos($call[1][0], 'Form')) {
+                $paths[] = $call[1];
+            }
+        }
+
+        $this->assertEquals([
+            ['path1'],
+            ['path2'],
+            ['namespaced_path1', 'namespace1'],
+            ['namespaced_path2', 'namespace2'],
+            ['namespaced_path3', 'namespace3'],
+            [realpath(__DIR__).'/Fixtures/templates/bundles/TwigBundle', 'Twig'],
+            [realpath(__DIR__).'/Fixtures/templates/bundles/BarBundle', 'Bar'],
+            [realpath(__DIR__).'/Fixtures/templates'],
+            [realpath(__DIR__.'/Fixtures/third-party/BarExtensionBundle').'/Resources/views', 'Bar'],
+            [realpath(__DIR__.'/../..').'/Resources/views', 'Twig'],
+            [realpath(__DIR__.'/../..').'/Resources/views', '!Twig'],
+            [realpath(__DIR__).'/Fixtures/third-party/BarBundle/Resources/views', 'Bar'],
+            [realpath(__DIR__).'/Fixtures/third-party/BarBundle/Resources/views', '!Bar'],
+            [realpath(__DIR__).'/Fixtures/third-party/BarExtensionBundle/Resources/views', 'BarExtension'],
+            [realpath(__DIR__).'/Fixtures/third-party/BarExtensionBundle/Resources/views', '!BarExtension'],
         ], $paths);
     }
 

diff --git a/src/Symfony/Bundle/TwigBundle/TwigBundle.php b/src/Symfony/Bundle/TwigBundle/TwigBundle.php
@@ -11,6 +11,7 @@
 
 namespace Symfony\Bundle\TwigBundle;
 
+use Symfony\Bundle\TwigBundle\DependencyInjection\Compiler\BundleViewPathPass;
 use Symfony\Bundle\TwigBundle\DependencyInjection\Compiler\ExceptionListenerPass;
 use Symfony\Bundle\TwigBundle\DependencyInjection\Compiler\ExtensionPass;
 use Symfony\Bundle\TwigBundle\DependencyInjection\Compiler\RuntimeLoaderPass;
@@ -36,6 +37,7 @@ public function build(ContainerBuilder $container)
         $container->addCompilerPass(new TwigEnvironmentPass());
         $container->addCompilerPass(new TwigLoaderPass());
         $container->addCompilerPass(new ExceptionListenerPass());
+        $container->addCompilerPass(new BundleViewPathPass(), PassConfig::TYPE_BEFORE_OPTIMIZATION, -16);
         $container->addCompilerPass(new RuntimeLoaderPass(), PassConfig::TYPE_BEFORE_REMOVING);
     }
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		This is a layout
		This is user-defined BarBundle layout
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		This is BarExtensionBundle override of BarBundle layout