https://github.com/overlu/mini-excel
https://github.com/overlu/mini-excel
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/overlu/mini-excel
- Owner: overlu
- License: mit
- Created: 2024-05-16T07:32:33.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-05-16T11:06:59.000Z (about 2 years ago)
- Last Synced: 2025-12-14T07:52:05.023Z (7 months ago)
- Language: PHP
- Size: 12.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
> 感谢 rap2hpoutre/fast-excel 提供了优秀扩展 具体使用说明请传送至 https://github.com/rap2hpoutre/fast-excel
## Quick start
Install via composer:
```
composer require overlu/mini-excel
```
Export a Model to `.xlsx` file:
```php
use MiniExcel\Excel;
use App\Models\User;
// Load users
$users = User::all();
// Export all users
(new Excel($users))->export('file.xlsx');
```
## Export
Export a Model or a **Collection**:
```php
$list = collect([
[ 'id' => 1, 'name' => 'Jane' ],
[ 'id' => 2, 'name' => 'John' ],
]);
(new Excel($list))->export('file.xlsx');
```
Export `xlsx`, `ods` and `csv`:
```php
$invoices = App\Invoice::orderBy('created_at', 'DESC')->get();
(new Excel($invoices))->export('invoices.csv');
```
Export only some attributes specifying columns names:
```php
(new Excel(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 Excel(User::all()))->download('file.xlsx');
```
## Import
`import` returns a Collection:
```php
$collection = (new Excel)->import('file.xlsx');
```
Import a `csv` with specific delimiter, enclosure characters and "gbk" encoding:
```php
$collection = (new Excel)->configureCsv(';', '#', 'gbk')->import('file.csv');
```
Import and insert to database:
```php
$users = (new Excel)->import('file.xlsx', function ($line) {
return User::create([
'name' => $line['Name'],
'email' => $line['Email']
]);
});
```
## Facades
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' ],
]);
Excel::data($list)->export('file.xlsx');
````
## Global helper
Excel provides a convenient global helper to quickly instantiate the Excel class anywhere in a Laravel application.
```php
$collection = Excel()->import('file.xlsx');
Excel($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 Excel($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 Excel)->importSheets('file.xlsx');
```
You can also import a specific sheet by its number:
```php
$users = (new Excel)->sheet(3)->import('file.xlsx');
```
Import multiple sheets with sheets names:
```php
$sheets = (new Excel)->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 Excel(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 Excel($list))
->headerStyle($header_style)
->rowsStyle($rows_style)
->download('file.xlsx');
```
## Why?
Excel 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 |
| Excel | 2.09 M | 2.76 s |
Still, remember that [Laravel Excel](https://laravel-excel.com/) **has many more features.**