feat: Add CSV export functionality for Tags, Categories, and People (#13)

* Add export functionality to PersonResource

Introduced a `PersonExporter` class to handle exporting Person data with defined columns and notifications. Updated `ListPeople` to include an export action supporting CSV format, enhancing data management capabilities.

* Add export functionality for categories

Implemented a `CategoryExporter` class to handle category exports with specific columns and notifications. Integrated an export action into the category list page, supporting CSV format. This enhancement improves data handling and accessibility for category records.

* Add Tag export functionality with CSV support

Introduced `TagExporter` to handle exporting tags with columns for ID, name, and color. Integrated an export action into the `ListTags` page, enabling CSV export and providing notification details for successes and failures.

Author: chinmaypurav

app/Filament/Exports/CategoryExporter.php

@@ -0,0 +1,33 @@
+<?php
+
+namespace App\Filament\Exports;
+
+use App\Models\Category;
+use Filament\Actions\Exports\ExportColumn;
+use Filament\Actions\Exports\Exporter;
+use Filament\Actions\Exports\Models\Export;
+
+class CategoryExporter extends Exporter
+{
+    protected static ?string $model = Category::class;
+
+    public static function getColumns(): array
+    {
+        return [
+            ExportColumn::make('id')
+                ->label('ID'),
+            ExportColumn::make('name'),
+        ];
+    }
+
+    public static function getCompletedNotificationBody(Export $export): string
+    {
+        $body = 'Your category export has completed and '.number_format($export->successful_rows).' '.str('row')->plural($export->successful_rows).' exported.';
+
+        if ($failedRowsCount = $export->getFailedRowsCount()) {
+            $body .= ' '.number_format($failedRowsCount).' '.str('row')->plural($failedRowsCount).' failed to export.';
+        }
+
+        return $body;
+    }
+}

app/Filament/Exports/PersonExporter.php

@@ -0,0 +1,35 @@
+<?php
+
+namespace App\Filament\Exports;
+
+use App\Models\Person;
+use Filament\Actions\Exports\ExportColumn;
+use Filament\Actions\Exports\Exporter;
+use Filament\Actions\Exports\Models\Export;
+
+class PersonExporter extends Exporter
+{
+    protected static ?string $model = Person::class;
+
+    public static function getColumns(): array
+    {
+        return [
+            ExportColumn::make('id')
+                ->label('ID'),
+            ExportColumn::make('user.name'),
+            ExportColumn::make('name'),
+            ExportColumn::make('nick_name'),
+        ];
+    }
+
+    public static function getCompletedNotificationBody(Export $export): string
+    {
+        $body = 'Your person export has completed and '.number_format($export->successful_rows).' '.str('row')->plural($export->successful_rows).' exported.';
+
+        if ($failedRowsCount = $export->getFailedRowsCount()) {
+            $body .= ' '.number_format($failedRowsCount).' '.str('row')->plural($failedRowsCount).' failed to export.';
+        }
+
+        return $body;
+    }
+}

app/Filament/Exports/TagExporter.php

@@ -0,0 +1,34 @@
+<?php
+
+namespace App\Filament\Exports;
+
+use App\Models\Tag;
+use Filament\Actions\Exports\ExportColumn;
+use Filament\Actions\Exports\Exporter;
+use Filament\Actions\Exports\Models\Export;
+
+class TagExporter extends Exporter
+{
+    protected static ?string $model = Tag::class;
+
+    public static function getColumns(): array
+    {
+        return [
+            ExportColumn::make('id')
+                ->label('ID'),
+            ExportColumn::make('name'),
+            ExportColumn::make('color'),
+        ];
+    }
+
+    public static function getCompletedNotificationBody(Export $export): string
+    {
+        $body = 'Your tag export has completed and '.number_format($export->successful_rows).' '.str('row')->plural($export->successful_rows).' exported.';
+
+        if ($failedRowsCount = $export->getFailedRowsCount()) {
+            $body .= ' '.number_format($failedRowsCount).' '.str('row')->plural($failedRowsCount).' failed to export.';
+        }
+
+        return $body;
+    }
+}

app/Filament/Resources/CategoryResource/Pages/ListCategories.php

@@ -2,8 +2,11 @@
 
 namespace App\Filament\Resources\CategoryResource\Pages;
 
+use App\Filament\Exports\CategoryExporter;
 use App\Filament\Resources\CategoryResource;
 use Filament\Actions\CreateAction;
+use Filament\Actions\ExportAction;
+use Filament\Actions\Exports\Enums\ExportFormat;
 use Filament\Resources\Pages\ListRecords;
 
 class ListCategories extends ListRecords
@@ -14,6 +17,11 @@ protected function getHeaderActions(): array
     {
         return [
             CreateAction::make(),
+            ExportAction::make()
+                ->exporter(CategoryExporter::class)
+                ->formats([
+                    ExportFormat::Csv,
+                ]),
         ];
     }
 }

app/Filament/Resources/PersonResource/Pages/ListPeople.php

@@ -2,9 +2,12 @@
 
 namespace App\Filament\Resources\PersonResource\Pages;
 
+use App\Filament\Exports\PersonExporter;
 use App\Filament\Imports\PersonImporter;
 use App\Filament\Resources\PersonResource;
 use Filament\Actions\CreateAction;
+use Filament\Actions\ExportAction;
+use Filament\Actions\Exports\Enums\ExportFormat;
 use Filament\Actions\ImportAction;
 use Filament\Resources\Pages\ListRecords;
 
@@ -18,6 +21,11 @@ protected function getHeaderActions(): array
             CreateAction::make(),
             ImportAction::make()
                 ->importer(PersonImporter::class),
+            ExportAction::make()
+                ->exporter(PersonExporter::class)
+                ->formats([
+                    ExportFormat::Csv,
+                ]),
         ];
     }
 }

app/Filament/Resources/TagResource/Pages/ListTags.php

@@ -2,9 +2,12 @@
 
 namespace App\Filament\Resources\TagResource\Pages;
 
+use App\Filament\Exports\TagExporter;
 use App\Filament\Imports\TagImporter;
 use App\Filament\Resources\TagResource;
 use Filament\Actions\CreateAction;
+use Filament\Actions\ExportAction;
+use Filament\Actions\Exports\Enums\ExportFormat;
 use Filament\Actions\ImportAction;
 use Filament\Resources\Pages\ListRecords;
 
@@ -18,6 +21,11 @@ protected function getHeaderActions(): array
             CreateAction::make(),
             ImportAction::make()
                 ->importer(TagImporter::class),
+            ExportAction::make()
+                ->exporter(TagExporter::class)
+                ->formats([
+                    ExportFormat::Csv,
+                ]),
         ];
     }
 }