feature #10593 [Templating] Added ability to set a specific version of the asset (romainneutron)

fabpot · fabpot · commit 58bed5d200e2 · 2014-03-31T15:55:50.000+02:00
This PR was merged into the 2.5-dev branch. Discussion ---------- [Templating] Added ability to set a specific version of the asset | Q | A | ------------- | --- | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | no | Tests pass? | yes | License | MIT | Doc PR | https://github.com/symfony/symfony-docs/pull/3742/files This PR replaces #6092 Commits ------- 1642094 [Templating] Update changelog 6fce503 [Templating] Added ability to set a specific version of the asset
diff --git a/src/Symfony/Bundle/TwigBundle/Extension/AssetsExtension.php b/src/Symfony/Bundle/TwigBundle/Extension/AssetsExtension.php
@@ -48,15 +48,16 @@ public function getFunctions()
      *
      * Absolute paths (i.e. http://...) are returned unmodified.
      *
-     * @param string  $path        A public path
-     * @param string  $packageName The name of the asset package to use
-     * @param Boolean $absolute    Whether to return an absolute URL or a relative one
+     * @param string              $path        A public path
+     * @param string              $packageName The name of the asset package to use
+     * @param Boolean             $absolute    Whether to return an absolute URL or a relative one
+     * @param string|Boolean|null $version     A specific version
      *
      * @return string A public path which takes into account the base path and URL path
      */
-    public function getAssetUrl($path, $packageName = null, $absolute = false)
+    public function getAssetUrl($path, $packageName = null, $absolute = false, $version = null)
     {
-        $url = $this->container->get('templating.helper.assets')->getUrl($path, $packageName);
+        $url = $this->container->get('templating.helper.assets')->getUrl($path, $packageName, $version);
 
         if (!$absolute) {
             return $url;
diff --git a/src/Symfony/Component/Templating/Asset/Package.php b/src/Symfony/Component/Templating/Asset/Package.php
@@ -33,34 +33,42 @@ public function __construct($version = null, $format = '')
         $this->format = $format ?: '%s?%s';
     }
 
+    /**
+     * {@inheritdoc}
+     */
     public function getVersion()
     {
         return $this->version;
     }
 
-    public function getUrl($path)
+    /**
+     * {@inheritdoc}
+     */
+    public function getUrl($path, $version = null)
     {
         if (false !== strpos($path, '://') || 0 === strpos($path, '//')) {
             return $path;
         }
 
-        return $this->applyVersion($path);
+        return $this->applyVersion($path, $version);
     }
 
     /**
      * Applies version to the supplied path.
      *
-     * @param string $path A path
+     * @param string              $path    A path
+     * @param string|Boolean|null $version A specific version
      *
      * @return string The versionized path
      */
-    protected function applyVersion($path)
+    protected function applyVersion($path, $version = null)
     {
-        if (null === $this->version) {
+        $version = null !== $version ? $version : $this->version;
+        if (null === $version || false === $version) {
             return $path;
         }
 
-        $versionized = sprintf($this->format, ltrim($path, '/'), $this->version);
+        $versionized = sprintf($this->format, ltrim($path, '/'), $version);
 
         if ($path && '/' == $path[0]) {
             $versionized = '/'.$versionized;
diff --git a/src/Symfony/Component/Templating/Asset/PackageInterface.php b/src/Symfony/Component/Templating/Asset/PackageInterface.php
@@ -28,9 +28,10 @@ public function getVersion();
     /**
      * Returns an absolute or root-relative public path.
      *
-     * @param string $path A path
+     * @param string              $path    A path
+     * @prama string|Boolean|null $version A specific version for the path
      *
      * @return string The public path
      */
-    public function getUrl($path);
+    public function getUrl($path, $version = null);
 }
diff --git a/src/Symfony/Component/Templating/Asset/PathPackage.php b/src/Symfony/Component/Templating/Asset/PathPackage.php
@@ -42,13 +42,16 @@ public function __construct($basePath = null, $version = null, $format = null)
         }
     }
 
-    public function getUrl($path)
+    /**
+     * {@inheritdoc}
+     */
+    public function getUrl($path, $version = null)
     {
         if (false !== strpos($path, '://') || 0 === strpos($path, '//')) {
             return $path;
         }
 
-        $url = $this->applyVersion($path);
+        $url = $this->applyVersion($path, $version);
 
         // apply the base path
         if ('/' !== substr($url, 0, 1)) {
diff --git a/src/Symfony/Component/Templating/Asset/UrlPackage.php b/src/Symfony/Component/Templating/Asset/UrlPackage.php
@@ -41,13 +41,16 @@ public function __construct($baseUrls = array(), $version = null, $format = null
         }
     }
 
-    public function getUrl($path)
+    /**
+     * {@inheritdoc}
+     */
+    public function getUrl($path, $version = null)
     {
         if (false !== strpos($path, '://') || 0 === strpos($path, '//')) {
             return $path;
         }
 
-        $url = $this->applyVersion($path);
+        $url = $this->applyVersion($path, $version);
 
         if ($url && '/' != $url[0]) {
             $url = '/'.$url;
diff --git a/src/Symfony/Component/Templating/CHANGELOG.md b/src/Symfony/Component/Templating/CHANGELOG.md
@@ -1,6 +1,12 @@
 CHANGELOG
 =========
 
+2.5.0
+-----
+
+ * added ability to generate versioned URLs
+ * added ability to generate absolute URLs
+
 2.1.0
 -----
 
diff --git a/src/Symfony/Component/Templating/Helper/CoreAssetsHelper.php b/src/Symfony/Component/Templating/Helper/CoreAssetsHelper.php
@@ -105,14 +105,15 @@ public function getVersion($packageName = null)
      *
      * Absolute paths (i.e. http://...) are returned unmodified.
      *
-     * @param string $path        A public path
-     * @param string $packageName The name of the asset package to use
+     * @param string              $path        A public path
+     * @param string              $packageName The name of the asset package to use
+     * @param string|Boolean|null $version     A specific version
      *
      * @return string A public path which takes into account the base path and URL path
      */
-    public function getUrl($path, $packageName = null)
+    public function getUrl($path, $packageName = null, $version = null)
     {
-        return $this->getPackage($packageName)->getUrl($path);
+        return $this->getPackage($packageName)->getUrl($path, $version);
     }
 
     /**
diff --git a/src/Symfony/Component/Templating/Tests/Helper/AssetsHelperTest.php b/src/Symfony/Component/Templating/Tests/Helper/AssetsHelperTest.php
@@ -57,6 +57,14 @@ public function testGetUrl()
         $this->assertEquals('/', $helper->getUrl(''), '->getUrl() with empty arg returns the prefix alone');
     }
 
+    public function testGetUrlWithVersion()
+    {
+        $helper = new AssetsHelper(null, array(), '12');
+        $this->assertEquals('/foo.js?12', $helper->getUrl('foo.js'));
+        $this->assertEquals('/foo.js?bar', $helper->getUrl('foo.js', null, 'bar'));
+        $this->assertEquals('/foo.js', $helper->getUrl('foo.js', null, false));
+    }
+
     public function testGetUrlLeavesProtocolRelativePathsUntouched()
     {
         $helper = new AssetsHelper(null, 'http://foo.com');

Original file line number	Diff line number	Diff line change
`@@ -48,15 +48,16 @@ public function getFunctions()`
`48`	`48`	`*`
`49`	`49`	`* Absolute paths (i.e. http://...) are returned unmodified.`
`50`	`50`	`*`
`51`		`- * @param string $path A public path`
`52`		`- * @param string $packageName The name of the asset package to use`
`53`		`- * @param Boolean $absolute Whether to return an absolute URL or a relative one`
	`51`	`+ * @param string $path A public path`
	`52`	`+ * @param string $packageName The name of the asset package to use`
	`53`	`+ * @param Boolean $absolute Whether to return an absolute URL or a relative one`
	`54`	`+ * @param string\|Boolean\|null $version A specific version`
`54`	`55`	`*`
`55`	`56`	`* @return string A public path which takes into account the base path and URL path`
`56`	`57`	`*/`
`57`		`- public function getAssetUrl($path, $packageName = null, $absolute = false)`
	`58`	`+ public function getAssetUrl($path, $packageName = null, $absolute = false, $version = null)`
`58`	`59`	`{`
`59`		`- $url = $this->container->get('templating.helper.assets')->getUrl($path, $packageName);`
	`60`	`+ $url = $this->container->get('templating.helper.assets')->getUrl($path, $packageName, $version);`
`60`	`61`
`61`	`62`	`if (!$absolute) {`
`62`	`63`	`return $url;`
Original file line number	Diff line number	Diff line change
`@@ -33,34 +33,42 @@ public function __construct($version = null, $format = '')`
`33`	`33`	`$this->format = $format ?: '%s?%s';`
`34`	`34`	`}`
`35`	`35`
	`36`	`+ /**`
	`37`	`+ * {@inheritdoc}`
	`38`	`+ */`
`36`	`39`	`public function getVersion()`
`37`	`40`	`{`
`38`	`41`	`return $this->version;`
`39`	`42`	`}`
`40`	`43`
`41`		`- public function getUrl($path)`
	`44`	`+ /**`
	`45`	`+ * {@inheritdoc}`
	`46`	`+ */`
	`47`	`+ public function getUrl($path, $version = null)`
`42`	`48`	`{`
`43`	`49`	`if (false !== strpos($path, '://') \|\| 0 === strpos($path, '//')) {`
`44`	`50`	`return $path;`
`45`	`51`	`}`
`46`	`52`
`47`		`- return $this->applyVersion($path);`
	`53`	`+ return $this->applyVersion($path, $version);`
`48`	`54`	`}`
`49`	`55`
`50`	`56`	`/**`
`51`	`57`	`* Applies version to the supplied path.`
`52`	`58`	`*`
`53`		`- * @param string $path A path`
	`59`	`+ * @param string $path A path`
	`60`	`+ * @param string\|Boolean\|null $version A specific version`
`54`	`61`	`*`
`55`	`62`	`* @return string The versionized path`
`56`	`63`	`*/`
`57`		`- protected function applyVersion($path)`
	`64`	`+ protected function applyVersion($path, $version = null)`
`58`	`65`	`{`
`59`		`- if (null === $this->version) {`
	`66`	`+ $version = null !== $version ? $version : $this->version;`
	`67`	`+ if (null === $version \|\| false === $version) {`
`60`	`68`	`return $path;`
`61`	`69`	`}`
`62`	`70`
`63`		`- $versionized = sprintf($this->format, ltrim($path, '/'), $this->version);`
	`71`	`+ $versionized = sprintf($this->format, ltrim($path, '/'), $version);`
`64`	`72`
`65`	`73`	`if ($path && '/' == $path[0]) {`
`66`	`74`	`$versionized = '/'.$versionized;`
Original file line number	Diff line number	Diff line change
`@@ -28,9 +28,10 @@ public function getVersion();`
`28`	`28`	`/**`
`29`	`29`	`* Returns an absolute or root-relative public path.`
`30`	`30`	`*`
`31`		`- * @param string $path A path`
	`31`	`+ * @param string $path A path`
	`32`	`+ * @prama string\|Boolean\|null $version A specific version for the path`
`32`	`33`	`*`
`33`	`34`	`* @return string The public path`
`34`	`35`	`*/`
`35`		`- public function getUrl($path);`
	`36`	`+ public function getUrl($path, $version = null);`
`36`	`37`	`}`
Original file line number	Diff line number	Diff line change
`@@ -42,13 +42,16 @@ public function __construct($basePath = null, $version = null, $format = null)`
`42`	`42`	`}`
`43`	`43`	`}`
`44`	`44`
`45`		`- public function getUrl($path)`
	`45`	`+ /**`
	`46`	`+ * {@inheritdoc}`
	`47`	`+ */`
	`48`	`+ public function getUrl($path, $version = null)`
`46`	`49`	`{`
`47`	`50`	`if (false !== strpos($path, '://') \|\| 0 === strpos($path, '//')) {`
`48`	`51`	`return $path;`
`49`	`52`	`}`
`50`	`53`
`51`		`- $url = $this->applyVersion($path);`
	`54`	`+ $url = $this->applyVersion($path, $version);`
`52`	`55`
`53`	`56`	`// apply the base path`
`54`	`57`	`if ('/' !== substr($url, 0, 1)) {`
Original file line number	Diff line number	Diff line change
`@@ -41,13 +41,16 @@ public function __construct($baseUrls = array(), $version = null, $format = null`
`41`	`41`	`}`
`42`	`42`	`}`
`43`	`43`
`44`		`- public function getUrl($path)`
	`44`	`+ /**`
	`45`	`+ * {@inheritdoc}`
	`46`	`+ */`
	`47`	`+ public function getUrl($path, $version = null)`
`45`	`48`	`{`
`46`	`49`	`if (false !== strpos($path, '://') \|\| 0 === strpos($path, '//')) {`
`47`	`50`	`return $path;`
`48`	`51`	`}`
`49`	`52`
`50`		`- $url = $this->applyVersion($path);`
	`53`	`+ $url = $this->applyVersion($path, $version);`
`51`	`54`
`52`	`55`	`if ($url && '/' != $url[0]) {`
`53`	`56`	`$url = '/'.$url;`
Original file line number	Diff line number	Diff line change
`@@ -105,14 +105,15 @@ public function getVersion($packageName = null)`
`105`	`105`	`*`
`106`	`106`	`* Absolute paths (i.e. http://...) are returned unmodified.`
`107`	`107`	`*`
`108`		`- * @param string $path A public path`
`109`		`- * @param string $packageName The name of the asset package to use`
	`108`	`+ * @param string $path A public path`
	`109`	`+ * @param string $packageName The name of the asset package to use`
	`110`	`+ * @param string\|Boolean\|null $version A specific version`
`110`	`111`	`*`
`111`	`112`	`* @return string A public path which takes into account the base path and URL path`
`112`	`113`	`*/`
`113`		`- public function getUrl($path, $packageName = null)`
	`114`	`+ public function getUrl($path, $packageName = null, $version = null)`
`114`	`115`	`{`
`115`		`- return $this->getPackage($packageName)->getUrl($path);`
	`116`	`+ return $this->getPackage($packageName)->getUrl($path, $version);`
`116`	`117`	`}`
`117`	`118`
`118`	`119`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -57,6 +57,14 @@ public function testGetUrl()`
`57`	`57`	`$this->assertEquals('/', $helper->getUrl(''), '->getUrl() with empty arg returns the prefix alone');`
`58`	`58`	`}`
`59`	`59`
	`60`	`+ public function testGetUrlWithVersion()`
	`61`	`+ {`
	`62`	`+ $helper = new AssetsHelper(null, array(), '12');`
	`63`	`+ $this->assertEquals('/foo.js?12', $helper->getUrl('foo.js'));`
	`64`	`+ $this->assertEquals('/foo.js?bar', $helper->getUrl('foo.js', null, 'bar'));`
	`65`	`+ $this->assertEquals('/foo.js', $helper->getUrl('foo.js', null, false));`
	`66`	`+ }`
	`67`	`+`
`60`	`68`	`public function testGetUrlLeavesProtocolRelativePathsUntouched()`
`61`	`69`	`{`
`62`	`70`	`$helper = new AssetsHelper(null, 'http://foo.com');`