基于数据模型的表格

Encore\Admin\Grid类用于生成基于数据模型的表格，先来个例子，数据库中有movies表

  1. CREATE TABLE `movies` (
  2.   `id` int(10) unsigned NOT NULL AUTO_INCREMENT,
  3.   `title` varchar(255) COLLATE utf8_unicode_ci NOT NULL,
  4.   `director` int(10) unsigned NOT NULL,
  5.   `describe` varchar(255) COLLATE utf8_unicode_ci NOT NULL,
  6.   `rate` tinyint unsigned NOT NULL,
  7.   `released` enum(0, 1),
  8.   `release_at` timestamp NOT NULL DEFAULT '0000-00-00 00:00:00',
  9.   `created_at` timestamp NOT NULL DEFAULT '0000-00-00 00:00:00',
  10.   `updated_at` timestamp NOT NULL DEFAULT '0000-00-00 00:00:00',
  11.   PRIMARY KEY (`id`)
  12. ) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE=utf8_unicode_ci;

对应的数据模型为App\Models\Movie，下面的代码可以生成表movies的数据表格：

  2. use App\Models\Movie;
  3. use Encore\Admin\Grid;
  4. use Encore\Admin\Facades\Admin;
  6. $grid = Admin::grid(Movie::class, function(Grid $grid){
  8.     // 第一列显示id字段，并将这一列设置为可排序列
  9.     $grid->id('ID')->sortable();
  11.     // 第二列显示title字段，由于title字段名和Grid对象的title方法冲突，所以用Grid的column()方法代替
  12.     $grid->column('title');
  14.     // 第三列显示director字段，通过display($callback)方法设置这一列的显示内容为users表中对应的用户名
  15.     $grid->director()->display(function($userId) {
  16.         return User::find($userId)->name;
  17.     });
  19.     // 第四列显示为describe字段
  20.     $grid->describe();
  22.     // 第五列显示为rate字段
  23.     $grid->rate();
  25.     // 第六列显示released字段，通过display($callback)方法来格式化显示输出
  26.     $grid->released('上映?')->display(function ($released) {
  27.         return $released ? '是' : '否';
  28.     });
  30.     // 下面为三个时间字段的列显示
  31.     $grid->release_at();
  32.     $grid->created_at();
  33.     $grid->updated_at();
  35.     // filter($callback)方法用来设置表格的简单搜索框
  36.     $grid->filter(function ($filter) {
  38.         // 设置created_at字段的范围查询
  39.         $filter->between('created_at', 'Created Time')->datetime();
  40.     });
  41. });

基本使用方法

添加列

  2. // 直接通过字段名`username`添加列
  3. $grid->username('用户名');
  5. // 效果和上面一样
  6. $grid->column('username', '用户名');
  8. // 添加多列
  9. $grid->columns('email', 'username' ...);

修改来源数据

  1. $grid->model()->where('id', '>', 100);
  3. $grid->model()->orderBy('id', 'desc');
  5. $grid->model()->take(100);

设置每页显示行数

  1. // 默认为每页20条
  2. $grid->paginate(15);

修改显示输出

  1. $grid->text()->display(function($text) {
  2.     return str_limit($text, 30, '...');
  3. });
  5. $grid->name()->display(function ($name) {
  6.     return "<span class='label'>$name</span>";
  7. });
  9. $grid->email()->display(function ($email) {
  10.     return "mailto:$email";
  11. });
  13. // 添加不存在的字段
  14. $grid->column('column_not_in_table')->display(function () {
  15.     return 'blablabla....';
  16. });

display()方法接收的匿名函数绑定了当前行的数据对象，可以在里面调用当前行的其它字段数据

  1. $grid->first_name();
  2. $grid->last_name();
  4. // 不存的字段列
  5. $grid->column('full_name')->display(function () {
  6.     return $this->first_name.' '.$this->last_name;
  7. });

禁用创建按钮

  1. $grid->disableCreateButton();

禁用分页条

  1. $grid->disablePagination();

禁用查询过滤器

  1. $grid->disableFilter();

禁用导出数据按钮

  1. $grid->disableExport();

禁用行选择checkbox

  1. $grid->disableRowSelector();

禁用行操作列

  1. $grid->disableActions();

设置分页选择器选项

  1. $grid->perPages([10, 20, 30, 40, 50]);

添加查询过滤器

  1. $grid->filter(function($filter){
  3.     // 如果过滤器太多，可以使用弹出模态框来显示过滤器.
  4.     $filter->useModal();
  6.     // 禁用id查询框
  7.     $filter->disableIdFilter();
  9.     // sql: ... WHERE `user.name` LIKE "%$name%";
  10.     $filter->like('name', 'name');
  12.     // sql: ... WHERE `user.email` = $email;
  13.     $filter->is('emial', 'Email');
  15.     // sql: ... WHERE `user.created_at` BETWEEN $start AND $end;
  16.     $filter->between('created_at', 'Created Time')->datetime();
  18.     // sql: ... WHERE `author_id` = $id;
  19.     $filter->is('author_id', 'Author')->select(User::all()->pluck('name', 'id'));
  21.     // sql: ... WHERE `title` LIKE "%$input" OR `content` LIKE "%$input";
  22.     $filter->where(function ($query) {
  24.         $query->where('title', 'like', "%{$this->input}%")
  25.             ->orWhere('content', 'like', "%{$this->input}%");
  27.     }, 'Text');
  29.     // sql: ... WHERE `rate` >= 6 AND `created_at` = {$input};
  30.     $filter->where(function ($query) {
  32.         $query->whereRaw("`rate` >= 6 AND `created_at` = {$this->input}");
  34.     }, 'Text');
  36.     // 关系查询，查询对应关系`profile`的字段
  37.     $filter->where(function ($query) {
  39.         $input = $this->input;
  41.         $query->whereHas('profile', function ($query) use ($input) {
  42.             $query->where('address', 'like', "%{$input}%")->orWhere('email', 'like', "%{$input}%");
  43.         });
  45.     }, '地址或手机号');
  47. });

关联模型

一对一

users表和profiles表通过profiles.user_id字段生成一对一关联

  2. CREATE TABLE `users` (
  3. `id` int(10) unsigned NOT NULL AUTO_INCREMENT,
  4. `name` varchar(255) COLLATE utf8_unicode_ci NOT NULL,
  5. `email` varchar(255) COLLATE utf8_unicode_ci NOT NULL,
  6. `created_at` timestamp NOT NULL DEFAULT '0000-00-00 00:00:00',
  7. `updated_at` timestamp NOT NULL DEFAULT '0000-00-00 00:00:00',
  8. PRIMARY KEY (`id`)
  9. ) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE=utf8_unicode_ci;
  11. CREATE TABLE `profiles` (
  12. `id` int(10) unsigned NOT NULL AUTO_INCREMENT,
  13. `user_id` varchar(255) COLLATE utf8_unicode_ci NOT NULL,
  14. `age` varchar(255) COLLATE utf8_unicode_ci NOT NULL,
  15. `gender` varchar(255) COLLATE utf8_unicode_ci NOT NULL,
  16. `created_at` timestamp NOT NULL DEFAULT '0000-00-00 00:00:00',
  17. `updated_at` timestamp NOT NULL DEFAULT '0000-00-00 00:00:00',
  18. PRIMARY KEY (`id`)
  19. ) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE=utf8_unicode_ci;

对应的数据模分别为:

  2. class User extends Model
  3. {
  4.     public function profile()
  5.     {
  6.         $this->hasOne(Profile::class);
  7.     }
  8. }
  10. class Profile extends Model
  11. {
  12.     public function user()
  13.     {
  14.         $this->belongsTo(User::class);
  15.     }
  16. }

通过下面的代码可以关联在一个grid里面:

  1. Admin::grid(User::class, function (Grid $grid) {
  3.     $grid->id('ID')->sortable();
  5.     $grid->name();
  6.     $grid->email();
  8.     $grid->column('profile.age');
  9.     $grid->column('profile.gender');
  11.     //or
  12.     $grid->profile()->age();
  13.     $grid->profile()->gender();
  15.     $grid->created_at();
  16.     $grid->updated_at();
  17. });

一对多

posts表和comments表通过comments.post_id字段生成一对多关联

  2. CREATE TABLE `posts` (
  3. `id` int(10) unsigned NOT NULL AUTO_INCREMENT,
  4. `title` varchar(255) COLLATE utf8_unicode_ci NOT NULL,
  5. `content` varchar(255) COLLATE utf8_unicode_ci NOT NULL,
  6. `created_at` timestamp NOT NULL DEFAULT '0000-00-00 00:00:00',
  7. `updated_at` timestamp NOT NULL DEFAULT '0000-00-00 00:00:00',
  8. PRIMARY KEY (`id`)
  9. ) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE=utf8_unicode_ci;
  11. CREATE TABLE `comments` (
  12. `id` int(10) unsigned NOT NULL AUTO_INCREMENT,
  13. `post_id` int(10) unsigned NOT NULL,
  14. `content` varchar(255) COLLATE utf8_unicode_ci NOT NULL,
  15. `created_at` timestamp NOT NULL DEFAULT '0000-00-00 00:00:00',
  16. `updated_at` timestamp NOT NULL DEFAULT '0000-00-00 00:00:00',
  17. PRIMARY KEY (`id`)
  18. ) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE=utf8_unicode_ci;

对应的数据模分别为:

  2. class Post extends Model
  3. {
  4.     public function comments()
  5.     {
  6.         return $this->hasMany(Comment::class);
  7.     }
  8. }
  10. class Comment extends Model
  11. {
  12.     public function post()
  13.     {
  14.         return $this->belongsTo(Post::class);
  15.     }
  16. }

通过下面的代码可以让两个模型在grid里面互相关联:

  2. return Admin::grid(Post::class, function (Grid $grid) {
  3.     $grid->id('id')->sortable();
  4.     $grid->title();
  5.     $grid->content();
  7.     $grid->comments('评论数')->display(function ($comments) {
  8.         $count = count($comments);
  9.         return "<span class='label label-warning'>{$count}</span>";
  10.     });
  12.     $grid->created_at();
  13.     $grid->updated_at();
  14. });
  17. return Admin::grid(Comment::class, function (Grid $grid) {
  18.     $grid->id('id');
  19.     $grid->post()->title();
  20.     $grid->content();
  22.     $grid->created_at()->sortable();
  23.     $grid->updated_at();
  24. });

多对多

users和roles表通过中间表role_users产生多对多关系

  2. CREATE TABLE `users` (
  3.   `id` int(10) unsigned NOT NULL AUTO_INCREMENT,
  4.   `username` varchar(190) COLLATE utf8_unicode_ci NOT NULL,
  5.   `password` varchar(60) COLLATE utf8_unicode_ci NOT NULL,
  6.   `name` varchar(255) COLLATE utf8_unicode_ci NOT NULL,
  7.   `created_at` timestamp NULL DEFAULT NULL,
  8.   `updated_at` timestamp NULL DEFAULT NULL,
  9.   PRIMARY KEY (`id`),
  10.   UNIQUE KEY `users_username_unique` (`username`)
  11. ) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE=utf8_unicode_ci
  13. CREATE TABLE `roles` (
  14.   `id` int(10) unsigned NOT NULL AUTO_INCREMENT,
  15.   `name` varchar(50) COLLATE utf8_unicode_ci NOT NULL,
  16.   `slug` varchar(50) COLLATE utf8_unicode_ci NOT NULL,
  17.   `created_at` timestamp NULL DEFAULT NULL,
  18.   `updated_at` timestamp NULL DEFAULT NULL,
  19.   PRIMARY KEY (`id`),
  20.   UNIQUE KEY `roles_name_unique` (`name`)
  21. ) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE=utf8_unicode_ci
  23. CREATE TABLE `role_users` (
  24.   `role_id` int(11) NOT NULL,
  25.   `user_id` int(11) NOT NULL,
  26.   `created_at` timestamp NULL DEFAULT NULL,
  27.   `updated_at` timestamp NULL DEFAULT NULL,
  28.   KEY `role_users_role_id_user_id_index` (`role_id`,`user_id`)
  29. ) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE=utf8_unicode_ci

对应的数据模分别为:

  2. class User extends Model
  3. {
  4.     public function roles()
  5.     {
  6.         return $this->belongsToMany(Role::class);
  7.     }
  8. }
  10. class Role extends Model
  11. {
  12.     public function users()
  13.     {
  14.         return $this->belongsToMany(User::class);
  15.     }
  16. }

通过下面的代码可以让两个模型在grid里面互相关联:

  1. return Admin::grid(User::class, function (Grid $grid) {
  2.     $grid->id('ID')->sortable();
  3.     $grid->username();
  4.     $grid->name();
  6.     $grid->roles()->display(function ($roles) {
  8.         $roles = array_map(function ($role) {
  9.             return "<span class='label label-success'>{$role['name']}</span>";
  10.         }, $roles);
  12.         return join('&nbsp;', $roles);
  13.     });
  15.     $grid->created_at();
  16.     $grid->updated_at();
  17. });