Add AssetManager::getUrl() (#150)

* Add `AssetManager::getUrl()` * Update CHANGELOG.md --------- Co-authored-by: Alexander Makarov <[email protected]>
yiisoft · Dec 11, 2024 · aa82eff · aa82eff
1 parent f0604e8
commit aa82eff
Show file tree

Hide file tree

Showing 3 changed files with 29 additions and 5 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,6 +7,7 @@
 - Enh #119, #129: Add debug collector for `yiisoft/yii-debug` (@xepozz, @vjik)
 - Enh #148: Raise the minimum PHP version to 8.1 and minor refactoring (@vjik)
 - Enh #149: Improve `AssetBundle` properties' Psalm types (@vjik) 
+- New #150: Add `AssetManager::getUrl()` method instead of `getAssetUrl()` method that is marked as deprecated (@vjik)
 
 ## 4.0.0 February 13, 2023
 

diff --git a/src/AssetManager.php b/src/AssetManager.php
@@ -117,8 +117,25 @@ public function getBundle(string $name): AssetBundle
      * @throws InvalidConfigException If asset files are not found.
      *
      * @return string The actual URL for the specified asset.
+     *
+     * @deprecated Use {@see getUrl()} instead.
      */
     public function getAssetUrl(string $name, string $path): string
+    {
+        return $this->getUrl($name, $path);
+    }
+
+    /**
+     * Returns the actual URL for the specified asset.
+     *
+     * @param string $name The asset bundle name.
+     * @param string $path The asset path.
+     *
+     * @throws InvalidConfigException If asset files are not found.
+     *
+     * @return string The actual URL for the specified asset.
+     */
+    public function getUrl(string $name, string $path): string
     {
         return $this->loader->getAssetUrl($this->getBundle($name), $path);
     }

diff --git a/tests/AssetManagerTest.php b/tests/AssetManagerTest.php
@@ -511,7 +511,7 @@ public function testExportWithoutRegisterWithoutAllowedBundles(): void
         $this->manager->export(new JsonAssetExporter($this->aliases->get('@asset/test.json')));
     }
 
-    public function testGetAssetUrl(): void
+    public function testGetUrl(): void
     {
         $bundle = new ExportAsset();
         $sourcePath = $this->aliases->get($bundle->sourcePath);
@@ -523,20 +523,26 @@ public function testGetAssetUrl(): void
 
         $this->assertSame(
             $this->aliases->get("@assetUrl/{$hash}/css/stub.css"),
-            $this->manager->getAssetUrl(ExportAsset::class, 'css/stub.css'),
+            $this->manager->getUrl(ExportAsset::class, 'css/stub.css'),
         );
         $this->assertSame(
             $this->aliases->get("@assetUrl/{$hash}/js/stub.js"),
-            $this->manager->getAssetUrl(ExportAsset::class, 'js/stub.js'),
+            $this->manager->getUrl(ExportAsset::class, 'js/stub.js'),
         );
         $this->assertSame(
             $this->aliases->get("@assetUrl/{$hash}/export/stub.css"),
-            $this->manager->getAssetUrl(ExportAsset::class, 'export/stub.css'),
+            $this->manager->getUrl(ExportAsset::class, 'export/stub.css'),
         );
         $this->assertSame(
             $this->aliases->get("@assetUrl/{$hash}/export/stub.js"),
-            $this->manager->getAssetUrl(ExportAsset::class, 'export/stub.js'),
+            $this->manager->getUrl(ExportAsset::class, 'export/stub.js'),
         );
+        $this->assertSame(
+            $this->aliases->get("@assetUrl/{$hash}/export/yii-logo.png"),
+            $this->manager->getUrl(ExportAsset::class, 'export/yii-logo.png'),
+        );
+
+        // Test deprecated `getAssetUrl()` method
         $this->assertSame(
             $this->aliases->get("@assetUrl/{$hash}/export/yii-logo.png"),
             $this->manager->getAssetUrl(ExportAsset::class, 'export/yii-logo.png'),