README

一个用于轻松从Eloquent模型生成CSV文件的Laravel包。

基本用法

$users = User::get(); // All users
$csvExporter = new \Laracsv\Export();
$csvExporter->build($users, ['email', 'name'])->download();

下载包含email和name字段的合适的CSV文件。

安装

只需在您的终端运行此命令

composer require "usmanhalalit/laracsv:1.*@dev"

然后您应该可以开始了。

完整文档

• 构建CSV
• 输出选项
  • 下载
• 自定义标题
• 修改或添加值
  • 添加字段和值
• 模型关系

构建CSV

$exporter->build($modelCollection, $fields)接受两个参数。第一个参数是模型（模型集合），第二个参数接受您要导出的字段名称。

$csvExporter->build(User::get(), ['email', 'name', 'created_at']);

输出选项

下载

要将文件下载到浏览器

$csvExporter->download();

您可以选择提供一个文件名

$csvExporter->download('active_users.csv');

您还可以抑制第一行（标题）

$csvExporter->build(User::get(), ['email', 'name', 'created_at'], false);

如果没有提供文件名，将生成带有日期时间的文件名。

高级输出

LaraCSV使用League CSV。您可以执行League CSV能做的事情。您可以通过调用

$csv = $csvExporter->getCsv();

来获取底层的League CSV实例

$csv->toHTML(); // To output the CSV as an HTML table 
$csv->jsonSerialize()(); // To turn the CSV in to an array 
$csv = (string) $csv; // To get the CSV as string
echo $csv; // To print the CSV

然后您可以执行以下操作

自定义标题

上面的代码示例将生成一个包含标题email、name、created_at以及后续对应行的CSV文件。

如果您想使用自定义标签更改标题，只需将其作为数组值传递

$csvExporter->build(User::get(), ['email', 'name' => 'Full Name', 'created_at' => 'Joined']);

现在name列将显示标题Full Name，但它仍然从模型的name字段中获取值。

修改或添加值

存在一个在处理数据库行之前被触发的钩子。例如，如果您想更改日期格式，可以这样做。

$csvExporter = new \Laracsv\Export();
$users = User::get();

// Register the hook before building
$csvExporter->beforeEach(function ($user) {
    $user->created_at = date('f', strtotime($user->created_at)); 
});

$csvExporter->build($users, ['email', 'name' => 'Full Name', 'created_at' => 'Joined']);

注意：如果beforeEach回调返回false，则整个行将排除在CSV之外。这可以用来过滤一些行。

添加字段和值

您还可以添加不存在于数据库表中的字段并动态添加值

// The notes field doesn't exist so values for this field will be blank by default 
$csvExporter->beforeEach(function ($user) {
    // Now notes field will have this value
    $user->notes = 'Add your notes'; 
});

$csvExporter->build($users, ['email', 'notes']);

模型关系

您还可以从相关数据库表中添加字段到CSV中，前提是模型已定义了关系。

这将获取产品标题和相关分类的标题（一对一）

$csvExporter->build($products, ['title', 'category.title']);

您还可以使用钩子按需调整关系

$products = Product::with('categories')->where('order_count', '>', 10)->orderBy('order_count', 'desc')->get();
$fields = ['id', 'title','original_price' => 'Market Price', 'category_ids',];
$csvExporter = new \Laracsv\Export();
$csvExporter->beforeEach(function ($product) {
    $product->category_ids = implode(', ', $product->categories->pluck('id')->toArray());
});

路线图

• 导入CSV