PHPackages                             whereof/think-csv - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Database & ORM](/categories/database)
4. /
5. whereof/think-csv

Abandoned → [tp5er/think-csv](/?search=tp5er%2Fthink-csv)Library[Database & ORM](/categories/database)

whereof/think-csv
=================

一个thinkphp包，可以轻松地从Eloquent模型生成CSV文件。

1.0.0(4y ago)11.8kMITPHPPHP >=7.2

Since Mar 30Pushed 12mo agoCompare

[ Source](https://github.com/tp5er/think-csvs)[ Packagist](https://packagist.org/packages/whereof/think-csv)[ Docs](https://github.com/whereof/think-csv)[ RSS](/packages/whereof-think-csv/feed)WikiDiscussions master Synced 1mo ago

READMEChangelogDependencies (2)Versions (2)Used By (0)

基本用法
----

[](#基本用法)

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

```

建立CSV
-----

[](#建立csv)

`$exporter->build($modelCollection, $fields)`需要三个参数。第一个是模型（模型的集合），第二个是要导出的字段名称，第三个是配置，这是可选的。

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

```

输出选项
----

[](#输出选项)

### 下载

[](#下载)

要将文件下载到浏览器:

```
$csvExporter->download();

```

如果您愿意，可以提供文件名：

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

```

如果没有给出文件名，则将生成带有日期时间的文件名。

### 高级输出

[](#高级输出)

LaraCSV 使用[League CSV](http://csv.thephpleague.com/)。您可以做 League CSV 能做的事情。您可以通过调用获取底层 League CSV writer 和 reader 实例：

```
$csvWriter = $csvExporter->getWriter();
$csvReader = $csvExporter->getReader();

```

然后你可以做几件事，比如：

```
$csvString = $csvWriter->getContent(); // To get the CSV as string
$csvReader->jsonSerialize(); // To turn the CSV in to an array

```

有关更多信息，请查看[League CSV 文档](http://csv.thephpleague.com/)。

自定义标题
-----

[](#自定义标题)

上面的代码示例将生成一个带有标题电子邮件、名称、created\_at 和后面的相应行的 CSV。

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

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

```

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

### 无标题

[](#无标题)

您还可以取消 CSV 标头：

```
$csvExporter->build(User::select(), ['email', 'name', 'created_at'], [
    'header' => false,
]);

```

修改或添加值
------

[](#修改或添加值)

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

```
$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']);

```

分块构建
----

[](#分块构建)

对于可能会消耗更多内存的较大数据集，可以使用构建器实例以块的形式处理结果。类似于行相关的钩子，在这种情况下可以使用块相关的钩子，例如急切加载或类似的基于块的操作。两个钩子之间的行为是相似的；它在每个块之前被调用，并将整个集合作为参数。**如果`false`返回，整个块被跳过，代码继续下一个。**

```
// Perform chunk related operations
$export->beforeEachChunk(function ($collection) {

});
$export->buildFromBuilder(User::newQuery(),['email', 'name']);
$export->buildFromBuilder(Db::table('user'),['email', 'name']);

```

默认块大小设置为 1000 个结果，但可以通过在`$config`传递给`buildFromBuilder`. 示例将块大小更改为 500。

```
$export->buildFromBuilder(User::newQuery(),['email', 'name'], ['chunk' => 500]);

```

###  Health Score

28

—

LowBetter than 54% of packages

Maintenance37

Infrequent updates — may be unmaintained

Popularity17

Limited adoption so far

Community6

Small or concentrated contributor base

Maturity43

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Unknown

Total

1

Last Release

1510d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/fed91d432fc3f624e5dd3d014c5afac7fcbc0e7ac8d2186f0f134c924d2ef709?d=identicon)[whereof](/maintainers/whereof)

---

Top Contributors

[![chihqiang](https://avatars.githubusercontent.com/u/40115555?v=4)](https://github.com/chihqiang "chihqiang (1 commits)")

---

Tags

exporteloquentcsvthinkphp

### Embed Badge

![Health badge](/badges/whereof-think-csv/health.svg)

```
[![Health](https://phpackages.com/badges/whereof-think-csv/health.svg)](https://phpackages.com/packages/whereof-think-csv)
```

###  Alternatives

[usmanhalalit/laracsv

A Laravel package to easily generate CSV files from Eloquent model.

6151.7M4](/packages/usmanhalalit-laracsv)[ddeboer/data-import

Import data from, and export data to, a range of file formats and media

5604.3M9](/packages/ddeboer-data-import)[portphp/portphp

Data import/export workflow

2702.9M22](/packages/portphp-portphp)[cyber-duck/laravel-excel

This package provides a way to export an Eloquent collection as an excel file and to import a Excel file as an Eloquent collection.

74225.0k](/packages/cyber-duck-laravel-excel)[betapeak/laravel-auditing-filesystem

A filesystem driver for the owen-it/laravel-auditing package. Allows storage of the audits in CSV files, across all registered Laravel disks.

166.5k](/packages/betapeak-laravel-auditing-filesystem)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)