列的基本使用

model-grid内置了很多对于列的操作方法,可以通过这些方法很灵活的操作列数据。

列属性

列对象的setAttributes()方法用来给当前这一列的每一行添加HTML属性, 比较有用的一个场景是给当前列增加样式

  1. $grid->column('title')->setAttributes(['style' => 'color:red;']);

基于setAttributes()方法封装了style()方法,直接添加样式,比如限制列的宽度:

  1. $grid->column('desc')->style('max-width:200px;word-break:break-all;');

固定列

Since v1.7.3

如果表格的字段比较多,挤压了列的显示,可以用过fixColumns方法来设置固定列

  1. $grid->fixColumns(3, -2);

第一个参数表示固定从头开始的前三列,第二个参数表示固定从后往前数的两列,(第二个参数可不传,默认为-1)

设置列宽

  1. $grid->column('title')->width(200);

设置列颜色

  1. $grid->column('title')->color('#ffff00');

设置表头帮助信息

  1. $grid->column('title')->help('这一列是...');

这一列的表头标题右边会出现一个问号问号icon,鼠标hover上去会弹出设置的help信息。

默认隐藏列

  1. $grid->column('created_at')->hide();

这一列默认会被隐藏,可以在右上角的列选择器开启显示

列排序

使用sortable()方法把当前列设置为可排序列

  1. $grid->column('created_at')->sortable();

这样列头部就会出现一个排序icon, 点击进行排序

帮助方法

字符串操作

如果当前里的输出数据为字符串,那么可以通过链式方法调用Illuminate\Support\Str的方法。

比如有如下一列,显示title字段的字符串值:

  1. $grid->column('title');

title列输出的字符串基础上调用Str::limit()方法

  1. $grid->column('title')->limit(30);

调用方法之后输出的还是字符串,所以可以继续调用Illuminate\Support\Str的方法:

  1. $grid->column('title')->limit(30)->ucfirst();
  2. $grid->column('title')->limit(30)->ucfirst()->substr(1, 10);

数组操作

如果当前列输出的是数组,可以直接链式调用Illuminate\Support\Collection方法。

比如tags列是从一对多关系取出来的数组数据:

  1. $grid->column('tags');
  2. array (
  3. 0 =>
  4. array (
  5. 'id' => '16',
  6. 'name' => 'php',
  7. 'created_at' => '2016-11-13 14:03:03',
  8. 'updated_at' => '2016-12-25 04:29:35',
  9. ),
  10. 1 =>
  11. array (
  12. 'id' => '17',
  13. 'name' => 'python',
  14. 'created_at' => '2016-11-13 14:03:09',
  15. 'updated_at' => '2016-12-25 04:30:27',
  16. ),
  17. )

调用Collection::pluck()方法取出数组的中的name

  1. $grid->column('tags')->pluck('name');
  2. array (
  3. 0 => 'php',
  4. 1 => 'python',
  5. ),

取出name列之后输出的还是数组,还能继续调用用Illuminate\Support\Collection的方法

  1. $grid->column('tags')->pluck('name')->map('ucwords');
  2. array (
  3. 0 => 'Php',
  4. 1 => 'Python',
  5. ),

将数组输出为字符串

  1. $grid->column('tags')->pluck('name')->map('ucwords')->implode('-');
  2. "Php-Python"

混合使用

在上面两种类型的方法调用中,只要上一步输出的是确定类型的值,便可以调用类型对应的方法,所以可以很灵活的混合使用。

比如images字段是存储多图片地址数组的JSON格式字符串类型:

  1. $grid->column('images');
  2. "['foo.jpg', 'bar.png']"
  3. // 链式方法调用来显示多图
  4. $grid->column('images')->display(function ($images) {
  5. return json_decode($images, true);
  6. })->map(function ($path) {
  7. return 'http://localhost/images/'. $path;
  8. })->image();

扩展列功能

可以通过两种方式扩展列功能,第一种是通过匿名函数的方式。

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

  1. use Encore\Admin\Grid\Column;
  2. Column::extend('color', function ($value, $color) {
  3. return "<span style='color: $color'>$value</span>";
  4. });

然后在model-grid中使用这个扩展:

  1. $grid->column('title')->color('#ccc');

如果列显示逻辑比较复杂,可以通过扩展类来实现。

扩展类app/Admin/Extensions/Popover.php:

  1. <?php
  2. namespace App\Admin\Extensions;
  3. use Encore\Admin\Admin;
  4. use Encore\Admin\Grid\Displayers\AbstractDisplayer;
  5. class Popover extends AbstractDisplayer
  6. {
  7. public function display($placement = 'left')
  8. {
  9. Admin::script("$('[data-toggle=\"popover\"]').popover()");
  10. return <<<EOT
  11. <button type="button"
  12. class="btn btn-secondary"
  13. title="popover"
  14. data-container="body"
  15. data-toggle="popover"
  16. data-placement="$placement"
  17. data-content="{$this->value}"
  18. >
  19. 弹出提示
  20. </button>
  21. EOT;
  22. }
  23. }

然后在app/Admin/bootstrap.php注册扩展类:

  1. use Encore\Admin\Grid\Column;
  2. use App\Admin\Extensions\Popover;
  3. Column::extend('popover', Popover::class);

然后就能在model-grid中使用了:

  1. $grid->desciption()->popover('right');