Download the PHP package elrayes/laravel-csv-export without Composer

Elrayes/LaravelCsvExport

Modern, clean CSV export for Laravel 12+ with separation of concerns:

• Contracts for defining what to export
• Exporters to encapsulate query + mapping
• Services to orchestrate writing
• A Facade for ergonomic usage

Licensed under MIT.

Installation

You can install the package via composer:

The service provider and facade will be automatically registered via Laravel's package discovery.

Concepts

• Elrayes\LaravelCsvExport\Contracts\DataExporterInterface
  • query(): Builder|Collection
  • headings(): array
  • map(mixed $row): array
• Elrayes\LaravelCsvExport\Exporters\BaseExporter
  • Sensible defaults + configuration helpers: chunk size, max limit, include BOM
• Elrayes\LaravelCsvExport\Services\CSVExportService
  • exportToHandle(): core routine using CSVWriter
  • toFile(): write to a path
  • stream(): streamed download
  • download(): generate and return a downloadable response
  • store(): NEW — store resulting CSV to a Laravel Storage disk
• Elrayes\LaravelCsvExport\Services\CSVWriter
  • Low-level wrapper around fputcsv (writeBom, writeRow, close)
• Elrayes\LaravelCsvExport\Facades\CSVExport
  • Facade accessor for easy calls

Quick start

Generate an exporter using the Artisan command:

This will create app/Export/UserCSVExporter.php. Implement the logic in the generated class.

Example exporter:

Usage

Import the Facade:

• Write to a specific file path:

• Stream as a download (controller action):

• Using Facade configuration overrides (Fluent API):

• Download after generating a temp file:

• Store to a Laravel Storage disk (new):

Configuration knobs

From BaseExporter (or set dynamically on your exporter instance):

• chunk size: how many rows to process per chunk
• max limit: cap total rows to export (null for unlimited)
• use max limit: toggle applying the cap
• include BOM: prepend UTF-8 BOM for Excel compatibility

Example:

Error handling

Exceptions thrown during writing propagate after being reported via Laravel's exception handler (when using the app). Always wrap in try/catch at call sites if you want custom failure behavior.

License

MIT © Elrayes

Advanced typing (PHPDoc generics)

For better static analysis (e.g., with Larastan/PHPStan), the package exposes a generic type parameter for the row model passed to map().

• DataExporterInterface is declared as @template TModel
• BaseExporter implements @implements DataExporterInterface<TModel>
• map() is documented as @param TModel $row
• query() is documented as returning Builder|Collection<int, TModel>|BuilderContract

Example with a User model: