Filament Excel

https://github.com/pxlrbt/filament-excel
Admin
Filament Excel provides easy configuration for Excel exports in Filament applications through bulk...
Tokens:63,705
Snippets:484
Trust Score:9.6
License:MIT
Update:10 hours ago
Show doc for...
Tokens:
Raw
### AskForFilename usage example

Source: https://github.com/pxlrbt/filament-excel

Example of using askForFilename with a default filename and label, and withFilename to prefix the filename.

```php
ExcelExport::make()
    ->askForFilename('users-2024', 'Output name')
    ->withFilename(fn ($filename) => 'prefix-'.$filename);
```

--------------------------------

### Custom export class extending ExcelExport with setUp()

Source: https://github.com/pxlrbt/filament-excel/blob/main/readme.md

Extend the ExcelExport class and configure it using setUp() to separate export code from resources. Use this when you need custom exports with a custom filename and specific columns.

```php
use pxlrbt\FilamentExcel\Actions\Tables\ExportAction;
use pxlrbt\FilamentExcel\Exports\ExcelExport;
use pxlrbt\FilamentExcel\Columns\Column;

class CustomExport extends ExcelExport
{
    
    public function setUp()
    {
        $this->withFilename('custom_export');
        $this->withColumns([
            Column::make('name'),
            Column::make('email'),
        ]);
    }
}
```

--------------------------------

### AskForWriterType usage example

Source: https://github.com/pxlrbt/filament-excel

Example of using askForWriterType with a default writer type and withWriterType callback.

```php
use Maatwebsite\Excel\Excel;

ExcelExport::make()
    ->askForWriterType(default: Excel::XLSX)
    ->withWriterType(fn ($writerType) => $writerType);
```

--------------------------------

### setUp() hook

Source: https://github.com/pxlrbt/filament-excel

Extension hook called from make(). No-op by default; subclasses override to set defaults.

```php
public function setUp()
{
    //
}
```

--------------------------------

### setUp()

Source: https://github.com/pxlrbt/filament-excel

Extension hook called from make(). No-op by default; subclasses override to set defaults.

```APIDOC
## setUp()

### Description
Extension hook called from make(). No-op by default; subclasses override to set defaults.

### Method
setUp

### Signature
`public function setUp()`
```

--------------------------------

### Install Filament Excel with Composer

Source: https://github.com/pxlrbt/filament-excel/blob/main/readme.md

Installs the Filament Excel package via Composer, which also downloads Laravel Excel. Use this in a Filament project to enable Excel export actions.

```bash
composer require pxlrbt/filament-excel
```

--------------------------------

### Custom WAF-friendly URL example

Source: https://github.com/pxlrbt/filament-excel

Example of using createExportUrlUsing to generate a temporary signed route with a custom path and extension, replacing the default signed-URL generation.

```php
use pxlrbt\FilamentExcel\FilamentExport;

FilamentExport::createExportUrlUsing(function ($export) {
    $fileInfo = pathinfo($export['filename']);
    return URL::temporarySignedRoute(
        'your-custom-route',
        now()->addHours(2),
        ['path' => $fileInfo['filename'], 'extension' => $fileInfo['extension']]
    );
});
```

--------------------------------

### Example: ExcelExport::make() usage

Source: https://github.com/pxlrbt/filament-excel

Example of creating an export with a custom name and chaining fromTable() and withFilename().

```php
use pxlrbt\FilamentExcel\Exports\ExcelExport;

$export = ExcelExport::make('user_export')
    ->fromTable()
    ->withFilename('users');
```

--------------------------------

### Static factory make()

Source: https://github.com/pxlrbt/filament-excel

Static factory that resolves an ExcelExport from the container with a default name 'export' and calls setUp(). Returns a new instance with setUp() invoked.

```php
public static function make(string $name = 'export'): static
```

--------------------------------

### Constructor and make()

Source: https://github.com/pxlrbt/filament-excel

The constructor is protected; instantiate via make(). make() sets a default formatStateUsing identity formatter and calls setUp().

```php
protected function __construct($name)

public static function make($name): static
```

--------------------------------

### Install Filament Excel with psr/simple-cache:^2.0

Source: https://github.com/pxlrbt/filament-excel/blob/main/readme.md

Installs Filament Excel on Laravel 9 or greater while specifying psr/simple-cache version ^2.0 to satisfy the PhpSpreadsheet dependency. Use this if composer require fails due to the simple-cache dependency.

```bash
composer require psr/simple-cache:^2.0 pxlrbt/filament-excel
```

--------------------------------

### make()

Source: https://github.com/pxlrbt/filament-excel

Static factory method to create a new Column instance. It sets a default identity formatter and calls setUp().

```APIDOC
## make()

### Description
Static factory method to create a new Column instance. It sets a default identity formatter and calls setUp().

### Method
make

### Signature
`public static function make($name): static`

### Parameters
- `$name` (mixed) - Required - Column/state key.

### Example
```php
use pxlrbt\FilamentExcel\Columns\Column;

Column::make('email')->heading('Email address');
```
```

--------------------------------

### Column::make example

Source: https://github.com/pxlrbt/filament-excel

Creates a column for the 'email' state key with heading 'Email address'.

```php
use pxlrbt\FilamentExcel\Columns\Column;

Column::make('email')->heading('Email address');
```

--------------------------------

### Example: setting column width to 10

Source: https://github.com/pxlrbt/filament-excel

Shows how to set a fixed width of 10 for the 'email' column using the width() method.

```php
ExcelExport::make()->withColumns([
    Column::make('email')->width(10),
]);
```

--------------------------------

### Usage example for ExportAction

Source: https://github.com/pxlrbt/filament-excel

Shows how to create an ExportAction with a custom export from the table.

```php
use pxlrbt\FilamentExcel\Actions\ExportAction;

ExportAction::make()
    ->exports([
        pxlrbt\FilamentExcel\Exports\ExcelExport::make()->fromTable(),
    ]);
```

--------------------------------

### Example: applying currency format to a column

Source: https://github.com/pxlrbt/filament-excel

Shows how to apply the PhpSpreadsheet currency format constant FORMAT_CURRENCY_EUR_INTEGER to the 'currency' column.

```php
use PhpOffice\PhpSpreadsheet\Style\NumberFormat;
use pxlrbt\FilamentExcel\Columns\Column;

Column::make('currency')->format(NumberFormat::FORMAT_CURRENCY_EUR_INTEGER);
```

--------------------------------

### Custom queue name and connection

Source: https://github.com/pxlrbt/filament-excel/blob/main/readme.md

Specify a custom queue name and optionally a custom connection. The first example uses the default connection with queue 'exports'; the second uses the 'redis' connection.

```php
ExcelExport::make()->queue(queue: 'exports')
ExcelExport::make()->queue(queue: 'exports', connection: 'redis')
```

--------------------------------

### Example - single export

Source: https://github.com/pxlrbt/filament-excel

Shows how to configure an ExportBulkAction with a single export using fromTable(). This replaces the default export.

```php
use pxlrbt\FilamentExcel\Actions\Tables\ExportBulkAction;
use pxlrbt\FilamentExcel\Exports\ExcelExport;

ExportBulkAction::make()->exports([
    ExcelExport::make()->fromTable(),
]);
```

--------------------------------

### heading() example

Source: https://github.com/pxlrbt/filament-excel

Sets a closure heading and retrieves it, returning 'Created'.

```php
Column::make('created_at')
    ->heading(fn () => 'Created')
    ->getHeading(); // returns 'Created'
```

--------------------------------

### ExcelExport withSheets example

Source: https://github.com/pxlrbt/filament-excel

Shows how to use withSheets() with named arguments to replace the default data sheet and add prepend/append sheets. The example uses OverriddenDataSheet, CoverSheet, and AppendixSheet classes.

```php
ExcelExport::make('user_export')->fromTable()->withSheets(
    sheets: [new OverriddenDataSheet()],
    prepend: [new CoverSheet()],
    append: [new AppendixSheet()],
);
```

--------------------------------

### Manual flush without panels - sendNotification() example

Source: https://github.com/pxlrbt/filament-excel

Example of calling sendNotification() manually in a ServiceProvider boot() when no Filament panel or serving hook is active. Use this to flush pending export notifications outside the normal panel context.

```php
// In a ServiceProvider boot() when no Filament panel / serving hook is active:
app(\pxlrbt\FilamentExcel\FilamentExport::class)->sendNotification();
```

--------------------------------

### formatStateUsing() example with strtoupper

Source: https://github.com/pxlrbt/filament-excel

Shows how to use formatStateUsing() to transform the state, e.g., converting to uppercase. The closure receives the state and returns the formatted value.

```php
Column::make('name')
    ->formatStateUsing(fn ($state) => strtoupper($state));
```

--------------------------------

### CanQueue usage example

Source: https://github.com/pxlrbt/filament-excel

Shows how to queue an export with default queue or with a specific queue name and connection.

```php
ExcelExport::make()->queue();                              // default queue
ExcelExport::make()->queue(queue: 'exports', connection: 'redis');
```

--------------------------------

### rtl() method signature and example

Source: https://github.com/pxlrbt/filament-excel

Enables right-to-left rendering for the workbook (sheet setRightToLeft(true)). Default is true. Example shows enabling RTL for an Arabic workbook.

```php
public function rtl(bool $isRtl = true): static
```

```php
use pxlrbt\FilamentExcel\Exports\ExcelExport;

$export = ExcelExport::make()->rtl(); // enables RTL for an Arabic workbook
```

--------------------------------

### Configure composer.json for local fork testing

Source: https://github.com/pxlrbt/filament-excel/blob/main/readme.md

Add the local path repository and require the forked package version in your app's composer.json to test changes from the fork. After updating composer.json, run `composer update` to install the package from the local path.

```json
"require": {
    "pxlrbt/filament-excel": "dev-fix/error-message as main-dev",
},
"repositories": [
    {
        "type": "path",
        "url": "filament-excel"
    }
]
```

--------------------------------

### label() usage example

Source: https://github.com/pxlrbt/filament-excel

Shows how to set a label on an ExcelExport instance. The comment notes that the query() call is not applicable because the label comes from getLabel().

```php
ExcelExport::make('users')
    ->label('User export')
    ->query(); // not applicable — label comes from ->getLabel()
```

--------------------------------

### ExcelExport::make()

Source: https://github.com/pxlrbt/filament-excel

Static factory method that returns a new ExcelExport instance resolved from the container with setUp() called on it. It accepts an optional name parameter.

```APIDOC
## Static factory `make()`

```php
public static function make(string $name = 'export'): static
```

### Parameters
- `$name` (string) - Optional - Default: `'export'` - Internal name of the export.

### Description
Returns a new `ExcelExport` resolved from the container (so it can be replaced/bound in the service container) with `setUp()` called on it. `setUp()` is a no-op hook that can be overridden in subclasses.

### Request Example

```php
use pxlrbt\FilamentExcel\Exports\ExcelExport;

$export = ExcelExport::make('user_export')
    ->fromTable()
    ->withFilename('users');
```
```

--------------------------------

### Customize CSV settings with CsvSettings

Source: https://github.com/pxlrbt/filament-excel/blob/main/readme.md

Customizes CSV output via withCsvSettings() using the CsvSettings DTO. The example sets delimiter to ';' and useBom to true. Any setting left as null uses Laravel Excel config defaults.

```php
use pxlrbt\FilamentExcel\Actions\Tables\ExportAction;
use pxlrbt\FilamentExcel\Exports\ExcelExport;
use pxlrbt\FilamentExcel\Exports\CsvSettings;
use Maatwebsite\Excel\Excel;

ExportAction::make()->exports([
    ExcelExport::make()
        ->withWriterType(Excel::CSV)
        ->withCsvSettings(new CsvSettings(
            delimiter: ';',
            useBom: true,
        )),
])
```

--------------------------------

### Listen for ExportFinishedEvent to notify users

Source: https://github.com/pxlrbt/filament-excel/blob/main/readme.md

Listens for the ExportFinishedEvent to notify users of a finished queued export when no panel is available. The event provides filename, userId, and locale; the example creates a temporary signed download URL valid for 24 hours.

```php
use pxlrbt\FilamentExcel\Events\ExportFinishedEvent;

Event::listen(ExportFinishedEvent::class, function (ExportFinishedEvent $event) {
    // $event->filename, $event->userId, $event->locale
    $url = URL::temporarySignedRoute(
        'filament-excel-download',
        now()->addDays(1),
        ['path' => $event->filename]
    );

    // Mail it, broadcast it, store it — whatever fits your app.
});
```

--------------------------------

### Custom export URL with temporarySignedRoute

Source: https://github.com/pxlrbt/filament-excel/blob/main/readme.md

Customize the export URL generation to avoid WAF false positives. The default signed URL expires in 24 hours and includes the filename with extension; this example creates a temporary signed route with a 2-hour expiration and separates the filename and extension.

```php
// Somewhere in a ServiceProvider in the `boot()` method.
use pxlrbt\FilamentExcel\FilamentExport;

FilamentExport::createExportUrlUsing(function ($export) {
    $fileInfo = pathinfo($export['filename']);
    $filenameWithoutExtension = $fileInfo['filename'];
    $extension = $fileInfo['extension'];

    return URL::temporarySignedRoute(
        'your-custom-route',
        now()->addHours(2),
        ['path' => $filenameWithoutExtension, 'extension' => $extension]
    );
});
```

--------------------------------

### Run filament-excel:prune artisan command

Source: https://github.com/pxlrbt/filament-excel

Example command to run the prune artisan command. The package auto-schedules this to run daily via Schedule::command(PruneExportsCommand::class)->daily() in the service provider when the scheduler resolves.

```bash
php artisan filament-excel:prune
```

--------------------------------

### Set export filename with string or Closure

Source: https://github.com/pxlrbt/filament-excel/blob/main/readme.md

Sets the export filename either with a static string or a Closure. The string example uses the current date, while the Closure uses the resource's label. Both are passed to withFilename() on ExcelExport.

```php
use pxlrbt\FilamentExcel\Actions\Tables\ExportAction;
use pxlrbt\FilamentExcel\Exports\ExcelExport;

ExportAction::make()->exports([
    // Pass a string
    ExcelExport::make()->withFilename(date('Y-m-d') . ' - export'),
    
    // Or pass a Closure
    ExcelExport::make()->withFilename(fn ($resource) => $resource::getLabel())
])
```

--------------------------------

### Example - multiple exports (modal template picker)

Source: https://github.com/pxlrbt/filament-excel

Configures an ExportBulkAction with two exports: one from the table and one from a form. This triggers the modal template picker.

```php
ExportBulkAction::make()->exports([
    ExcelExport::make('table')->fromTable(),
    ExcelExport::make('form')->fromForm(),
]);
```

--------------------------------

### Example usage of withNamesAsHeadings() and withoutHeadings()

Source: https://github.com/pxlrbt/filament-excel

Shows two alternative ways to configure an Excel export: either use raw column names as headings or emit an empty heading row. Both are used with fromTable().

```php
ExcelExport::make()->fromTable()->withNamesAsHeadings();
// or
ExcelExport::make()->fromTable()->withoutHeadings();
```

--------------------------------

### Add ExportBulkAction to table bulk actions

Source: https://github.com/pxlrbt/filament-excel/blob/main/readme.md

Adds the ExportBulkAction to a Filament resource's table bulk actions. The first example is for the admin package (filament/filament) and the second for the separate table package (filament/tables). Both use the same action class and require the ExportBulkAction import.

```php
<?php

namespace App\Filament\Resources;

use pxlrbt\FilamentExcel\Actions\Tables\ExportBulkAction;

class UserResource extends Resource
{  
    public static function table(Table $table): Table
    {
        return $table
            ->columns([
                //   
            ])
            ->bulkActions([
                ExportBulkAction::make()
            ]);
    }
}

```

```php
<?php

namespace App\Filament\Resources;

use pxlrbt\FilamentExcel\Actions\Tables\ExportBulkAction;

public function getTableBulkActions()
{
    return  [
        ExportBulkAction::make()
    ];
}

```

--------------------------------

### Custom notification listener for ExportFinishedEvent

Source: https://github.com/pxlrbt/filament-excel

Example listener that registers via Event::listen and generates a temporary signed route for the export file. Uses URL::temporarySignedRoute with the 'filament-excel-download' route and a 24-hour expiry.

```php
use pxlrbt\FilamentExcel\Events\ExportFinishedEvent;

Event::listen(ExportFinishedEvent::class, function (ExportFinishedEvent $event) {
    // $event->filename, $event->userId, $event->locale, $event->panelId
    $url = URL::temporarySignedRoute(
        'filament-excel-download',
        now()->addHours(24),
        ['path' => $event->filename]
    );
});
```

--------------------------------

### CanIgnoreFormatting: ignoreFormatting usage examples

Source: https://github.com/pxlrbt/filament-excel

Shows three ways to call `ignoreFormatting`: all columns, an array of column names, or a closure receiving the `Column` (injected as `column`) returning bool/array.

```php
ExcelExport::make()->fromTable()->ignoreFormatting();                    // all
ExcelExport::make()->fromTable()->ignoreFormatting(['created_at']);      // some
ExcelExport::make()->fromTable()->ignoreFormatting(
    fn (Column $column) => Str::startsWith($column->getName(), 'customer_')
);
```

--------------------------------

### Synchronous export through an action

Source: https://github.com/pxlrbt/filament-excel

Example of calling ->export() directly on a hydrated export. Requires a hydrated export; normally exported via an action.

```php
// The ExcelExport is normally exported via an action; calling ->export()
// directly requires a hydrated export.
$response = $export
    ->fromTable()
    ->hydrate(livewire: $livewire, records: $records)
    ->export();
```

--------------------------------

### Route definition for GET /filament-excel/{path}

Source: https://github.com/pxlrbt/filament-excel

Defines the single HTTP route that serves finished exports from the 'filament-excel' disk. The route uses 'web' and 'signed' middleware, validates the path with '.*', and deletes the file after the response terminates. Returns 404 if the file does not exist.

```php
Route::get('filament-excel/{path}', function (string $path) {
    $filename = substr($path, 37);
    $disk = Storage::disk('filament-excel');

    abort_unless($disk->exists($path), 404);

    $response = $disk->download($path, $filename);

    app()->terminating(fn () => $disk->delete($path));

    return $response;
})
    ->middleware(['web', 'signed'])
    ->where('path', '.*')
    ->name('filament-excel-download');
```

--------------------------------

### formatStateUsing()

Source: https://github.com/pxlrbt/filament-excel

Sets a callback that formats the state for the column. The callback is wrapped in a SerializableClosure and evaluated with column, livewire, record, relatedRecord, and state injected. By default, an identity closure is installed unless overridden or skipped via ignoreFormatting().

```APIDOC
## formatStateUsing()

### Description
Sets a callback that formats the state for the column. The callback is wrapped in a SerializableClosure and evaluated with column, livewire, record, relatedRecord, and state injected. By default, an identity closure is installed unless overridden or skipped via ignoreFormatting().

### Method
`formatStateUsing(?callable $callback): static`

### Parameters
- `$callback` (?callable) - Required - Closure formatting the state, or `null` to clear.

### Returns
`static` - Returns the column instance for chaining.

### Example
```php
Column::make('name')
    ->formatStateUsing(fn ($state) => strtoupper($state));
```

### Source
`src/Columns/Column.php:144`
```

--------------------------------

### getSelectedExport() throws Exception when exports empty

Source: https://github.com/pxlrbt/filament-excel

Throws a plain \Exception when the configured exports collection is empty. Triggered by handleExport() on ExportAction/ExportBulkAction; normally avoided because setUp() pre-seeds a default export, but can occur if exports() replaces the list with an empty array or exports are cleared.

```php
protected function getSelectedExport($data): ExcelExport
{
    if ($this->exports->isEmpty()) {
        throw new Exception('No export templates defined');
    }

    return $this->exports->get(
        data_get($data, 'selected_exportable', 0)
    );
}
```

--------------------------------

### ExcelExport::setUp()

Source: https://github.com/pxlrbt/filament-excel

A protected-by-convention no-op hook invoked by make(). Subclasses override it to build a configured export declaratively.

```APIDOC
## `setUp()`

```php
public function setUp()
{
    //
}
```

### Description
A protected-by-convention no-op hook invoked by `make()`. Subclasses override it to build a configured export declaratively (e.g. a `CustomExport` class that calls `$this->withColumns(...)` inside `setUp()`).
```

--------------------------------

### Queue export with ->queue()

Source: https://github.com/pxlrbt/filament-excel/blob/main/readme.md

Queue the export to run in background jobs. The user is notified on the next page load (or when Livewire polls). The temporary file is deleted after the first download; undownloaded files are removed by a scheduled command after 24 hours.

```php
use pxlrbt\FilamentExcel\Actions\Tables\ExportAction;
use pxlrbt\FilamentExcel\Exports\ExcelExport;

ExportAction::make()->exports([
    ExcelExport::make()->queue()
])
```

--------------------------------

### Dynamically configure CSV settings with Closure

Source: https://github.com/pxlrbt/filament-excel/blob/main/readme.md

Passes a Closure to withCsvSettings() for dynamic configuration. The Closure returns a CsvSettings instance with tab delimiter and ISO-8859-1 output encoding. Available settings include delimiter, enclosure, lineEnding, useBom, includeSeparatorLine, excelCompatibility, and outputEncoding.

```php
ExcelExport::make()
    ->withWriterType(Excel::CSV)
    ->withCsvSettings(fn () => new CsvSettings(
        delimiter: '\t',
        outputEncoding: 'ISO-8859-1',
    ))
```

--------------------------------

### Configure shared disk for queued exports

Source: https://github.com/pxlrbt/filament-excel/blob/main/readme.md

Define a custom `filament-excel` disk in `config/filesystems.php` to override the default local disk. The package only registers the local default when this key is missing.

```php
'disks' => [
    'filament-excel' => [
        'driver' => 's3',
        // ...
    ],
],
```

--------------------------------

### WithChunkSize usage example

Source: https://github.com/pxlrbt/filament-excel

Sets the chunk size to 1000 for a queued export.

```php
ExcelExport::make()->queue()->withChunkSize(1000);
```

--------------------------------

### ExcelExport with fromTable and except

Source: https://github.com/pxlrbt/filament-excel

Example usage of ExcelExport: derive columns from the table and exclude specific columns.

```php
ExcelExport::make()
    ->fromTable()                                  // derive from table
    ->except(['created_at', 'updated_at']);        // minus these
```

--------------------------------

### Ask user for filename and writer type

Source: https://github.com/pxlrbt/filament-excel/blob/main/readme.md

Use this snippet to let the user pick a filename and writer type during export by calling `->askForFilename()` and `->askForWriterType()` on the export.

```php
use pxlrbt\FilamentExcel\Actions\Tables\ExportAction;
use pxlrbt\FilamentExcel\Exports\ExcelExport;

ExportAction::make()->exports([
    ExcelExport::make()
        ->askForFilename()
        ->askForWriterType()
])
```

--------------------------------

### Set dynamic filename with Closure

Source: https://github.com/pxlrbt/filament-excel/blob/main/readme.md

Uses a Closure to dynamically set the filename. The Closure receives the $resource argument and returns the resource's label. Available arguments include $livewire, $livewireClass, $resource, $model, $recordIds, and $query.

```php
use pxlrbt\FilamentExcel\Actions\Tables\ExportAction;
use pxlrbt\FilamentExcel\Exports\ExcelExport;

ExportAction::make()->exports([
    ExcelExport::make('table')->withFilename(fn ($resource) => $resource::getLabel()),
])
```

--------------------------------

### GET /filament-excel/{path}

Source: https://github.com/pxlrbt/filament-excel

Downloads a finished export file from the filament-excel storage disk. The route requires a valid signed URL and deletes the file after the first successful download.

```APIDOC
## [GET] /filament-excel/{path}

### Description
Downloads a finished export file from the filament-excel storage disk. The route requires a valid signed URL and deletes the file after the first successful download.

### Method
GET

### Endpoint
`/filament-excel/{path}`

### Parameters
#### Path Parameters
- **path** (string) - Required - The stored export file path on the `filament-excel` disk. Validated by `/.*` (matches the whole remaining path), allowing nested storage paths.

#### Query Parameters
- **signature** (string) - Required - The Laravel signed-URL signature (`URL::temporarySignedRoute(...)` produces `?expires=&signature=`). Required by the `signed` middleware.
- **expires** (string) - Required - Expiration timestamp produced by `temporarySignedRoute`. Enforced by the `signed` middleware.

### Response
#### Success Response (200)
Streamed file download (`BinaryFileResponse`) served directly from the disk via `Storage::disk('filament-excel')->download($path, $filename)`. `$filename` is `substr($path, 37)` — the path minus its 37-character leading ID (queued filenames are `UUID-...`).

#### Failure Response (404)
Returned via `abort_unless($disk->exists($path), 404)` when the file does not exist on the disk.

#### Invalid/Expired Signature (403)
Raised by the `signed` middleware before the handler runs.

### Auth
There is **no explicit authorization** on this route beyond URL signing. The `web` middleware group applies, and the `signed` middleware requires a valid (non-expired) URL signature. Any client holding a valid signed, unexpired URL can download the file; the file is deleted on the response's `terminating` callback after the first download.

### Lifetime
Successful downloads delete the file in `app()->terminating(...)`. Files never downloaded are removed by the scheduled `filament-excel:prune` command (runs daily, deletes files older than 24 hours).

### Request Example
```php
$url = URL::temporarySignedRoute(
    'filament-excel-download',
    now()->addHours(24),
    ['path' => $event->filename] // e.g. 'c219c10e-...-users.xlsx'
);
```
```

--------------------------------

### width() and getWidth() method signatures

Source: https://github.com/pxlrbt/filament-excel

Defines the public API for setting and retrieving the column width. The width can be a closure or an integer; null means auto-sized.

```php
public function width(Closure|int $width): static
public function getWidth(): int|Closure|null
```

--------------------------------

### Example: modify query using closure

Source: https://github.com/pxlrbt/filament-excel

Demonstrates using `modifyQueryUsing()` to add a `where` clause to the export query. The callback receives the query builder and can be used to filter the exported data.

```php
ExcelExport::make()
    ->fromTable()
    ->modifyQueryUsing(fn ($query) => $query->where('exportable', true));
```

--------------------------------

### createExportUrlUsing() method signature

Source: https://github.com/pxlrbt/filament-excel

Defines the static method that overrides download URL generation globally. The closure receives the export array and must return a URL string.

```php
public static function createExportUrlUsing(Closure $closure): void
```

--------------------------------

### Configure multiple export classes with ExportAction

Source: https://github.com/pxlrbt/filament-excel/blob/main/readme.md

Configures multiple export classes with different settings. The user is shown a modal to select the export class. Uses ExportAction::make()->exports() with two ExcelExport instances, one from the table and one from the form.

```php
use pxlrbt\FilamentExcel\Actions\Tables\ExportAction;
use pxlrbt\FilamentExcel\Exports\ExcelExport;

ExportAction::make()->exports([
    ExcelExport::make('table')->fromTable(),
    ExcelExport::make('form')->fromForm(),
])
```

--------------------------------

### createUrl() method signature

Source: https://github.com/pxlrbt/filament-excel

Protected method that returns the download URL for an export. If static::$createExportUrlUsing is set, delegates to it; otherwise builds a temporary signed route 'filament-excel-download' with a 24-hour expiry.

```php
protected function createUrl(array $export): string
```

--------------------------------

### createUrl()

Source: https://github.com/pxlrbt/filament-excel

Returns the download URL for an export. If a custom URL generator is set, it delegates to that; otherwise it builds a temporary signed route to the download endpoint.

```APIDOC
## `createUrl()`

### Description
Returns the download URL. If `static::$createExportUrlUsing` is set, delegates to it; otherwise builds `URL::temporarySignedRoute('filament-excel-download', now()->addHours(24), ['path' => $export['filename']])`. The default URL is the route defined in [`endpoints.md`](/output/endpoints.md).

### Method
`createUrl`

### Parameters
- **$export** (array) - Required - The export data array containing at least a 'filename' key.

### Response
- **string** - The download URL.
```

--------------------------------

### Swap ArrayFormatter via service container

Source: https://github.com/pxlrbt/filament-excel/blob/main/readme.md

Use this snippet to replace the default `ArrayFormatter` implementation via Laravel's service container, for example to change the delimiter to ';'. This is useful when the state of a column is not a string and needs to be formatted for Excel, even when `ignoreFormatting()` is used.

```php
use pxlrbt\FilamentExcel\Exports\Formatters\ArrayFormatter;

class AppServiceProvider extends ServiceProvider
{
    public function register()
    {
        App::bind(ArrayFormatter::class, function () {
            return new ArrayFormatter(';');
        });
    }
}
```

--------------------------------

### fromTable() method signature

Source: https://github.com/pxlrbt/filament-excel

Generates columns from the livewire table definition via createFieldMappingFromTable(), respects toggleable-column visibility, sets columnsSource = 'table', and calls useTableQuery().

```php
public function fromTable(): static
```

--------------------------------

### createExportUrlUsing()

Source: https://github.com/pxlrbt/filament-excel

Overrides download URL generation globally. The closure is invoked with a single argument — the export data array with keys `id`, `filename`, `userId`, `locale` — and must return the URL to download the file.

```APIDOC
## createExportUrlUsing()

### Description
Overrides download URL generation globally. The closure is invoked with a single argument — the export data array with keys `id`, `filename`, `userId`, `locale` — and must return the URL to download the file.

### Method
createExportUrlUsing

### Parameters
#### Parameters
- **$closure** (Closure) - Required - Replaces the default signed-URL generation. Receives the export array and must return a URL string.

### Request Example
```php
use pxlrbt\FilamentExcel\FilamentExport;

FilamentExport::createExportUrlUsing(function ($export) {
    $fileInfo = pathinfo($export['filename']);
    return URL::temporarySignedRoute(
        'your-custom-route',
        now()->addHours(2),
        ['path' => $fileInfo['filename'], 'extension' => $fileInfo['extension']]
    );
});
```
```

--------------------------------

### Example: respect hidden vs full column filtering

Source: https://github.com/pxlrbt/filament-excel

Shows three usage patterns for `ExcelExport::make()->fromTable()`: the default respects model `$hidden` attributes, `except([])` never omits hidden attributes, and `only(['id', 'name'])` keeps only the specified columns.

```php
// Respect model $hidden attributes (default):
ExcelExport::make()->fromTable();

// Never omit hidden attributes:
ExcelExport::make()->fromTable()->except([]);

// Keep only these:
ExcelExport::make()->fromTable()->only(['id', 'name']);
```

--------------------------------

### Define export columns with Column::make()

Source: https://github.com/pxlrbt/filament-excel/blob/main/readme.md

Define export columns manually with Column::make(). Use when you need to specify exactly which columns to export, overriding the automatic resolution from the table or form definition.

```php
use pxlrbt\FilamentExcel\Actions\Tables\ExportAction;
use pxlrbt\FilamentExcel\Exports\ExcelExport;
use pxlrbt\FilamentExcel\Columns\Column;

ExportAction::make()->exports([
    ExcelExport::make()->withColumns([
        Column::make('name'),
        Column::make('created_at'),
        Column::make('deleted_at'),
    ]),
])
```

--------------------------------

### Catching the 'No export templates defined' exception

Source: https://github.com/pxlrbt/filament-excel

Shows how to catch the plain \Exception in consumer code. The message is exactly 'No export templates defined'.

```php
try {
    $action->handleExport($data);
} catch (\Exception $e) {
    // $e->getMessage() === 'No export templates defined'
}
```

--------------------------------

### WithCsvSettings: Configure CSV export settings

Source: https://github.com/pxlrbt/filament-excel

Accepts a CsvSettings DTO, a closure returning one, or returns the DTO's toArray(). Returns an empty array when null. Satisfies Laravel-Excel's WithCustomCsvSettings interface. The example shows setting a custom delimiter and BOM for CSV export.

```php
protected Closure|CsvSettings|array|null $csvSettings = null;

public function withCsvSettings(Closure|CsvSettings $csvSettings): static
public function getCsvSettings(): array
```

```php
use pxlrbt\FilamentExcel\Exports\CsvSettings;

ExcelExport::make()
    ->withWriterType(\Maatwebsite\Excel\Excel::CSV)
    ->withCsvSettings(new CsvSettings(delimiter: ';', useBom: true));
```

--------------------------------

### ExportBulkAction class definition

Source: https://github.com/pxlrbt/filament-excel

Defines the ExportBulkAction class extending Filament's BulkAction. It uses the ExportableAction trait, sets the default name to 'export', and in setUp() calls deselectRecordsAfterCompletion() to clear selected rows after export. The handleExport method resolves the selected export, hydrates it with the records and form data, and returns the export result.

```php
class ExportBulkAction extends BulkAction
{
    use ExportableAction {
        ExportableAction::setUp as parentSetUp;
    }

    public static function getDefaultName(): ?string
    {
        return 'export';
    }

    protected function setUp(): void
    {
        parent::setUp();
        $this->parentSetUp();
        $this->deselectRecordsAfterCompletion();
    }

    public function handleExport(Collection $records, array $data)
    {
        $exportable = $this->getSelectedExport($data);

        return app()->call([$exportable, 'hydrate'], [
            'livewire' => $this->getLivewire(),
            'records' => $records,
            'formData' => data_get($data, $exportable->getName()),
        ])->export();
    }
}
```

--------------------------------

### CsvSettings::__construct()

Source: https://github.com/pxlrbt/filament-excel

Creates a new CsvSettings value object with optional CSV output options. Each parameter is nullable and falls back to the Laravel Excel config default when null.

```APIDOC
## CsvSettings::__construct()

### Description
Creates a new CsvSettings instance to configure CSV export options. All parameters are optional and default to null, meaning the underlying Laravel Excel config default is used.

### Method
Constructor

### Parameters
- **delimiter** (?string) - Optional - Column delimiter (e.g. `;`). Falls back to config default.
- **enclosure** (?string) - Optional - Field enclosure character.
- **lineEnding** (?string) - Optional - End-of-line sequence.
- **useBom** (?bool) - Optional - Whether to prepend a Byte-Order-Mark.
- **includeSeparatorLine** (?bool) - Optional - Whether to emit a separator line.
- **excelCompatibility** (?bool) - Optional - Excel-compatible CSV output.
- **outputEncoding** (?string) - Optional - Output character encoding.

### Usage Example
```php
new CsvSettings(
    delimiter: ';',
    useBom: true,
    outputEncoding: 'ISO-8859-1',
)
```
```

--------------------------------

### fromTable()

Source: https://github.com/pxlrbt/filament-excel

Generates columns from the livewire table definition via `createFieldMappingFromTable()`, sets `columnsSource = 'table'`, and calls `useTableQuery()`.

```APIDOC
## fromTable()

### Description
Generates columns from the livewire table definition via `createFieldMappingFromTable()` (respects toggleable-column visibility), sets `columnsSource = 'table'`, and calls `useTableQuery()`.

### Method
`fromTable`

### Signature
```php
public function fromTable(): static
```

### Return Value
`static` - Returns the current instance for chaining.
```

--------------------------------

### Ignore formatting with ignoreFormatting()

Source: https://github.com/pxlrbt/filament-excel/blob/main/readme.md

Use this snippet to ignore formatting when exporting from a table or form. `->ignoreFormatting()` can be called with no arguments to ignore all formatting, with an array of column names to ignore specific columns, or with a Closure that receives a `Column` instance to conditionally ignore columns.

```php
use pxlrbt\FilamentExcel\Actions\Tables\ExportAction;
use pxlrbt\FilamentExcel\Exports\ExcelExport;
use pxlrbt\FilamentExcel\Columns\Column;

ExportAction::make()->exports([
    // Ignore all formatting
    ExcelExport::make()->fromTable()->ignoreFormatting()
    
    // Ignore specific columns
    ExcelExport::make()->fromTable()->ignoreFormatting([
        'created_at', 'updated_at',
    ]),
    
    // Ignore columns based on Closure
    ExcelExport::make()->fromTable()->ignoreFormatting(
        fn (Column $column) => Str::startsWith($column->getName(), 'customer_')
    ),
])
```

--------------------------------

### withCsvSettings(...) / getCsvSettings()

Source: https://github.com/pxlrbt/filament-excel

Sets CSV output options.

```APIDOC
## withCsvSettings(...) / getCsvSettings()

### Description
Sets CSV output options.

### Method
withCsvSettings / getCsvSettings

### Parameters
- **...$settings** (mixed) - Required for `withCsvSettings` - The CSV settings.

### Response
`getCsvSettings()` returns the CSV settings.
```

--------------------------------

### columnWidths() / getColumnWidths()

Source: https://github.com/pxlrbt/filament-excel

Sets per-column widths.

```APIDOC
## columnWidths() / getColumnWidths()

### Description
Sets per-column widths.

### Method
columnWidths / getColumnWidths

### Parameters
- **...$widths** (mixed) - Required for `columnWidths` - The column widths.

### Response
`getColumnWidths()` returns the column widths.
```

--------------------------------

### heading() / getHeading()

Source: https://github.com/pxlrbt/filament-excel

heading() sets the column header text or a closure producing it. getHeading() returns the set heading, or Str::headline($this->name) when unset.

```php
public function heading(Closure|string $heading): static
public function getHeading(): string|Closure
```

--------------------------------

### Set chunk size with withChunkSize

Source: https://github.com/pxlrbt/filament-excel/blob/main/readme.md

Adjust the number of records processed per queued job. Use `withChunkSize(100)` to set the chunk size to 100.

```php
use pxlrbt\FilamentExcel\Actions\Tables\ExportAction;
use pxlrbt\FilamentExcel\Exports\ExcelExport;

ExportAction::make()->exports([
    ExcelExport::make()->queue()->withChunkSize(100)
])
```

--------------------------------

### Generating a fresh signed URL for custom download delivery

Source: https://github.com/pxlrbt/filament-excel

Builds a new signed URL for the filament-excel-download route with a 24-hour expiry. Needed for custom delivery paths because downloads normally launch via the Filament notification action and there is no in-code error path; the user browser sees 403/404 pages for invalid/expired signatures or missing files.

```php
$url = URL::temporarySignedRoute('filament-excel-download', now()->addHours(24), ['path' => $filename]);
```

--------------------------------

### export() method signature

Source: https://github.com/pxlrbt/filament-excel

Entry point that produces the file. Resolves filename and writer type from interaction form data. Returns void when queued, or a Symfony BinaryFileResponse when running synchronously.

```php
public function export()
```

--------------------------------

### export()

Source: https://github.com/pxlrbt/filament-excel

The entry point that produces the file. It resolves the filename and writer type, then either streams a synchronous download or dispatches a queued export job.

```APIDOC
## export()

### Description
Produces the file. Resolves the final filename and writer type from interaction form data. For non-queued exports, calls `downloadExport()` and returns the HTTP response. For queued exports, prepares the queued export, records user context, dispatches the export job, and sends a success notification.

### Method
`export()`

### Return Value
- **void** when queued
- **Symfony\Component\HttpFoundation\BinaryFileResponse** when running synchronously

### Example — synchronous export through an action
```php
// The ExcelExport is normally exported via an action; calling ->export()
// directly requires a hydrated export.
$response = $export
    ->fromTable()
    ->hydrate(livewire: $livewire, records: $records)
    ->export();
```
```

--------------------------------

### query() and getQuery() method signatures

Source: https://github.com/pxlrbt/filament-excel

query() is the Laravel-Excel FromQuery hook returning getQuery(). When queued, it detaches the livewire component for clean serialization. getQuery() resolves the source query, applying optional modifications and record ID filters.

```php
public function query(): Builder|EloquentBuilder|Relation
```

```php
public function getQuery()
```

--------------------------------

### label() / getLabel()

Source: https://github.com/pxlrbt/filament-excel

label() sets the display label; getLabel() returns it, defaulting to Str::headline($this->name) when unset.

```APIDOC
## `label()` / `getLabel()`

```php
public function label(string $label): static
public function getLabel(): string
```

| Parameter | Type | Required | Default | Description |
|-----------|------|----------|---------|-------------|
| `$label` | string | yes | — | Human-readable label for the export. |

`label()` sets the display label; `getLabel()` returns it, defaulting to `Str::headline($this->name)` when unset.

### Example

```php
ExcelExport::make('users')
    ->label('User export')
    ->query(); // not applicable — label comes from ->getLabel()
```

*Source: `src/Exports/ExcelExport.php:137`*
```

--------------------------------

### heading() / getHeading()

Source: https://github.com/pxlrbt/filament-excel

Sets or retrieves the column heading. getHeading() returns the set heading or a headline version of the column name if unset.

```APIDOC
## heading() / getHeading()

### Description
Sets or retrieves the column heading. getHeading() returns the set heading or a headline version of the column name if unset.

### Methods
- `public function heading(Closure|string $heading): static`
- `public function getHeading(): string|Closure`

### Parameters
- `$heading` (Closure|string) - Required - Column header text or a closure producing it.

### Example
```php
Column::make('created_at')
    ->heading(fn () => 'Created')
    ->getHeading(); // returns 'Created'
```
```

--------------------------------

### Format columns with formatStateUsing

Source: https://github.com/pxlrbt/filament-excel/blob/main/readme.md

Use this snippet to format column values during export by providing a Closure to `formatStateUsing()`. The Closure receives `$state` and `$record` in addition to the default parameters, allowing transformations like replacing '@' with '[at]' or joining related data.

```php
use pxlrbt\FilamentExcel\Actions\Tables\ExportAction;
use pxlrbt\FilamentExcel\Exports\ExcelExport;
use pxlrbt\FilamentExcel\Columns\Column;

ExportAction::make()->exports([
    ExcelExport::make()->withColumns([
        Column::make('email')
            ->formatStateUsing(fn ($state) => str_replace('@', '[at]', $state)),
            
        Column::make('name')
            ->formatStateUsing(fn ($record) => $record->locations->pluck('name')->join(','),
    ]),
])
```

--------------------------------

### Use user input in filename Closure

Source: https://github.com/pxlrbt/filament-excel/blob/main/readme.md

Use this snippet to use the user's input inside a Closure when generating the filename. The `withFilename()` method receives the user-provided filename and can modify it, e.g., by adding a prefix.

```php
use pxlrbt\FilamentExcel\Actions\Tables\ExportAction;
use pxlrbt\FilamentExcel\Exports\ExcelExport;

ExportAction::make()->exports([
    ExcelExport::make()
        ->askForFilename()
        ->withFilename(fn ($filename) => 'prefix-' . $filename)
])
```

--------------------------------

### getQueueName() and getQueueConnection() method signatures

Source: https://github.com/pxlrbt/filament-excel

Returns the configured queue name and connection.

```php
public function getQueueName(): ?string
public function getQueueConnection(): ?string
```

--------------------------------

### withColumns(...) / getColumns()

Source: https://github.com/pxlrbt/filament-excel

Sets manual column definitions for the export.

```APIDOC
## withColumns(...) / getColumns()

### Description
Sets manual column definitions for the export.

### Method
withColumns / getColumns

### Parameters
- **...$columns** (mixed) - Required for `withColumns` - The column definitions.

### Response
`getColumns()` returns the column definitions.
```

--------------------------------

### AskForFilename trait signature

Source: https://github.com/pxlrbt/filament-excel

Trait method signature for adding a filename text input to the export form schema. The method is used by ExcelExport and returns self.

```php
trait AskForFilename
{
    public function askForFilename(?string $default = null, ?string $label = null, ?callable $callback = null): self
}
```

--------------------------------

### queue() method signature

Source: https://github.com/pxlrbt/filament-excel

Marks the export for background processing. Accepts optional queue name and connection for allOnQueue() and allOnConnection().

```php
public function queue(?string $queue = null, ?string $connection = null): static
```

--------------------------------

### Constructor __construct($name)

Source: https://github.com/pxlrbt/filament-excel

Public constructor requiring an internal name for the export, used as the export key when multiple exports share one action. Instantiation via the container without arguments is not possible because a $name is required.

```php
public function __construct($name)
```

--------------------------------

### width() / getWidth()

Source: https://github.com/pxlrbt/filament-excel

Sets or returns the per-column width used when computing columnWidths(). The width can be a fixed integer or a closure that produces it; null means auto-sized.

```APIDOC
## width() / getWidth()

### Description
Sets or returns the per-column width used when computing `columnWidths()`. `null` means auto-sized.

### Method
`width(Closure|int $width): static`
`getWidth(): int|Closure|null`

### Parameters
- `$width` (Closure|int) - Required - Column width, or a closure producing it.

### Response
`getWidth()` returns `int|Closure|null`.

### Request Example
```php
ExcelExport::make()->withColumns([
    Column::make('email')->width(10),
]);
```
```
Tokens:
Raw