elsayed85 / filament-import
Requires
- php: ^8.0
- filament/filament: ^3
- filament/notifications: ^3.0
- illuminate/contracts: ^10
- illuminate/support: ^10.0
- livewire/livewire: ^3
- maatwebsite/excel: ^3.1.48
- psr/simple-cache: ^2.0|^3.0
- spatie/laravel-package-tools: ^1.16
Requires (Dev)
- laravel/pint: ^1.11
- nunomaduro/collision: ^6.4|^7.0
- nunomaduro/larastan: ^2.6.4
- orchestra/testbench: ^8.8
- pestphp/pest: ^2
- pestphp/pest-plugin-laravel: ^2
- pestphp/pest-plugin-livewire: ^2.1
- phpstan/extension-installer: ^1.3.1
- phpstan/phpstan-deprecation-rules: ^1.1.4
- phpstan/phpstan-phpunit: ^1.3.13
- phpunit/phpunit: ^9.6.10|^10.0
This package is auto-updated.
Last update: 2024-11-16 17:33:06 UTC
README
Filament Plugin for Import CSV and XLS into Database
This package will make it easier for you to import from files to your model, very easily without the need to do templates.
all you have to do is drag and drop and match the fields and columns of your file, and let magic happens!
Installation
You can install the package via composer:
composer require konnco/filament-import
Publishing Config
If you want to do the settings manually, please publish the existing config.
php artisan vendor:publish --tag=filament-import-config
Usage
import the actions into ListRecords
page
use Konnco\FilamentImport\Actions\ImportAction; use Konnco\FilamentImport\Actions\ImportField; class ListCredentialDatabases extends ListRecords { protected static string $resource = CredentialDatabaseResource::class; protected function getActions(): array { return [ ImportAction::make() ->fields([ ImportField::make('project') ->label('Project') ->helperText('Define as project helper'), ImportField::make('manager') ->label('Manager'), ]) ]; } }
Required Field
protected function getActions(): array { return [ ImportAction::make() ->fields([ ImportField::make('project') ->label('Project') ->required(), ]) ]; }
Disable Mass Create
if you still want to stick with the event model you might need this and turn off mass create
protected function getActions(): array { return [ ImportAction::make() ->massCreate(false) ->fields([ ImportField::make('project') ->label('Project') ->required(), ]) ]; }
Filter Out Blank Rows
If you have a spreadsheet which includes blank data click here to see more, you can filter these out:
protected function getActions(): array { return [ ImportAction::make() ->handleBlankRows(true) ->fields([ ImportField::make('project') ->label('Project') ->required(), ]) ]; }
Field Data Mutation
you can also manipulate data from row spreadsheet before saving to model
protected function getActions(): array { return [ ImportAction::make() ->fields([ ImportField::make('project') ->label('Project') ->mutateBeforeCreate(fn($value) => Str::of($value)->camelCase()) ->required(), ]) ]; }
otherwise you can manipulate data and getting all mutated data from field before its getting insert into the database.
protected function getActions(): array { return [ ImportAction::make() ->fields([ ImportField::make('email') ->label('Email') ->required(), ])->mutateBeforeCreate(function($row){ $row['password'] = bcrypt($row['email']); return $row; }) ]; }
it is also possible to manipulate data after it was inserted into the database
use Illuminate\Database\Eloquent\Model; protected function getActions(): array { return [ ImportAction::make() ->fields([ ImportField::make('email') ->label('Email') ->required(), ])->mutateAfterCreate(function(Model $model, $row){ // do something with the model return $model; }) ]; }
Grid Column
Of course, you can divide the column grid into several parts to beautify the appearance of the data map
protected function getActions(): array { return [ ImportAction::make() ->fields([ ImportField::make('project') ->label('Project') ->required(), ], columns:2) ]; }
Json Format Field
We also support the json format field, which you can set when calling the make
function and separate the name with a dot annotation
protected function getActions(): array { return [ ImportAction::make() ->fields([ ImportField::make('project.en') ->label('Project In English') ->required(), ImportField::make('project.id') ->label('Project in Indonesia') ->required(), ], columns:2) ]; }
Static Field Data
for the static field data you can use the common fields from filament
use Filament\Forms\Components\Select; protected function getActions(): array { return [ ImportAction::make() ->fields([ ImportField::make('name') ->label('Project') ->required(), Select::make('status') ->options([ 'draft' => 'Draft', 'reviewing' => 'Reviewing', 'published' => 'Published', ]) ], columns:2) ]; }
Unique field
if your model should be unique, you can pass the name of the field, which will be used to check if a row already exists in the database. if it exists, skip that row (preventing an error about non unique row)
use Filament\Forms\Components\Select; protected function getActions(): array { return [ ImportAction::make() ->uniqueField('email') ->fields([ ImportField::make('email') ->label('Email') ->required(), ], columns:2) ]; }
Validation
you can make the validation for import fields, for more information about the available validation please check laravel documentation
use Filament\Forms\Components\Select; protected function getActions(): array { return [ ImportAction::make() ->fields([ ImportField::make('name') ->label('Project') ->rules('required|min:10|max:255'), ], columns:2) ]; }
Create Record
you can overide the default record creation closure and put your own code by using handleRecordCreation
function
use Filament\Forms\Components\Select; protected function getActions(): array { return [ ImportAction::make() ->fields([ ImportField::make('name') ->label('Project') ->rules('required|min:10|max:255'), ], columns:2) ->handleRecordCreation(function($data){ return Post::create($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.