树状表格

树状表格支持分页和点击加载功能，特别适合用来展示数据量较大的多层级结构数据。

表结构和模型

要使用树状表格，要遵守约定的表结构：

CREATE TABLE `demo_categories` (
  `id` int(10) unsigned NOT NULL AUTO_INCREMENT,
  `parent_id` int(11) NOT NULL DEFAULT '0',
  `order` int(11) NOT NULL DEFAULT '0', // order 字段不是必须的，不设置也可以
  `title` varchar(50) COLLATE utf8_unicode_ci NOT NULL,
  `created_at` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP,
  `updated_at` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,
  PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE=utf8_unicode_ci

上面的表格结构里面有三个必要的字段parent_id、 title ,其它字段没有要求。

对应的模型为app/Models/Category.php:

<?php

namespace App\Models\Demo;

use Dcat\Admin\Traits\ModelTree;
use Illuminate\Database\Eloquent\Model;

class Category extends Model
{
    use ModelTree;

    protected $table = 'demo_categories';
}

表结构中的三个字段parent_id、 order、 title的字段名也是可以修改的：

<?php

namespace App\Models\Demo;

use Dcat\Admin\Traits\ModelTree;
use Illuminate\Database\Eloquent\Model;

class Category extends Model
{
    use ModelTree;

    protected $table = 'demo_categories';
    
    protected $titleColumn = 'name';
    
    protected $orderColumn = 'sort';
    
    protected $parentColumn = 'pid';
}

如果你的数据表不需要 order 字段排序，则在模型中添加如下代码即可

<?php

namespace App\Models\Demo;

use Dcat\Admin\Traits\ModelTree;
use Illuminate\Database\Eloquent\Model;

class Category extends Model
{
    use ModelTree;

    protected $table = 'demo_categories';
    
    // 返回空值即可禁用 order 字段
    public function getOrderColumn()
    {
        return null;
    }
}

使用

通过调用 Grid\Column::tree 方法即可开启树状表格功能，开启之后默认只查询最顶级节点的数据，子节点数据需要点击加载

<?php

namespace App\Admin\Controllers\Demo;

use App\Models\Category;
use Dcat\Admin\Grid;
use Dcat\Admin\Controllers\AdminController;

class CategoryController extends AdminController
{
    protected function grid()
    {
        return Grid::make(new Category(), function (Grid $grid) {
            $grid->id('ID')->bold()->sortable();
            $grid->title->tree(); // 开启树状表格功能 
            $grid->order;
    
            $grid->created_at;
            $grid->updated_at->sortable();
            
            $grid->filter(function (Grid\Filter $filter) {
                $filter->like('slug');
                $filter->like('name');
                $filter->like('http_path');
            });
        });
    }
}

上面的代码执行的 sql 如下（默认只查询 parent = 0 的数据）：

select count(*) as aggregate from `demo_categories` where `parent_id` = 0

select * from `demo_categories` where `parent_id` = 0 order by `order` asc, `id` asc limit 20 offset 0

Grid\Column::tree 方法参数

bool $showAll false 是否一次性展示下一层级的所有节点，默认分页展示
bool $sortable true 是否开启排序功能

// 禁用分页功能，一次性加载所有下一层级节点
$grid->title->tree(true);


// 不需要 order 字段排序，第二个参数传 false 即可
$grid->title->tree(false, false);

orderable排序

orderable 排序功能依赖 spatie/eloquent-sortable 组件，需要修改模型：

use Spatie\EloquentSortable\Sortable;

class Category extends Model implements Sortable
{
    use ModelTree;
    
    // 设置排序字段，默认order
    protected $orderColumn = 'sort';
}

下面是使用示例

class CategoryController extends AdminController
{
    protected function grid()
    {
        return Grid::make(new Category(), function (Grid $grid) {
            $grid->id('ID')->bold()->sortable();
            $grid->title->tree(); // 开启树状表格功能 
            $grid->order->orderable(); // 开启排序功能
    
            ...;
        });
    }
}

关于数据搜索

如果在树状表格中使用了搜索功能（Grid::filter、 Grid\Column::filter、 Grid::quickSearch ），为了让用户能搜索到想要的数据，则会取消只查最顶级数据的操作。

例如下面的代码开启了快捷搜索

class CategoryController extends AdminController
{
    protected function grid()
    {
        return Grid::make(new Category(), function (Grid $grid) {
            $grid->id('ID')->bold()->sortable();
            $grid->title->tree(); // 开启树状表格功能 
            $grid->order->orderable(); // 开启排序功能
    
            $grid->quickSearch(['id', 'title']);
            ...;
        });
    }
}

且用户在浏览器中使用了快捷搜索，则产生sql如下

select count(*) as aggregate from `demo_categories` where `id` like "%xxx%" or `title` like "%xxx%"

select * from `demo_categories` where `id` like "%xxx%" or `title` like "%xxx%" order by `order` asc, `id` asc limit 20 offset 0

与模型树功能的差别

模型树同样可用于展示多层级结构数据，并且支持用拖拽的方式实现数据的层级、排序等操作，但是不支持分页和点击加载功能，只能一次性加载完所有数据，因此模型树并不适合用来展示数据量较大的数据。

而树状表格支持分页和点击加载功能，适合用来展示数据量较大的多层级结构数据，但不支持用拖拽的方式实现数据的层级、排序操作。

Last modified: 30 八月 2024