feature #32845 [HttpKernel][FrameworkBundle] Add alternative convention for bundle directories (yceruto)

nicolas-grekas · nicolas-grekas · commit 579adc6529b5 · 2019-08-13T15:29:11.000+02:00
This PR was squashed before being merged into the 4.4 branch (closes #32845). Discussion ---------- [HttpKernel][FrameworkBundle] Add alternative convention for bundle directories | Q | A | ------------- | --- | Branch? | 4.4 | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | symfony/symfony#32453 | License | MIT | Doc PR | TODO We already know that bundles must be compatible with many Symfony's versions, so it is very likely that current bundles won't be able to use this feature soon, unless they create symbolic links to support both structures. The point is that this is already happening, so in the future when our bundles stop to support <=4.3 then you'll be sure to change the current directory structure. We have recently added the `getPublicDir()` method in symfony/symfony#31975, here I'm removing it in favor of hardcoding a new convention. I've added some functional tests in which I've changed everything to this structure: ``` -- ModernBundle |-- config/ |-- public/ |-- src/ |-- ModernBundle.php |-- templates/ |-- translations/ ``` WDYT? Commits ------- 6996e1cbe2 [HttpKernel][FrameworkBundle] Add alternative convention for bundle directories
diff --git a/DependencyInjection/TwigExtension.php b/DependencyInjection/TwigExtension.php
@@ -188,7 +188,7 @@ private function getBundleTemplatePaths(ContainerBuilder $container, array $conf
             }
             $container->addResource(new FileExistenceResource($defaultOverrideBundlePath));
 
-            if (file_exists($dir = $bundle['path'].'/Resources/views')) {
+            if (file_exists($dir = $bundle['path'].'/Resources/views') || file_exists($dir = $bundle['path'].'/templates')) {
                 $bundleHierarchy[$name][] = $dir;
             }
             $container->addResource(new FileExistenceResource($dir));
diff --git a/TemplateIterator.php b/TemplateIterator.php
@@ -65,9 +65,11 @@ public function getIterator()
                 $name = substr($name, 0, -6);
             }
 
+            $bundleTemplatesDir = is_dir($bundle->getPath().'/Resources/views') ? $bundle->getPath().'/Resources/views' : $bundle->getPath().'/templates';
+
             $templates = array_merge(
                 $templates,
-                $this->findTemplatesInDirectory($bundle->getPath().'/Resources/views', $name),
+                $this->findTemplatesInDirectory($bundleTemplatesDir, $name),
                 $this->findTemplatesInDirectory($this->rootDir.'/Resources/'.$bundle->getName().'/views', $name)
             );
             if (null !== $this->defaultPath) {

Original file line number	Diff line number	Diff line change
`@@ -188,7 +188,7 @@ private function getBundleTemplatePaths(ContainerBuilder $container, array $conf`
`188`	`188`	`}`
`189`	`189`	`$container->addResource(new FileExistenceResource($defaultOverrideBundlePath));`
`190`	`190`
`191`		`- if (file_exists($dir = $bundle['path'].'/Resources/views')) {`
	`191`	`+ if (file_exists($dir = $bundle['path'].'/Resources/views') \|\| file_exists($dir = $bundle['path'].'/templates')) {`
`192`	`192`	`$bundleHierarchy[$name][] = $dir;`
`193`	`193`	`}`
`194`	`194`	`$container->addResource(new FileExistenceResource($dir));`