richpeers/laravel-csv-export

Chunk eloquent query builder and return csv via Symfony streamedResponse or save

dev-master 2020-01-12 19:25 UTC

Requires

• php: ^7.2
• laravel/framework: ~5.5.0|~5.6.0|~5.7.0|~5.8.0|^6.0.0

MIT

• Rich Peers

• csv
• stream
• export
• laravel

README

Export to csv via Symfony StreamedResponse or saved file. Pass in eloquent query builder to chunk the query.

Usage

Install with composer:

composer require richpeers/laravel-csv-export

Create a class extending ExportAbstract and implementing ExportInterface. Example below:

<?php

namespace App\Services\CsvExports;

use RichPeers\LaravelCsvExport\ExportAbstract;
use RichPeers\LaravelCsvExport\ExportInterface;

class ExampleExport extends ExportAbstract implements ExportInterface
{
    /**
     * Array of csv column headers.
     * @return array
     */
    public function headers()
    {
        return [
            'Id',
            'Author name',
            'Title',
            'Created'
        ];
    }

    /**
     * Transform row values.
     * @param $value
     * @return array
     */
    public function values($value)
    {
        return [
            $value->id
            optional($value->author)->name ?? ' ',
            $value->title ?? ' ',
            $value->created_at->toDateString()
        ];
    }
}

Controller example:

<?php

namespace App\Http\Controllers;

use App\Models\Posts;
use Illuminate\Http\Request;
use App\Http\Controllers\Controller;
use App\Services\CsvExports\ExampleExport;
use Symfony\Component\HttpFoundation\StreamedResponse;

class ExportController extends Controller
{
    /**
     * @param Request $request
     * @param ExampleExport $exportCsv
     * @return StreamedResponse
     */
    public function __invoke(Request $request, ExampleExport $exportCsv): StreamedResponse
    {
        // your eloquent query builder - best optimized
        $builder = Post::select('id', 'author_id', 'title', 'created_at')->with([
            'author' => function($author) {
                     $author->select('id', 'name')
                 }
            ])->filter($request);

        // return streamed csv file
        return $exportCsv->stream($builder);
    }
}

To save the csv to file, instead use $exportCsv->file('path/to/file', '$builder);