数据导出

系统默认使用Easy Excel作为导出工具,支持导出 csvxlsxods 等格式文件。

使用前必须先安装Easy Excel

  1. composer require dcat/easy-excel

{tip} 默认不开启导出功能。

启用导出功能

启用或禁用导出功能

  1. $grid->export();

禁用 导出所有 选项

  1. $grid->export()->disableExportAll();

禁用 导出选中行 选项

  1. $grid->export()->disableExportSelectedRow();

禁用 导出当前页 选项

  1. $grid->export()->disableExportCurrentPage();

导出文件类型

{tip} 默认导出 xlsx 格式文件。

  1. // csv
  2. $grid->export()->csv();
  3. // xlsx
  4. $grid->export()->xlsx();
  5. // ods
  6. $grid->export()->ods();

设置列标题

{tip} 如果设置了标题,那么导出的文件的列数与标题的列数相同,且列的排序也相同。

  1. // 只导出 id, name和email 三列数据
  2. $titles = ['id' => 'ID', 'name' => '名称', 'email' => '邮箱'];
  3. $grid->export($titles);
  4. // 也可以这么使用
  5. $grid->export()->titles($titles);

处理导出数据

  1. $grid->export()->rows(function (array $rows) {
  2. foreach ($rows as $index => &$row) {
  3. $row['name'] = $row['first_name'].' '.$row['last_name'];
  4. }
  5. return $rows;
  6. });

设置导出文件名

  1. $grid->export()->filename('管理员数据');

扩展导出功能

如果系统内置的导出功能不了自己的需求,可以按照下面的步骤来自定义导出功能

本示例用Laravel-Excel作为excel操作库,当然也可以使用任何其他excel库

首先安装好它:

  1. composer require maatwebsite/excel:~2.1.0
  2. php artisan vendor:publish --provider="Maatwebsite\Excel\ExcelServiceProvider"

然后新建自定义导出类,比如app/Admin/Extensions/ExcelExpoter.php:

  1. <?php
  2. namespace App\Admin\Extensions;
  3. use Dcat\Admin\Grid\Exporters\AbstractExporter;
  4. use Maatwebsite\Excel\Facades\Excel;
  5. class ExcelExpoter extends AbstractExporter
  6. {
  7. public function export()
  8. {
  9. Excel::create('Filename', function($excel) {
  10. $excel->sheet('Sheetname', function($sheet) {
  11. // 最多导出10W条数据
  12. // 必须设置maxSize,当否则选择导出所有选项时只能导出默认的20条数据。
  13. $maxSize = 10000;
  14. // 这段逻辑是从表格数据中取出需要导出的字段
  15. $rows = collect($this->buildData(1, $maxSize))->map(function ($item) {
  16. return array_only($item, ['id', 'title', 'content', 'rate', 'keywords']);
  17. });
  18. $sheet->rows($rows);
  19. });
  20. })->export('xls');
  21. }
  22. }

然后在model-grid中使用这个导出类:

  1. use App\Admin\Extensions\ExcelExpoter;
  2. $grid->export(new ExcelExpoter());

有关更多Laravel-Excel的使用方法,参考laravel-excel/docs