Laravel Excel

Laravel Excel provides several high-performance features for handling spreadsheet data:

• Collection Exports: Easily export Laravel collections directly to Excel or CSV documents.
• High-Performance Exports: Export database queries with automatic chunking to manage memory. Large datasets can be exported via background queues.
• High-Performance Imports: Import workbooks and worksheets directly into Eloquent models using chunk reading and batch inserts. Large file imports can be queued chunk-by-chunk to run in the background.
• Blade View Exports: Create custom spreadsheet layouts by using HTML tables within Blade views and exporting them to Excel.

When writing tests for Laravel Excel, you can use ExcelFake to mock the Excel facade. This allows you to verify that exports, imports, downloads, and queued jobs are being handled correctly without actually performing file system or queue operations.

ExcelFake tracks all interactions and provides assertion methods to verify the state of your Excel operations.

// Example of how you might use Excel::fake() in a test
Excel::fake();

// Perform your logic...
Excel::store(new MyExport, 'exports/data.xlsx');

// Assert the operation occurred
Excel::assertStored('exports/data.xlsx');

The HeadingRowFormatter determines how heading row values are transformed during an import. You can set a global formatter using HeadingRowFormatter::default(), or rely on the excel.imports.heading_row.formatter configuration value.

Available built-in formatters:

• none: Returns the heading value exactly as it appears in the file.
• slug: Converts the heading value into a slug using underscores as separators (e.g., "First Name" becomes "first_name").

use Maatwebsite\
Excel\Imports\HeadingRowFormatter;

// Set the formatter to 'none' globally
HeadingRowFormatter::default('none');

// Or set it to 'slug' (default behavior)
HeadingRowFormatter::default('slug');

The following version compatibility matrix applies to the current supported version (3.1):

Note: Versions 2.1 and 3.0 are no longer supported.

The getIndex() method returns the integer index of the current row within the spreadsheet.

$index = $row->getIndex();

Use assertImported to verify that a file was imported from a specific disk. You can provide a callback to inspect the import object.

assertImported(string $filePath, $disk = null, $callback = null)

Excel::assertImported('uploads/data.csv', 'local', function ($import) {
    return $import instanceof MyImport;
});

You can define custom formatting logic for heading rows by using the extend method. This allows you to register a new formatter name associated with a callable (a function or method) that processes the heading value.

When the custom formatter is called, it receives the heading $value and its original $key.

use Maatwebsite\Excel\Imports\HeadingRowFormatter;

// Register a custom formatter named 'uppercase'
HeadingRowFormatter::extend('uppercase', function ($value, $key) {
    return strtoupper($value);
});

// Activate the custom formatter
HeadingRowFormatter::default('uppercase');

Use assertExportedInRaw to verify that an export was processed using the raw method. The assertion checks for the existence of the export class name in the internal tracking.

assertExportedInRaw(string $classname, $callback = null)

Excel::assertExportedInRaw(MyExport::class);

The getDelegate() method returns the underlying PhpOffice\PhpSpreadsheet\Worksheet\Row instance. This allows you to access low-level PhpSpreadsheet methods directly on the row object.

$spreadsheetRow = $row->getDelegate();

Use the isEmpty() method to determine if a row contains any data. This method filters out null values to check for actual content.

Parameters:

• $calculateFormulas: Whether to calculate formula results (defaults to false).
• $endColumn: An optional string specifying the last column to check (e.g., 'G').

if ($row->isEmpty()) {
    // Handle empty row
}