Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rap2hpoutre/fast-excel
🦉 Fast Excel import/export for Laravel
https://github.com/rap2hpoutre/fast-excel
csv excel fast hacktoberfest laravel laravel-package memory-efficiency php xlsx
Last synced: 6 days ago
JSON representation
🦉 Fast Excel import/export for Laravel
- Host: GitHub
- URL: https://github.com/rap2hpoutre/fast-excel
- Owner: rap2hpoutre
- License: mit
- Created: 2018-04-05T07:49:06.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-08-20T20:30:23.000Z (3 months ago)
- Last Synced: 2024-10-21T06:41:23.648Z (15 days ago)
- Topics: csv, excel, fast, hacktoberfest, laravel, laravel-package, memory-efficiency, php, xlsx
- Language: PHP
- Homepage:
- Size: 219 KB
- Stars: 2,100
- Watchers: 30
- Forks: 246
- Open Issues: 83
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome-laravel - Fast Excel - Importación/exportación rápida de Excel para Laravel (Paquetes utiles)
- awesome-laravel - Fast Excel - Fast XLSX, CSV and ODT import and export for Laravel (Popular Packages)
README
[](https://packagist.org/packages/rap2hpoutre/fast-excel)
[](https://packagist.org/packages/rap2hpoutre/fast-excel)
[](https://github.styleci.io/repos/128174809?branch=master)
[](https://github.com/rap2hpoutre/fast-excel/actions/workflows/tests.yml)
[](https://packagist.org/packages/rap2hpoutre/fast-excel)
Fast Excel import/export for Laravel, thanks to [Spout](https://github.com/box/spout).
See [benchmarks](#benchmarks) below.
## Quick start
Install via composer:
```
composer require rap2hpoutre/fast-excel
```
Export a Model to `.xlsx` file:
```php
use Rap2hpoutre\FastExcel\FastExcel;
use App\User;
// Load users
$users = User::all();
// Export all users
(new FastExcel($users))->export('file.xlsx');
```
## Export
Export a Model or a **Collection**:
```php
$list = collect([
[ 'id' => 1, 'name' => 'Jane' ],
[ 'id' => 2, 'name' => 'John' ],
]);
(new FastExcel($list))->export('file.xlsx');
```
Export `xlsx`, `ods` and `csv`:
```php
$invoices = App\Invoice::orderBy('created_at', 'DESC')->get();
(new FastExcel($invoices))->export('invoices.csv');
```
Export only some attributes specifying columns names:
```php
(new FastExcel(User::all()))->export('users.csv', function ($user) {
return [
'Email' => $user->email,
'First Name' => $user->firstname,
'Last Name' => strtoupper($user->lastname),
];
});
```
Download (from a controller method):
```php
return (new FastExcel(User::all()))->download('file.xlsx');
```
## Import
`import` returns a Collection:
```php
$collection = (new FastExcel)->import('file.xlsx');
```
Import a `csv` with specific delimiter, enclosure characters and "gbk" encoding:
```php
$collection = (new FastExcel)->configureCsv(';', '#', 'gbk')->import('file.csv');
```
Import and insert to database:
```php
$users = (new FastExcel)->import('file.xlsx', function ($line) {
return User::create([
'name' => $line['Name'],
'email' => $line['Email']
]);
});
```
## Facades
You may use FastExcel with the optional Facade. Add the following line to ``config/app.php`` under the ``aliases`` key.
````php
'FastExcel' => Rap2hpoutre\FastExcel\Facades\FastExcel::class,
````
Using the Facade, you will not have access to the constructor. You may set your export data using the ``data`` method.
````php
$list = collect([
[ 'id' => 1, 'name' => 'Jane' ],
[ 'id' => 2, 'name' => 'John' ],
]);
FastExcel::data($list)->export('file.xlsx');
````
## Global helper
FastExcel provides a convenient global helper to quickly instantiate the FastExcel class anywhere in a Laravel application.
```php
$collection = fastexcel()->import('file.xlsx');
fastexcel($collection)->export('file.xlsx');
```
## Advanced usage
### Export multiple sheets
Export multiple sheets by creating a `SheetCollection`:
```php
$sheets = new SheetCollection([
User::all(),
Project::all()
]);
(new FastExcel($sheets))->export('file.xlsx');
```
Use index to specify sheet name:
```php
$sheets = new SheetCollection([
'Users' => User::all(),
'Second sheet' => Project::all()
]);
```
### Import multiple sheets
Import multiple sheets by using `importSheets`:
```php
$sheets = (new FastExcel)->importSheets('file.xlsx');
```
You can also import a specific sheet by its number:
```php
$users = (new FastExcel)->sheet(3)->import('file.xlsx');
```
Import multiple sheets with sheets names:
```php
$sheets = (new FastExcel)->withSheetsNames()->importSheets('file.xlsx');
```
### Export large collections with chunk
Export rows one by one to avoid `memory_limit` issues [using `yield`](https://www.php.net/manual/en/language.generators.syntax.php):
```php
function usersGenerator() {
foreach (User::cursor() as $user) {
yield $user;
}
}
// Export consumes only a few MB, even with 10M+ rows.
(new FastExcel(usersGenerator()))->export('test.xlsx');
```
### Add header and rows style
Add header and rows style with `headerStyle` and `rowsStyle` methods.
```php
use OpenSpout\Common\Entity\Style\Style;
$header_style = (new Style())->setFontBold();
$rows_style = (new Style())
->setFontSize(15)
->setShouldWrapText()
->setBackgroundColor("EDEDED");
return (new FastExcel($list))
->headerStyle($header_style)
->rowsStyle($rows_style)
->download('file.xlsx');
```
## Why?
FastExcel is intended at being Laravel-flavoured [Spout](https://github.com/box/spout):
a simple, but elegant wrapper around [Spout](https://github.com/box/spout) with the goal
of simplifying **imports and exports**. It could be considered as a faster (and memory friendly) alternative
to [Laravel Excel](https://laravel-excel.com/), with less features.
Use it only for simple tasks.
## Benchmarks
> Tested on a MacBook Pro 2015 2,7 GHz Intel Core i5 16 Go 1867 MHz DDR3.
Testing a XLSX export for 10000 lines, 20 columns with random data, 10 iterations, 2018-04-05. **Don't trust benchmarks.**
| | Average memory peak usage | Execution time |
|---|---|---|
| Laravel Excel | 123.56 M | 11.56 s |
| FastExcel | 2.09 M | 2.76 s |
Still, remember that [Laravel Excel](https://laravel-excel.com/) **has many more features.**