CategoryImporter.php

TLDR

This file, CategoryImporter.php, is a class file that is part of the Demo Projects project. It is located at app/Filament/Imports/Blog/CategoryImporter.php. The file contains a class called CategoryImporter, which extends the Importer class. This class is responsible for importing data related to blog categories and provides methods for column definitions, resolving records, and generating a notification body upon completion of the import process.

Methods

getColumns

This method returns an array of ImportColumn instances that define the columns to be imported for blog categories. Each column has various properties such as name, label, mapping, rules, and example values.

resolveRecord

This method resolves and returns a Category model instance based on the provided data. It first retrieves an existing category record using the slug column value, or creates a new category if it doesn't exist.

getCompletedNotificationBody

This static method generates and returns the body text for a completion notification message after an import process. It includes information about the number of successfully imported rows and optionally the number of failed rows.

<?php

namespace App\Filament\Imports\Blog;

use App\Models\Blog\Category;
use Filament\Actions\Imports\ImportColumn;
use Filament\Actions\Imports\Importer;
use Filament\Actions\Imports\Models\Import;

class CategoryImporter extends Importer
{
    protected static ?string $model = Category::class;

    public static function getColumns(): array
    {
        return [
            ImportColumn::make('name')
                ->requiredMapping()
                ->rules(['required', 'max:255'])
                ->example('Category A'),
            ImportColumn::make('slug')
                ->requiredMapping()
                ->rules(['required', 'max:255'])
                ->example('category-a'),
            ImportColumn::make('description')
                ->example('This is the description for Category A.'),
            ImportColumn::make('is_visible')
                ->label('Visibility')
                ->requiredMapping()
                ->boolean()
                ->rules(['required', 'boolean'])
                ->example('yes'),
            ImportColumn::make('seo_title')
                ->label('SEO title')
                ->rules(['max:60'])
                ->example('Awesome Category A'),
            ImportColumn::make('seo_description')
                ->label('SEO description')
                ->rules(['max:160'])
                ->example('Wow! It\'s just so amazing.'),
        ];
    }

    public function resolveRecord(): ?Category
    {
        return Category::firstOrNew([
            'slug' => $this->data['slug'],
        ]);
    }

    public static function getCompletedNotificationBody(Import $import): string
    {
        $body = 'Your blog category import has completed and ' . number_format($import->successful_rows) . ' ' . str('row')->plural($import->successful_rows) . ' imported.';

        if ($failedRowsCount = $import->getFailedRowsCount()) {
            $body .= ' ' . number_format($failedRowsCount) . ' ' . str('row')->plural($failedRowsCount) . ' failed to import.';
        }

        return $body;
    }
}