assets alias

update

src/Layout/Assets.php

@@ -5,26 +5,82 @@ namespace Dcat\Admin\Layout;
 class Assets
 {
     /**
+     * 别名.
+     *
+     * @var array
+     */
+    protected $alias = [
+        'nunito' => [
+            'css' => ['https://fonts.googleapis.com/css?family=Nunito:200,200i,300,300i,400,400i,600,600i,800,800i,900,900i'],
+        ],
+        'montserrat' => [
+            'css' => ['https://fonts.googleapis.com/css?family=Montserrat:300,400,500,600'],
+        ],
+
+        'custom' => [
+            'css' => 'dcat-admin/css/custom-laravel.css',
+        ],
+
+        'jquery.nestable' => [
+            'js'  => 'dcat-admin/dcat/plugins/nestable/jquery.nestable.min.js',
+            'css' => 'dcat-admin/dcat/plugins/nestable/nestable.css',
+        ],
+        'select2' => [
+            'js'  => 'dcat-admin/vendors/js/forms/select/select2.full.min.js',
+            'css' => 'dcat-admin/vendors/css/forms/select/select2.min.css',
+        ],
+        'bootstrap-datetimepicker' => [
+            'js'  => 'dcat-admin/dcat/plugins/bootstrap-datetimepicker/bootstrap-datetimepicker.min.js',
+            'css' => 'dcat-admin/dcat/plugins/bootstrap-datetimepicker/bootstrap-datetimepicker.min.css',
+        ],
+        'rwd-table' => [
+            'js'  => 'dcat-admin/dcat/plugins/RWD-Table-Patterns/dist/js/rwd-table.min.js',
+            'css' => 'dcat-admin/dcat/plugins/RWD-Table-Patterns/dist/css/rwd-table.min.css',
+        ],
+        'jstree' => [
+            'js'  => 'dcat-admin/dcat/plugins/jstree-theme/jstree.min.js',
+            'css' => 'dcat-admin/dcat/plugins/jstree-theme/themes/proton/style.min.css',
+        ],
+        'switchery' => [
+            'js'  => 'dcat-admin/dcat/plugins/switchery/switchery.min.js',
+            'css' => 'dcat-admin/dcat/plugins/switchery/switchery.min.css',
+        ],
+        'grid-extension' => [
+            'js' => 'dcat-admin/dcat/extra/grid-extend.js',
+        ],
+    ];
+
+    /**
+     * js代码.
+     *
      * @var array
      */
     protected $script = [];
 
     /**
+     * css代码.
+     *
      * @var array
      */
     protected $style = [];
 
     /**
+     * css脚本路径.
+     *
      * @var array
      */
     protected $css = [];
 
     /**
+     * js脚本路径.
+     *
      * @var array
      */
     protected $js = [];
 
     /**
+     * 在head标签内加载的js脚本.
+     *
      * @var array
      */
     protected $headerJs = [
@@ -33,6 +89,8 @@ class Assets
     ];
 
     /**
+     * 基础css.
+     *
      * @var array
      */
     protected $baseCss = [
@@ -52,6 +110,8 @@ class Assets
     ];
 
     /**
+     * 基础js.
+     *
      * @var array
      */
     protected $baseJs = [
@@ -62,42 +122,12 @@ class Assets
         'layer'  => 'dcat-admin/dcat/plugins/layer/layer.js',
     ];
 
-    /**
-     * @var array
-     */
-    public $components = [
-        'jquery.nestable' => [
-            'js'  => 'dcat-admin/dcat/plugins/nestable/jquery.nestable.min.js',
-            'css' => 'dcat-admin/dcat/plugins/nestable/nestable.css',
-        ],
-        'select2' => [
-            'js'  => 'dcat-admin/vendors/js/forms/select/select2.full.min.js',
-            'css' => 'dcat-admin/vendors/css/forms/select/select2.min.css',
-        ],
-        'bootstrap-datetimepicker' => [
-            'js'  => 'dcat-admin/dcat/plugins/bootstrap-datetimepicker/bootstrap-datetimepicker.min.js',
-            'css' => 'dcat-admin/dcat/plugins/bootstrap-datetimepicker/bootstrap-datetimepicker.min.css',
-        ],
-        'rwd-table' => [
-            'js'  => 'dcat-admin/dcat/plugins/RWD-Table-Patterns/dist/js/rwd-table.min.js',
-            'css' => 'dcat-admin/dcat/plugins/RWD-Table-Patterns/dist/css/rwd-table.min.css',
-        ],
-        'jstree' => [
-            'js'  => 'dcat-admin/dcat/plugins/jstree-theme/jstree.min.js',
-            'css' => 'dcat-admin/dcat/plugins/jstree-theme/themes/proton/style.min.css',
-        ],
-        'switchery' => [
-            'js'  => 'dcat-admin/dcat/plugins/switchery/switchery.min.js',
-            'css' => 'dcat-admin/dcat/plugins/switchery/switchery.min.css',
-        ],
-    ];
-
     /**
      * @var array
      */
     public $fonts = [
-        'https://fonts.googleapis.com/css?family=Nunito:200,200i,300,300i,400,400i,600,600i,800,800i,900,900i',
-        'https://fonts.googleapis.com/css?family=Montserrat:300,400,500,600',
+        'nunito',
+        'montserrat',
     ];
 
     /**
@@ -114,7 +144,7 @@ class Assets
      * @var array
      */
     protected $themeCssMap = [
-        'dark' => 'dark-layout',
+        'dark'      => 'dark-layout',
         'semi-dark' => 'semi-dark-layout',
     ];
 
@@ -126,6 +156,40 @@ class Assets
         $this->isPjax = request()->pjax();
     }
 
+    /**
+     * 设置或获取别名.
+     *
+     * @param string|array $name
+     * @param string|array $js
+     * @param string|array $css
+     *
+     * @return void|array
+     */
+    public function alias($name, $js = null, $css = null)
+    {
+        if (is_array($name)) {
+            $this->alias = array_merge($this->alias, $name);
+
+            return;
+        }
+
+        if ($js === null && $css === null) {
+            return $this->alias[$name] ?? [];
+        }
+
+        $this->alias[$name] = [
+            'js'  => $js,
+            'css' => $css,
+        ];
+    }
+
+    /**
+     * 使用全页面(无菜单和导航栏).
+     *
+     * @param bool $value
+     *
+     * @return $this
+     */
     public function full(bool $value = true)
     {
         $this->usingFullPage = $value;
@@ -133,43 +197,102 @@ class Assets
         return $this;
     }
 
-    public function collect(string $name, string $type = '')
+    /**
+     * 根据别名设置需要载入的js和css脚本.
+     *
+     * @param string $alias
+     * @param string $type
+     */
+    public function collect(string $alias, string $type = '')
     {
         if ($type === 'js') {
-            $this->js($this->components[$name]['js'] ?? null);
+            $this->js($this->alias[$alias]['js'] ?? null);
 
             return;
         } elseif ($type === 'css') {
-            $this->css($this->components[$name]['css'] ?? null);
+            $this->css($this->alias[$alias]['css'] ?? null);
 
             return;
         }
 
-        $this->js($this->components[$name]['js'] ?? null);
-        $this->css($this->components[$name]['css'] ?? null);
+        $this->js($this->alias[$alias]['js'] ?? null);
+        $this->css($this->alias[$alias]['css'] ?? null);
     }
 
+    /**
+     * 设置需要载入的css脚本.
+     *
+     * @param string|array $css
+     */
     public function css($css)
     {
         if (! $css) {
             return;
         }
-        $this->css = array_merge($this->css, (array) $css);
+        $this->css = array_merge(
+            $this->css,
+            (array) $css
+        );
     }
 
+    /**
+     * 设置需要载入的基础css脚本.
+     *
+     * @param array $css
+     */
     public function baseCss(array $css)
     {
         $this->baseCss = $css;
     }
 
+    /**
+     * 设置需要载入的js脚本.
+     *
+     * @param string|array $js
+     */
     public function js($js)
     {
         if (! $js) {
             return;
         }
-        $this->js = array_merge($this->js, (array) $js);
+        $this->js = array_merge(
+            $this->js,
+            (array) $js
+        );
     }
 
+    /**
+     * 获取脚本的真实路径
+     *
+     * @param string $path
+     * @param string $type
+     *
+     * @return string|array|null
+     */
+    public function getRealPath($path, string $type = 'js')
+    {
+        if (empty($this->alias[$path])) {
+            return admin_asset($path);
+        }
+
+        $paths = isset($this->alias[$path][$type]) ? (array) $this->alias[$path][$type] : null;
+
+        if (! $paths) {
+            return $paths;
+        }
+
+        foreach ($paths as &$value) {
+            $value = admin_asset($value);
+        }
+
+        return $paths;
+    }
+
+    /**
+     * 设置在head标签内加载的js.
+     *
+     * @param string|array $js
+     */
     public function headerJs($js)
     {
         if (! $js) {
@@ -178,11 +301,21 @@ class Assets
         $this->headerJs = array_merge($this->headerJs, (array) $js);
     }
 
+    /**
+     * 设置基础js脚本.
+     *
+     * @param array $js
+     */
     public function baseJs(array $js)
     {
         $this->baseJs = $js;
     }
 
+    /**
+     * 设置js代码.
+     *
+     * @param string|array $script
+     */
     public function script($script)
     {
         if (! $script) {
@@ -191,6 +324,11 @@ class Assets
         $this->script = array_merge($this->script, (array) $script);
     }
 
+    /**
+     * 设置css代码.
+     *
+     * @param string $style
+     */
     public function style($style)
     {
         if (! $style) {
@@ -199,6 +337,9 @@ class Assets
         $this->style = array_merge($this->style, (array) $style);
     }
 
+    /**
+     * 增加布局css文件.
+     */
     protected function addLayoutCss()
     {
         if ($this->usingFullPage) {
@@ -212,6 +353,9 @@ class Assets
         $this->baseCss[] = 'dcat-admin/css/core/menu/menu-types/vertical-menu.css';
     }
 
+    /**
+     * 主题css文件.
+     */
     protected function addThemeCss()
     {
         if (! $theme = config('admin.layout.theme')) {
@@ -227,6 +371,9 @@ class Assets
         $this->baseCss[] = "dcat-admin/css/themes/{$css}.css";
     }
 
+    /**
+     * 字体css脚本路径.
+     */
     protected function addFontCss()
     {
         $this->fonts && (
@@ -237,6 +384,9 @@ class Assets
         );
     }
 
+    /**
+     * 合并基础css脚本.
+     */
     protected function mergeBaseCss()
     {
         if ($this->isPjax) {
@@ -250,6 +400,9 @@ class Assets
         $this->css = array_merge($this->baseCss, $this->css);
     }
 
+    /**
+     * @return string
+     */
     public function renderCss()
     {
         $this->mergeBaseCss();
@@ -257,14 +410,21 @@ class Assets
         $html = '';
 
         foreach (array_unique($this->css) as &$v) {
-            $v = admin_asset($v);
+            if (! $paths = $this->getRealPath($v, 'css')) {
+                continue;
+            }
 
-            $html .= "<link rel=\"stylesheet\" href=\"{$v}\">";
+            foreach ((array) $paths as $path) {
+                $html .= "<link rel=\"stylesheet\" href=\"{$path}\">";
+            }
         }
 
         return $html;
     }
 
+    /**
+     * 合并基础js脚本.
+     */
     protected function mergeBaseJs()
     {
         if ($this->isPjax) {
@@ -278,6 +438,9 @@ class Assets
         $this->js = array_merge($this->baseJs, $this->js);
     }
 
+    /**
+     * @return string
+     */
     public function renderJs()
     {
         $this->mergeBaseJs();
@@ -285,27 +448,41 @@ class Assets
         $html = '';
 
         foreach (array_unique($this->js) as &$v) {
-            $v = admin_asset($v);
+            if (! $paths = $this->getRealPath($v, 'js')) {
+                continue;
+            }
 
-            $html .= "<script src=\"$v\"></script>";
+            foreach ((array) $paths as $path) {
+                $html .= "<script src=\"{$path}\"></script>";
+            }
         }
 
         return $html;
     }
 
+    /**
+     * @return string
+     */
     public function renderHeaderJs()
     {
         $html = '';
 
         foreach (array_unique($this->headerJs) as &$v) {
-            $v = admin_asset($v);
+            if (! $paths = $this->getRealPath($v, 'js')) {
+                continue;
+            }
 
-            $html .= "<script src=\"$v\"></script>";
+            foreach ((array) $paths as $path) {
+                $html .= "<script src=\"{$path}\"></script>";
+            }
         }
 
         return $html;
     }
 
+    /**
+     * @return string
+     */
     public function renderScript()
     {
         $script = implode(';', array_unique($this->script));
@@ -313,6 +490,9 @@ class Assets
         return "<script data-exec-on-popstate>Dcat.ready(function () { {$script} });</script>";
     }
 
+    /**
+     * @return string
+     */
     public function renderStyle()
     {
         $style = implode('', array_unique($this->style));