Add docblocks, shorten lines

cakephp · Feb 27, 2016 · 193f35b · 193f35b
1 parent 1fc3807
commit 193f35b
Showing 1 changed file with 44 additions and 3 deletions.
diff --git a/src/View/Helper/UrlHelper.php b/src/View/Helper/UrlHelper.php
@@ -40,19 +40,60 @@ public function build($url = null, $full = false)
         return h(Router::url($url, $full));
     }
 
+    /**
+     * Generate URL for given image file. Depending on options passed provides full URL
+     * with domain name. Also calls Helper::assetTimestamp() to add timestamp to local files
+     *
+     * @param string|array $path Path string or URL array
+     * @param array $options Options array. Possible keys:
+     *   `fullBase` Return full URL with domain name
+     *   `pathPrefix` Path prefix for relative URLs
+     *   `ext` Asset extension to append
+     *   `plugin` False value will prevent parsing path as a plugin
+     * @return string Generated URL
+     */
     public function imageUrl($path, array $options = [])
     {
-        return $this->assetUrl($path, $options + ['pathPrefix' => Configure::read('App.imageBaseUrl')]);
+        $pathPrefix = Configure::read('App.imageBaseUrl');
+        return $this->assetUrl($path, $options + compact('pathPrefix'));
     }
 
+    /**
+     * Generate URL for given CSS file. Depending on options passed provides full URL
+     * with domain name. Also calls Helper::assetTimestamp() to add timestamp to local files
+     *
+     * @param string|array $path Path string or URL array
+     * @param array $options Options array. Possible keys:
+     *   `fullBase` Return full URL with domain name
+     *   `pathPrefix` Path prefix for relative URLs
+     *   `ext` Asset extension to append
+     *   `plugin` False value will prevent parsing path as a plugin
+     * @return string Generated URL
+     */
     public function cssUrl($path, array $options = [])
     {
-        return $this->assetUrl($path, $options + ['pathPrefix' => Configure::read('App.cssBaseUrl'), 'ext' => '.css']);
+        $pathPrefix = Configure::read('App.cssBaseUrl');
+        $ext = '.css';
+        return $this->assetUrl($path, $options + compact('pathPrefix', 'ext'));
     }
 
+    /**
+     * Generate URL for given javascript file. Depending on options passed provides full
+     * URL with domain name. Also calls Helper::assetTimestamp() to add timestamp to local files
+     *
+     * @param string|array $path Path string or URL array
+     * @param array $options Options array. Possible keys:
+     *   `fullBase` Return full URL with domain name
+     *   `pathPrefix` Path prefix for relative URLs
+     *   `ext` Asset extension to append
+     *   `plugin` False value will prevent parsing path as a plugin
+     * @return string Generated URL
+     */
     public function scriptUrl($path, array $options = [])
     {
-        return $this->assetUrl($url, $options + ['pathPrefix' => Configure::read('App.jsBaseUrl'), 'ext' => '.js']);
+        $pathPrefix = Configure::read('App.jsBaseUrl');
+        $ext = '.js';
+        return $this->assetUrl($path, $options + compact('pathPrefix', 'ext'));
     }
 
     /**