mohammed-zaki/laravel-excel

此包提供了一种将Eloquent集合导出为Excel文件以及将Excel文件导入为Eloquent集合的方法。

由于主仓库似乎已消失,因此该包已被冻结。

v2.0.0 2017-08-08 10:32 UTC

This package is auto-updated.

Last update: 2024-02-17 11:24:17 UTC


README

Latest Stable Version Total Downloads License

使用Laravel的Eloquent集合和查询构建器导出和导入Excel、CSV和OpenOffice样式表(5.*和4.*)。
支持多个工作表,基于 box/spout

作者: Simone Todaro
贡献者: Clément Blanco, Cyber-Duck Ltd
Mohammed Zaki 制作

安装
导出Excel
导出具有多个工作表的Excel
导入Excel
不同格式

安装

使用composer下载包

composer require mohammed-zaki/laravel-excel

config/app.php 中注册服务提供者,将 CyberduckWithSheets\LaravelExcel\ExcelServiceProvider 添加到提供者数组中。

注意。如果您使用的是Laravel 4,请使用 CyberduckWithSheets\LaravelExcel\ExcelLegacyServiceProvider

导出Excel

生成并下载Excel文件

添加

use Exporter;

到您的控制器。

在您的控制器函数中,从Eloquent集合创建一个新的Excel文件。

$excel = Exporter::make('Excel');
$excel->load($yourCollection);
return $excel->stream($yourFileName);

导出类是流畅的,因此您也可以编写

return Exporter::make('Excel')->load($yourCollection)->stream($yourFileName);

导出类也支持查询构建器对象

$query = DB:table('table')->select('col1','col2');
$excel = Exporter::make('Excel');
$excel->loadQuery($query);
return $excel->stream($yourFileName);

导出具有多个工作表的Excel

导出类支持以下多个工作表

$excel = Exporter::make('Excel');
$excel->loadToNewSheet($yourCollection, "Sheet Name");
$query = DB:table('table')->select('col1','col2');
$excel->loadQueryToNewSheet($query, "Sheet Name");
return $excel->save($yourFileName);

如果您处理大型表格,可以设置分块大小以最小化内存使用

$query = DB:table('table')->select('col1','col2');
$excel = Exporter::make('Excel');
$excel->loadQuery($query);
$excel->setChunk(1000);
return $excel->stream($yourFileName);

生成并保存Excel文件

要将在服务器上保存Excel文件,请使用save方法。

return $excel->save($yourFileNameWithPath);

高级用法

默认情况下,集合的每个元素都成为一行,模型的每个非受保护字段都成为单元格。
不打印标题行。

要更改此行为,创建一个扩展 CyberduckWithSheets\LaravelExcel\Contract\SerialiserInterface 的类,实现方法 getHeaderRow()getData(Model $data),并使用 setSerialiser() 将此类设置在Excel对象上。

$serialiser = new CustomSerialiser();
$excel = Exporter::make('Excel');
$excel->load($collection);
$excel->setSerialiser($serialiser);
return $excel->stream($yourFileName);

getHeaderRow() 必须返回一个字符串数组,其中每个元素都是第一行的单元格。要打印标题行,只需返回一个空数组 []
getData(Model $data) 必须返回一个字符串数组,其中每个元素都是单元格。

示例

namespace App\Serialisers;

use Illuminate\Database\Eloquent\Model;
use CyberduckWithSheets\LaravelExcel\Contract\SerialiserInterface;

class ExampleSerialiser implements SerialiserInterface
{
    public function getData(Model $data)
    {
        $row = [];

        $row[] = $data->field1;
        $row[] = $data->relationship->field2;

        return $row;
    }

    public function getHeaderRow()
    {
        return [
            'Field 1',
            'Field 2 (from a relationship)'
        ];
    }
}

导入Excel

添加

use Importer;

到您的控制器。

在你的控制器函数中,导入一个Excel文件。

$excel = Importer::make('Excel');
$excel->load($filepath);
$collection = $excel->getCollection();
//dd($collection)

导入类是流式的,然后你还可以写

return Importer::make('Excel')->getCollection($filepath)->getCollection();

高级用法

默认情况下,Excel文件第一张工作表中的每一行都变成一个数组,最终结果被包裹在Collection(Illuminate\Support\Collection)中。

要导入不同的工作表,使用setSheet($sheet)

$excel = Importer::make('Excel');
$excel->load($filepath);
$excel->setSheet($sheetNumber);
$collection = $excel->getCollection();
//dd($collection)

要导入每个Eloquent模型中的行,创建一个扩展CyberduckWithSheets\LaravelExcel\Contract\ParserInterface的类并实现transform($row)方法。

示例

namespace App\Parsers;

use App\Models\YourModel;
use CyberduckWithSheets\LaravelExcel\Contract\ParserInterface;

class ExampleSerialiser implements ParserInterface
{
    public function transform($row)
    {
        $model = new YourModel();
        $model->field1 = $row[0];
        $model->field2 = $row[1];
        // We can manunipulate the data before returning the object
        $model->field3 = new \Carbon($row[2]);
        return $model;
    }
}

不同格式

该包支持ODS和CSV文件。

ODS

$exporter = Exporter::make('OpenOffice');
$importer = Importer::make('OpenOffice');

CSV

$exporter = Exporter::make('Csv');
$importer = Importer::make('Csv');