brazitech/laraveladpan

Laravel 5.7 与 AdminLTE 集成

dev-master 2018-11-01 13:36 UTC

This package is auto-updated.

Last update: 2024-09-29 05:27:58 UTC


README

Latest Version on Packagist Build Status Quality Score StyleCI Total Downloads

本包提供了一种快速设置 AdminLTE(Laravel 5.7)的方法。除了 Laravel 外,没有其他要求和依赖,因此您可以立即开始构建您的管理面板。包仅提供了一种 Blade 模板,您可以扩展它并配置高级菜单。还包含了一个替换 Artisan 命令 make:auth 的命令,该命令使用 AdminLTE 风格的视图而不是默认的 Laravel 视图。

  1. 安装
  2. 更新
  3. 使用
  4. make:adminlte Artisan 命令
    1. 使用 make:adminlte 命令外的认证视图
  5. 配置
    1. 菜单
    1. 插件
  6. 翻译
  7. 自定义视图
  8. 问题、问题和拉取请求

1. 安装

  1. 使用 Composer 需求包

    composer require brazitech/laraveladpan
    
  2. 将服务提供者添加到 config/app.php 中的 providers

    Laravel 5.5 使用包自动发现,因此不需要您手动添加 ServiceProvider

       brazitech/laraveladpan\ServiceProvider::class,
  3. 发布公共资产

    php artisan vendor:publish --provider="brazitech/laraveladpan\ServiceProvider" --tag=assets
    

2. 更新

  1. 要更新此包,首先更新 composer 包

    composer update brazitech/laraveladpan
    
  2. 然后,使用 --force 标志发布公共资产以覆盖现有文件

    php artisan vendor:publish --provider="Brazitech\LaravelAdPan\ServiceProvider" --tag=assets --force
    

3. 使用

要使用模板,创建一个 blade 文件并使用 @extends('adminlte::page') 扩展布局。此模板提供以下部分:

  • title:用于 <title> 标签
  • content_header:页面标题,位于内容上方
  • content:页面的所有内容
  • css:额外的样式表(位于 <head> 中)
  • js:额外的 JavaScript(在 </body> 之前)

所有部分都是可选的。您的 blade 模板可能看起来像以下这样。

{{-- resources/views/admin/dashboard.blade.php --}}

@extends('adminlte::page')

@section('title', 'Dashboard')

@section('content_header')
    <h1>Dashboard</h1>
@stop

@section('content')
    <p>Welcome to this beautiful admin panel.</p>
@stop

@section('css')
    <link rel="stylesheet" href="/css/admin_custom.css">
@stop

@section('js')
    <script> console.log('Hi!'); </script>
@stop

注意,在 Laravel 5.2 或更高版本中,您还可以使用 @stack 指令为 cssjavascript 提供内容。

{{-- resources/views/admin/dashboard.blade.php --}}

@push('css')

@push('js')

现在,像往常一样从控制器中返回此视图。查看 AdminLTE 了解如何为您的管理面板构建美丽的内容。

4. make:adminlte Artisan 命令

注意:仅适用于 Laravel 5.2 及更高版本

此包包含一个 make:adminlte 命令,其行为与 make:auth(在 Laravel 5.2 中引入)完全相同,但替换了认证视图为 AdminLTE 风格的视图。

php artisan make:adminlte

此命令应在新的应用程序中使用,就像 make:auth 命令一样。

4.1 使用不带 make:adminlte 命令的认证视图

如果您想手动使用包含的认证相关视图,可以创建以下文件,并在每个文件中仅添加一行:

  • resources/views/auth/login.blade.php:
@extends('adminlte::login')
  • resources/views/auth/register.blade.php
@extends('adminlte::register')
  • resources/views/auth/passwords/email.blade.php
@extends('adminlte::passwords.email')
  • resources/views/auth/passwords/reset.blade.php
@extends('adminlte::passwords.reset')

默认情况下,登录表单包含注册表单的链接。如果您不想有注册表单,请将 register_url 设置为 null,则链接将不会显示。

5. 配置

首先,发布配置文件

php artisan vendor:publish --provider="Brazitech\LaravelAdPan\ServiceProvider" --tag=config

现在,编辑 config/adminlte.php 以配置标题、皮肤、菜单、URL 等。所有配置选项都在注释中解释。然而,我想在 menu 配置上做一些说明。

5.1 菜单

您可以根据以下方式配置您的菜单

'menu' => [
    'MAIN NAVIGATION',
    [
        'text' => 'Blog',
        'url' => 'admin/blog',
    ],
    [
        'text' => 'Pages',
        'url' => 'admin/pages',
        'icon' => 'file'
    ],
    [
        'text' => 'Show my website',
        'url' => '/',
        'target' => '_blank'
    ],
    'ACCOUNT SETTINGS',
    [
        'text' => 'Profile',
        'route' => 'admin.profile',
        'icon' => 'user'
    ],
    [
        'text' => 'Change Password',
        'route' => 'admin.password',
        'icon' => 'lock'
    ],
],

使用单个字符串,您指定一个菜单标题项来分隔项目。使用数组,您指定一个菜单项。texturlroute是必需属性。icon是可选的,如果您省略它,您将得到一个开放圆圈。您可以使用的是来自Font Awesome的图标。只需指定图标的名称,它就会出现在您的菜单项之前。

如果您想有条件地显示菜单项,请使用can选项。这与Laravel的Gate功能集成。如果您需要有条件地显示标题,也需要将其包裹在数组中,使用header选项,就像其他菜单项一样。

[
    [
        'header' => 'BLOG',
        'can' => 'manage-blog'
    ],
    [
        'text' => 'Add new post',
        'url' => 'admin/blog/new',
        'can' => 'add-blog-post'
    ],
]

自定义菜单过滤器

如果您需要自定义过滤器,可以轻松地将自己的菜单过滤器添加到本包中。当您使用第三方授权包(而不是Laravel的Gate功能)时,这可能很有用。

例如,使用Laratrust

<?php

namespace MyApp;

use Brazitech\LaravelAdPan\Menu\Builder;
use Brazitech\LaravelAdPan\Menu\Filters\FilterInterface;
use Laratrust;

class MyMenuFilter implements FilterInterface
{
    public function transform($item, Builder $builder)
    {
        if (isset($item['permission']) && ! Laratrust::can($item['permission'])) {
            return false;
        }

        return $item;
    }
}

然后将它们添加到config/adminlte.php

'filters' => [
    Brazitech\LaravelAdPan\Menu\Filters\ActiveFilter::class,
    Brazitech\LaravelAdPan\Menu\Filters\HrefFilter::class,
    Brazitech\LaravelAdPan\Menu\Filters\SubmenuFilter::class,
    Brazitech\LaravelAdPan\Menu\Filters\ClassesFilter::class,
    //Brazitech\LaravelAdPan\Menu\Filters\GateFilter::class, Comment this line out
    MyApp\MyMenuFilter::class,
]

运行时菜单配置

您也可以在运行时配置菜单,例如在任意服务提供商的boot中。如果您的菜单不是静态的,例如当它依赖于您的数据库或地区,请使用此功能。您还可以结合两种方法。菜单将被简单连接,服务提供商的顺序决定了菜单中的顺序。

要运行时配置菜单,请为MenuBuilding事件注册一个处理器或回调,例如在服务提供商的boot()方法中

use Illuminate\Contracts\Events\Dispatcher;
use Brazitech\LaravelAdPan\Events\BuildingMenu;

class AppServiceProvider extends ServiceProvider
{

    public function boot(Dispatcher $events)
    {
        $events->listen(BuildingMenu::class, function (BuildingMenu $event) {
            $event->menu->add('MAIN NAVIGATION');
            $event->menu->add([
                'text' => 'Blog',
                'url' => 'admin/blog',
            ]);
        });
    }

}

配置选项与静态配置文件中的相同。

一个更实际的示例,它实际上使用了翻译和数据库

    public function boot(Dispatcher $events)
    {
        $events->listen(BuildingMenu::class, function (BuildingMenu $event) {
            $event->menu->add(trans('menu.pages'));

            $items = Page::all()->map(function (Page $page) {
                return [
                    'text' => $page['title'],
                    'url' => route('admin.pages.edit', $page)
                ];
            });

            $event->menu->add(...$items);
        });
    }

此基于事件的方法用于确保仅当实际显示管理面板时,构建菜单的代码才会运行,而不是在每个请求上运行。

活动菜单项

默认情况下,如果以下任一条件成立,则菜单项被认为是活动的

  • 当前路径与url参数匹配
  • 当前路径是url参数的子路径
  • 如果它包含一个包含活动菜单项的子菜单

要覆盖此行为,您可以指定一个包含活动URL的active参数数组,支持星号和正则表达式。示例

[
    'text' => 'Pages'
    'url' => 'pages',
    'active' => ['pages', 'content', 'content/*']
]

5.2 插件

默认支持DataTables插件。如果设置为true,将自动将必要的javascript CDN脚本标签注入到adminlte::page.blade文件中。

'plugins' => [
    'datatables' => true,
]

同时支持Select2插件。如果设置为true,将自动将必要的javascript CDN脚本标签注入到adminlte::page.blade文件中。

'plugins' => [
    'datatables' => true,
    'select2' => true,
]

同时支持ChartJS插件。如果设置为true,将自动将必要的javascript CDN脚本标签注入到adminlte::page.blade文件中。

'plugins' => [
    'datatables' => true,
    'chartjs' => true,
]

6. 翻译

目前,默认提供英语、德语、法语、荷兰语、葡萄牙语和西班牙语的翻译。只需在config/app.php中指定语言。如果您需要修改文本或添加其他语言,可以发布语言文件

php artisan vendor:publish --provider="Brazitech\LaravelAdPan\ServiceProvider" --tag=translations

现在,您可以在resources/lang/vendor/adminlte中编辑翻译或添加语言。

7. 定制视图

如果您需要完全控制提供的视图,您可以发布它们

php artisan vendor:publish --provider="Brazitech\LaravelAdPan\ServiceProvider" --tag=views

现在,您可以在resources/views/vendor/adminlte中编辑视图。

8. 问题、问题和拉取请求

您可以在问题区报告问题和提问。请以ISSUE: 开头报告问题,以QUESTION: 开头提问。

如果您有问题,请先查看已关闭的问题。随着时间的推移,我已经回答了相当多的问题。

要提交拉取请求,请先分叉此仓库,创建一个新的分支,并将您的新/更新后的代码提交到该分支中。然后从您的新的分支打开拉取请求。有关更多信息,请参阅本指南