bug #46385 [HttpKernel] New bundle path convention when AbstractBundle is used (yceruto)

nicolas-grekas · nicolas-grekas · commit 39575e992253 · 2022-05-21T11:04:07.000+02:00
This PR was merged into the 6.1 branch. Discussion ---------- [HttpKernel] New bundle path convention when `AbstractBundle` is used | Q | A | ------------- | --- | Branch? | 6.1 | Bug fix? | no | New feature? | yes | Deprecations? | no | Tickets | - | License | MIT | Doc PR | symfony/symfony-docs#16801 Addressing this comment symfony/symfony-docs#16801 (comment) Since Symfony 6.1 when any bundle starts using the new `AbstractBundle` and the bundle is placed in the `src/` directory we automatically update this path to the parent directory, so we don't have to do it manually to use [the modern bundle directory structure](https://symfony.com/doc/current/bundles/best_practices.html#directory-structure). As far as I can see, there is no BC break on this proposal as this is a new class introduced in 6.1 and you have to update your code to make this happen. I will add a note about this subject in the doc too. Commits ------- 1193ed2 New bundle path convention when AbstractBundle is used
diff --git a/src/Symfony/Component/HttpKernel/Bundle/AbstractBundle.php b/src/Symfony/Component/HttpKernel/Bundle/AbstractBundle.php
@@ -47,4 +47,18 @@ public function getContainerExtension(): ?ExtensionInterface
 
         return $this->extension ??= new BundleExtension($this, $this->extensionAlias);
     }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getPath(): string
+    {
+        if (null === $this->path) {
+            $reflected = new \ReflectionObject($this);
+            // assume the modern directory structure by default
+            $this->path = \dirname($reflected->getFileName(), 2);
+        }
+
+        return $this->path;
+    }
 }
diff --git a/src/Symfony/Component/HttpKernel/CHANGELOG.md b/src/Symfony/Component/HttpKernel/CHANGELOG.md
@@ -10,6 +10,7 @@ CHANGELOG
  * Add `Profiler::isEnabled()` so collaborating collector services may elect to omit themselves
  * Add the `UidValueResolver` argument value resolver
  * Add `AbstractBundle` class for DI configuration/definition on a single file
+ * Update the path of a bundle placed in the `src/` directory to the parent directory when `AbstractBundle` is used
 
 6.0
 ---
