minor #32452 [Bundles] Rename getPublicPath() as getPublicDir() (javiereguiluz)

fabpot · fabpot · commit adcd643094a5 · 2019-07-12T07:45:48.000+03:00
This PR was squashed before being merged into the 4.4 branch (closes #32452). Discussion ---------- [Bundles] Rename getPublicPath() as getPublicDir() | Q | A | ------------- | --- | Branch? | 4.4 | Bug fix? | no | New feature? | no  | BC breaks? | no  | Deprecations? | no  | Tests pass? | yes  | Fixed tickets | - | License | MIT | Doc PR | I'll add this if approved While documenting #31975 (see symfony/symfony-docs#11930) I realized that the `getPublicPath()` method name is not consistent with the rest of Symfony. In Symfony, "path" is usually associated to routes and we use "dir" for things similar to this: * `getCacheDir()` and `getLogdir()` to override Symfony structure (https://symfony.com/doc/current/configuration/override_dir_structure.html) * `binDir`, `configDir`, `srcDir`, `varDir`, `publicDir` in Symfony Flex recipes (https://github.com/symfony/recipes) to override the dir structure So, this PR proposes to rename `getPublicPath()` as `getPublicDir()` Commits ------- 4ab2f99 [Bundles] Rename getPublicPath() as getPublicDir()
diff --git a/src/Symfony/Bundle/FrameworkBundle/Command/AssetsInstallCommand.php b/src/Symfony/Bundle/FrameworkBundle/Command/AssetsInstallCommand.php
@@ -137,13 +137,13 @@ protected function execute(InputInterface $input, OutputInterface $output)
         $validAssetDirs = [];
         /** @var BundleInterface $bundle */
         foreach ($kernel->getBundles() as $bundle) {
-            if (!method_exists($bundle, 'getPublicPath')) {
-                @trigger_error('Not defining "getPublicPath()" method is deprecated since Symfony 4.4 and will not be supported in 5.0.', E_USER_DEPRECATED);
-                $publicPath = 'Resources/public';
+            if (!method_exists($bundle, 'getPublicDir')) {
+                @trigger_error(sprintf('Not defining "getPublicDir()" method in the "%s" class is deprecated since Symfony 4.4 and will not be supported in 5.0.', get_class($bundle)), E_USER_DEPRECATED);
+                $publicDir = 'Resources/public';
             } else {
-                $publicPath = $bundle->getPublicPath();
+                $publicDir = ltrim($bundle->getPublicDir(), '\\/');
             }
-            if (!is_dir($originDir = $bundle->getPath().\DIRECTORY_SEPARATOR.$publicPath)) {
+            if (!is_dir($originDir = $bundle->getPath().\DIRECTORY_SEPARATOR.$publicDir)) {
                 continue;
             }
 
diff --git a/src/Symfony/Component/HttpKernel/Bundle/Bundle.php b/src/Symfony/Component/HttpKernel/Bundle/Bundle.php
@@ -135,7 +135,7 @@ public function registerCommands(Application $application)
     {
     }
 
-    public function getPublicPath(): string
+    public function getPublicDir(): string
     {
         return 'Resources/public';
     }
diff --git a/src/Symfony/Component/HttpKernel/Bundle/BundleInterface.php b/src/Symfony/Component/HttpKernel/Bundle/BundleInterface.php
@@ -20,7 +20,7 @@
  *
  * @author Fabien Potencier <fabien@symfony.com>
  *
- * @method string getPublicPath() Returns relative path for public assets
+ * @method string getPublicDir() Returns relative path for the public assets directory
  */
 interface BundleInterface extends ContainerAwareInterface
 {
diff --git a/src/Symfony/Component/HttpKernel/Tests/KernelTest.php b/src/Symfony/Component/HttpKernel/Tests/KernelTest.php
@@ -627,7 +627,7 @@ protected function getBundle($dir = null, $parent = null, $className = null, $bu
     {
         $bundle = $this
             ->getMockBuilder('Symfony\Component\HttpKernel\Bundle\BundleInterface')
-            ->setMethods(['getPath', 'getPublicPath', 'getParent', 'getName'])
+            ->setMethods(['getPath', 'getPublicDir', 'getParent', 'getName'])
             ->disableOriginalConstructor()
         ;
 
@@ -651,7 +651,7 @@ protected function getBundle($dir = null, $parent = null, $className = null, $bu
 
         $bundle
             ->expects($this->any())
-            ->method('getPublicPath')
+            ->method('getPublicDir')
             ->willReturn('Resources/public')
         ;
 

Original file line number	Diff line number	Diff line change
`@@ -135,7 +135,7 @@ public function registerCommands(Application $application)`
`135`	`135`	`{`
`136`	`136`	`}`
`137`	`137`
`138`		`- public function getPublicPath(): string`
	`138`	`+ public function getPublicDir(): string`
`139`	`139`	`{`
`140`	`140`	`return 'Resources/public';`
`141`	`141`	`}`
Original file line number	Diff line number	Diff line change
`@@ -20,7 +20,7 @@`
`20`	`20`	`*`
`21`	`21`	`* @author Fabien Potencier <fabien@symfony.com>`
`22`	`22`	`*`
`23`		`- * @method string getPublicPath() Returns relative path for public assets`
	`23`	`+ * @method string getPublicDir() Returns relative path for the public assets directory`
`24`	`24`	`*/`
`25`	`25`	`interface BundleInterface extends ContainerAwareInterface`
`26`	`26`	`{`
Original file line number	Diff line number	Diff line change
`@@ -627,7 +627,7 @@ protected function getBundle($dir = null, $parent = null, $className = null, $bu`
`627`	`627`	`{`
`628`	`628`	`$bundle = $this`
`629`	`629`	`->getMockBuilder('Symfony\Component\HttpKernel\Bundle\BundleInterface')`
`630`		`- ->setMethods(['getPath', 'getPublicPath', 'getParent', 'getName'])`
	`630`	`+ ->setMethods(['getPath', 'getPublicDir', 'getParent', 'getName'])`
`631`	`631`	`->disableOriginalConstructor()`
`632`	`632`	`;`
`633`	`633`
`@@ -651,7 +651,7 @@ protected function getBundle($dir = null, $parent = null, $className = null, $bu`
`651`	`651`
`652`	`652`	`$bundle`
`653`	`653`	`->expects($this->any())`
`654`		`- ->method('getPublicPath')`
	`654`	`+ ->method('getPublicDir')`
`655`	`655`	`->willReturn('Resources/public')`
`656`	`656`	`;`
`657`	`657`