Assets Upgrade, Added Relative Path

Author: tamedevelopers

Asset.php

@@ -18,10 +18,11 @@ class Asset{
      * - asset file e.g (style.css | js/main.js)
      * 
      * @param bool|null $cache
+     * @param bool|null $path_type
      * 
      * @return string
      */
-    static public function asset(?string $asset = null, $cache = null)
+    static public function asset(?string $asset = null, $cache = null, $path_type = null)
     {
         // if coniguration has not been used in the global space
         // then we call to define paths for us
@@ -38,6 +39,12 @@ static public function asset(?string $asset = null, $cache = null)
             $cache = $assetPath['cache'];
         }
 
+        // if asset method path_type is not null
+        // then we override the global configuration
+        if(!is_bool($path_type)){
+            $path_type = $assetPath['path_type'];
+        }
+
         // trim
         $asset = Str::trim($asset, '/');
 
@@ -55,7 +62,18 @@ static public function asset(?string $asset = null, $cache = null)
                 $cacheTimeAppend = self::getFiletime($file_server) ?? null;
             }
         }
-        
+
+        // if `$path_type` is true, then we'll use relative path
+        if($path_type){
+
+            // replace domain path
+            $domain = Str::replace($assetPath['removeDomain'], '', $file_domain);
+            $domain = ltrim($domain, '/');
+
+            return "/{$domain}{$cacheTimeAppend}";
+        }
+
+        // Using absolute path
         return "{$file_domain}{$cacheTimeAppend}";
     }
 
@@ -72,9 +90,12 @@ static public function asset(?string $asset = null, $cache = null)
      * - This will automatically tells the broswer to fetch new file if the time change
      * - Time will only change if you make changes or modify the request file
      * 
+     * @param string $path_type
+     * -[optional] Default is false (Absolute Path)|Else -- False is (Relative path)
+     * 
      * @return void
      */
-    static public function config(?string $base_path = null, ?bool $cache = false) 
+    static public function config(?string $base_path = null, ?bool $cache = false, $path_type = false) 
     {
         // if not defined
         if(!defined('ASSET_BASE_DIRECTORY')){
@@ -101,11 +122,13 @@ static public function config(?string $base_path = null, ?bool $cache = false)
 
             define('ASSET_BASE_DIRECTORY', [
                 'cache'     => $cache,
+                'path_type' => $path_type,
                 'server'    => self::formatWithBaseDirectory($base_path),
                 'domain'    => rtrim(
                     self::cleanServerPath($urlFromhelper), 
                     '/'
                 ),
+                'removeDomain' => UrlHelper::http() . UrlHelper::host()
             ]);
         }
     }

README.md

@@ -505,9 +505,13 @@ tasset('css/style.css');
 ```
 
 ## Asset Config
-- Takes two param as `string` 
-    - `base_path` path base directory
-    - `cache` Tells method to return `cache` of assets.
+- Takes three param as `string` 
+
+| params        | Description                 |
+|---------------|-----------------------------|
+| base_path     | PAth to file                  |
+| cache         | By Default `cache` is set to `false`. Tell method to include cache for each file  |
+| path_type     | By Default `cache` is set to `false`, which uses absolute path for all files. While `true` will use relative path |
         
 
 ```
@@ -525,7 +529,7 @@ config_asset('public');
 ```
 
 ### Asset Cache
-- By Default, `cache` is set to `true`
+- By Default, `cache` is set to `false`
     - You'll see a link representation as `http://domain.com/[path_to_asset_file]?v=111111111`
 
 ```
@@ -537,9 +541,12 @@ http://domain.com/storage/[asset_file]
 
 - or -- `Helpers Function`
 ```
-asset_config('storage', true);
+asset_config('storage/main.js', true);
+// Output: http://domain.com/storage/main.js?v=111111111
+
 
-http://domain.com/storage/[asset_file]?v=111111111
+asset_config('storage/style.css', true, true);
+// Output: /storage/style.css?v=111111111
 ```
 
 ## ENV

Tests/url.php

@@ -11,13 +11,14 @@
 config_asset('/', true);
 
 
-dd(
+dump(
     domain(), 
     domain('admin'),
     tasset('zip.php'),
+    tasset('zip.php', true, true),
 
     urlHelper()->server(),
-    
+
     [
         urlHelper()->url(),
         urlHelper()->full(),
@@ -26,8 +27,19 @@
         urlHelper()->http(),
         urlHelper()->host(),
         urlHelper()->path(),
-        urlHelper()->path(),
     ]
 
 );
 
+$unitImg    = tasset('thousand_units.png');
+$unitImg2   = tasset('thousand_units.png', true, true);
+
+?>
+
+<a href="<?= $unitImg?>" target="_blank">
+  <img src="<?= $unitImg?>" alt="units" width="300">  
+</a>
+
+<a href="<?= $unitImg2?>" target="_blank">
+  <img src="<?= $unitImg2?>" alt="units" width="300">  
+</a>

helpers.php

@@ -294,11 +294,14 @@ function tview($viewPath, $data = [])
      * 
      * @param bool|null $cache
      * 
+     * @param bool|null $path_type
+     * -[optional] Default is false (Absolute Path)|Else -- False is (Relative path)
+     * 
      * @return string
      */
-    function tasset($asset = null, $cache = null)
+    function tasset($asset = null, $cache = null, $path_type = null)
     {
-        return Asset::asset($asset, $cache);
+        return Asset::asset($asset, $cache, $path_type);
     }
 }
 
@@ -310,17 +313,20 @@ function tasset($asset = null, $cache = null)
      * - [optional] Default is `base_directory/assets`
      * - If set and directory is not found, then we revert back to the default
      * 
-     * @param string $cache
+     * @param bool $cache
      * - [optional] Default is false
      * - End point of link `?v=xxxxxxxx` is with cache of file time change
      * - This will automatically tells the broswer to fetch new file if the time change
      * - Time will only change if you make changes or modify the request file
      * 
+     * @param bool $path_type
+     * -[optional] Default is false (Absolute Path)|Else -- False is (Relative path)
+     * 
      * @return void
      */
-    function config_asset($base_path = null, ?bool $cache = false)
+    function config_asset($base_path = null, ?bool $cache = false, ?bool $path_type = false)
     {
-        Asset::config($base_path, $cache);
+        Asset::config($base_path, $cache, $path_type);
     }
 }