README

This plugin provides user-friendly Filament actions to enable you create data imports and exports using maatwebsite/excel at the click of a button.

Installation

You can install the package via composer:

composer require coolsam/excel-import

You can publish the config file with:

php artisan vendor:publish --tag="coolsam-excel-config"

This is the contents of the published config file:

return [
    'accepted_mimes' => [
        'application/vnd.ms-excel',
        'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet',
        'text/csv',
        'text/plain',
        'csv',
        'txt',
    ],
    'temporary_files' => [
        'disk' => 'local',
        'directory' => 'coolsam-excel',
    ],
];

Usage

Imports:

The package provides two types of Actions for importing records: Page Action and Table Action.

Using Page Actions in the List Page:

Add the following import action in your resource list page, e.g ListUsers

    use Coolsam\FilamentExcel\Actions\ImportAction;
    use Coolsam\FilamentExcel\Actions\ImportField;
    protected function getHeaderActions(): array
    {
        return [
            ImportAction::make('users')->fields([
                ImportField::make('name')->required(),
                ImportField::make('email')->required(),
            ]),
            ... ,// Other Actions
        ];
    }

Using the table Action in your resource Class:

Chain the following into your $table variable in the Resource class. This is also useful in case you would like to import child records in a relation manager class. Note that the Action import part is different.

use Coolsam\FilamentExcel\Actions\ImportField;
use Coolsam\FilamentExcel\Actions\Tables\ImportAction;

    $table->headerActions([
        ImportAction::make('import users')
            ->fields([
                ImportField::make('name')->required(),
                ImportField::make('email')->required(),
            ])->uniqueField('email')
            ->createRecordUsing(fn($data) => User::updateOrCreate(
                ['email' => $data['email']],
                $data
            ))
    ])

Unique field:

In case you would like to skip some records which already exist in the DB, you will have to specify a unique field to check for checking existin fields.

    $table->headerActions([
        ImportAction::make('import users')
            ->fields([
                ImportField::make('name')->required(),
                ImportField::make('email')->required(),
            ])->uniqueField('email')
            ->createRecordUsing(fn($data) => User::updateOrCreate(
                ['email' => $data['email']],
                $data
            ))
    ])

Manually handle the record creation process:

You probably love to be in control, and would like to create the record on your own, given the data. Here is how:

    $table->headerActions([
        ImportAction::make('import users')
            ->fields([
                ImportField::make('name')->required(),
                ImportField::make('email')->required(),
            ])->createRecordUsing(fn($data) => User::updateOrCreate(
                ['email' => $data['email']],
                $data
            ))
    ])

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

License

The MIT License (MIT). Please see License File for more information.

coolsam / excel-import

Maintainers

Details