Merge pull request #259 from pxlrbt/feat/csv-settings

Add support for CsvSettings

Author: pxlrbt

readme.md

@@ -172,6 +172,39 @@ ExportAction::make()->exports([
 ```
 
 
+### CSV settings
+
+When exporting as CSV, you can customize the CSV output via `->withCsvSettings()` using the `CsvSettings` DTO. Any setting left as `null` will use the 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,
+        )),
+])
+```
+
+You can also pass a Closure for dynamic configuration:
+
+```php
+ExcelExport::make()
+    ->withWriterType(Excel::CSV)
+    ->withCsvSettings(fn () => new CsvSettings(
+        delimiter: '\t',
+        outputEncoding: 'ISO-8859-1',
+    ))
+```
+
+Available settings: `delimiter`, `enclosure`, `lineEnding`, `useBom`, `includeSeparatorLine`, `excelCompatibility`, `outputEncoding`.
+
 ### Defining columns
 
 When using `->fromForm()`/`->fromTable()`/`->fromModel()` the columns are resolved from your table or form definition. You can also provide columns manually, append columns or overwrite generated columns.

src/Exports/Concerns/CanQueue.php

@@ -51,6 +51,7 @@ protected function prepareQueuedExport()
         $this->writerType = $this->getWriterType();
         $this->columnFormats = $this->getColumnFormats();
         $this->columnWidths = $this->getColumnWidths();
+        $this->csvSettings = $this->getCsvSettings();
         $this->livewireClass = $this->getLivewireClass();
 
         // Reset

src/Exports/Concerns/WithCsvSettings.php

@@ -0,0 +1,29 @@
+<?php
+
+namespace pxlrbt\FilamentExcel\Exports\Concerns;
+
+use Closure;
+use pxlrbt\FilamentExcel\Exports\CsvSettings;
+
+trait WithCsvSettings
+{
+    protected Closure|CsvSettings|array|null $csvSettings = null;
+
+    public function withCsvSettings(Closure|CsvSettings $csvSettings): static
+    {
+        $this->csvSettings = $csvSettings;
+
+        return $this;
+    }
+
+    public function getCsvSettings(): array
+    {
+        $settings = $this->evaluate($this->csvSettings);
+
+        if ($settings instanceof CsvSettings) {
+            return $settings->toArray();
+        }
+
+        return $settings ?? [];
+    }
+}

src/Exports/CsvSettings.php

@@ -0,0 +1,29 @@
+<?php
+
+namespace pxlrbt\FilamentExcel\Exports;
+
+readonly class CsvSettings
+{
+    public function __construct(
+        public ?string $delimiter = null,
+        public ?string $enclosure = null,
+        public ?string $lineEnding = null,
+        public ?bool $useBom = null,
+        public ?bool $includeSeparatorLine = null,
+        public ?bool $excelCompatibility = null,
+        public ?string $outputEncoding = null,
+    ) {}
+
+    public function toArray(): array
+    {
+        return array_filter([
+            'delimiter' => $this->delimiter,
+            'enclosure' => $this->enclosure,
+            'line_ending' => $this->lineEnding,
+            'use_bom' => $this->useBom,
+            'include_separator_line' => $this->includeSeparatorLine,
+            'excel_compatibility' => $this->excelCompatibility,
+            'output_encoding' => $this->outputEncoding,
+        ], fn ($value) => $value !== null);
+    }
+}

src/Exports/ExcelExport.php

@@ -17,6 +17,7 @@
 use Maatwebsite\Excel\Concerns\WithColumnFormatting;
 use Maatwebsite\Excel\Concerns\WithColumnWidths;
 use Maatwebsite\Excel\Concerns\WithCustomChunkSize;
+use Maatwebsite\Excel\Concerns\WithCustomCsvSettings;
 use Maatwebsite\Excel\Concerns\WithEvents;
 use Maatwebsite\Excel\Concerns\WithHeadings as HasHeadings;
 use Maatwebsite\Excel\Concerns\WithMapping as HasMapping;
@@ -33,6 +34,7 @@
 use pxlrbt\FilamentExcel\Exports\Concerns\WithChunkSize;
 use pxlrbt\FilamentExcel\Exports\Concerns\WithColumnFormats;
 use pxlrbt\FilamentExcel\Exports\Concerns\WithColumns;
+use pxlrbt\FilamentExcel\Exports\Concerns\WithCsvSettings;
 use pxlrbt\FilamentExcel\Exports\Concerns\WithFilename;
 use pxlrbt\FilamentExcel\Exports\Concerns\WithHeadings;
 use pxlrbt\FilamentExcel\Exports\Concerns\WithMapping;
@@ -43,7 +45,7 @@
 use pxlrbt\FilamentExcel\Interactions\AskForWriterType;
 use pxlrbt\FilamentExcel\Jobs\Middleware\SetAuthenticatedUser;
 
-class ExcelExport implements FromQuery, HasHeadings, HasMapping, ShouldAutoSize, WithColumnFormatting, WithColumnWidths, WithCustomChunkSize, WithEvents, WithMultipleSheets, WithTitle
+class ExcelExport implements FromQuery, HasHeadings, HasMapping, ShouldAutoSize, WithColumnFormatting, WithColumnWidths, WithCustomChunkSize, WithCustomCsvSettings, WithEvents, WithMultipleSheets, WithTitle
 {
     use AskForFilename;
     use AskForWriterType;
@@ -63,6 +65,7 @@ class ExcelExport implements FromQuery, HasHeadings, HasMapping, ShouldAutoSize,
     use WithChunkSize;
     use WithColumnFormats;
     use WithColumns;
+    use WithCsvSettings;
     use WithFilename;
     use WithHeadings;
     use WithMapping;