区块(section)

简介

Dcat Admin提供section功能允许开发者在项目运行时更改页面各个部分的内容,而不需要直接去修改模板。

{tip} Dcat Adminsection功能参考了Blade模板引擎的@section功能和Wordpressadd_filter功能,如果开发者理解这两者其中之一就能快速上手。

使用

admin_section

输出section内容,此函数类似于Blade模板中的@yield指令以及WordPress中的apply_filters函数。

参数:

返回值:

echo admin_section('navigation', null, ['count' => 4]);

admin_inject_section

注入section内容,此函数类似WordPress中的add_filter函数。

参数:

当第二个参数传入的是匿名函数时,匿名函数接收一个Illuminate\Support\Fluent对象。匿名函数中接收一个Illuminate\Support\Fluent对象,此对象包含有前面注入到此区块的内容,通过previous属性可以获得;如果此section还有其他参数,也可以通过访问属性的方式获得,如下:

admin_inject_section('navigation', e("<navigation>1</navigation>"));

admin_inject_section('navigation', function ($options) {
    // 获取上一个注入此区块的内容
    $previous = $options->previous;

    // 获取自定义参数
    $count = $options->count;

    return e("<navigation>count:{$count}</navigation>");
}, true, 11);

// 输出
echo admin_section('navigation', null, ['count' => 4]);
// 最终输出结果为
// <navigation>count:4</navigation><navigation>1</navigation>

admin_inject_default_section

注入默认内容,如果调用了admin_inject_section函数注入内容(无论是在前面还是后面都一样),则此函数不生效。

参数:

admin_inject_default_section('navigation', '暂无数据');

admin_has_section

判断是否注入过内容到section,此函数返回一个bool类型值。

var_dump(admin_has_section('navigation'));

admin_has_default_section

判断是否注入过默认内容到section,此函数返回一个bool类型值。

var_dump(admin_has_default_section('navigation'));

系统预定义区块

Dcat Admin预定义了一些区块,开发者可以通过这些区块改变页面内容。

所有的预定义区块名称都定义在AdminSection这个类中,通过类常量的方式访问。

往<head>标签内输入内容

此通过AdminSection::HEAD区块可以往<head>标签内输入内容。

app\Admin\bootstrap.php中加入以下代码:

admin_inject_section(\AdminSection::HEAD, function () {
    return '<script src="//oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>';
});

往<body>标签内输入内容

通过AdminSection::BODY_INNER_BEFORE区块可以往<body>标签内部的开头位置输入内容。

通过AdminSection::BODY_INNER_AFTER区块可以往<body>标签内部的结束位置输入内容。

往<div id="app">标签内输入内容

通过AdminSection::APP_INNER_BEFORE区块可以往<div id="app">标签内部的开头位置输入内容。

通过AdminSection::APP_INNER_AFTER区块可以往<div id="app">标签内部的结束位置输入内容。

更改顶部导航栏用户信息面板内容

通过AdminSection::NAVBAR_USER_PANEL区块可以更改顶部导航栏的用户信息面板内容。

admin_inject_section(\AdminSection::NAVBAR_USER_PANEL, view('admin::partials.navbar-user-panel'));

更改顶部导航栏用户信息面板后面内容

通过AdminSection::NAVBAR_AFTER_USER_PANEL区块可以更改顶部导航栏的用户信息面板后面的内容。

admin_inject_section(\AdminSection::NAVBAR_AFTER_USER_PANEL, function () {
    return <<<HTML
    <li>
        <a href="#" data-toggle="control-sidebar"><i class="fa fa-gears"></i></a>
    </li>
HTML;    
});

更改菜单栏用户信息面板内容

通过AdminSection::LEFT_SIDEBAR_USER_PANEL区块可以更改菜单栏的用户信息面板的内容。

 admin_inject_section(\AdminSection::LEFT_SIDEBAR_USER_PANEL, view('admin::partials.sidebar-user-panel'));

更改菜单栏

通过AdminSection::LEFT_SIDEBAR_MENU可以更改整个菜单栏内容。

{tip} Dcat Admin的菜单是通过注入默认内容到LEFT_SIDEBAR_MENU区块而构建的,开发者可以轻易替换掉系统默认的菜单渲染逻辑。

admin_inject_section(\AdminSection::LEFT_SIDEBAR_MENU, function () {
    $menuModel = config('admin.database.menu_model');

    return $this->build((new $menuModel())->allNodes());
});