moonshine/import-export

Import/Export Handlers for MoonShine

Maintainers

Details

github.com/moonshine-software/import-export

Homepage

Source

Issues

Installs: 13 734

Dependents: 1

Suggesters: 0

Security: 0

Stars: 2

Watchers: 1

Forks: 3

Open Issues: 0

1.0.4 2025-03-08 18:19 UTC

Requires

Conflicts

MIT 9f8d900ea68e6b3bd4a73b836575e0ee715dce9d

importexportmoonshine

This package is auto-updated.

Last update: 2025-03-08 18:21:00 UTC

README

Documentation

Requirements

  • MoonShine 3+
  • Laravel 10+
  • PHP 8.2+

Installation

composer require moonshine/import-export

Usage

  • Add trait MoonShine\ImportExport\Traits\ImportExportConcern and interface MoonShine\ImportExport\Contracts\HasImportExportContract to ModelResource
/**
 * @extends ModelResource<Category>
 */
class CategoryResource extends ModelResource implements HasImportExportContract
{
    use ImportExportConcern;
    
    // ...
}
  • Define fields
/**
 * @extends ModelResource<Category>
 */
class CategoryResource extends ModelResource implements HasImportExportContract
{
    use ImportExportConcern;
    
    // ...
    
    protected function exportFields(): iterable
    {
        return [
            ID::make(),
            Position::make(),
            Text::make('Name'),
        ];
    }
    
    protected function importFields(): iterable
    {
        return [
            ID::make(),
            Text::make('Name'),
        ];
    }
}
  • Events
public function beforeImportFilling(array $data): array
{
    return $data;
}

public function beforeImported(mixed $item): mixed
{
    return $item;
}

public function afterImported(mixed $item): mixed
{
    return $item;
}
  • Queue
protected function export(): ?Handler
{
    return ExportHandler::make(__('moonshine::ui.export'))->queue();
}

protected function import(): ?Handler
{
    return ImportHandler::make(__('moonshine::ui.import'))->queue();
}