Models Resources

Импорт / Экспорт

Основы

По умолчанию импорт и экспорт включены для всех ресурсов моделей.
Чтобы переопределить это поведение, необходимо изменить конфигурацию moonshine.

// config/moonshine.php
 
'model_resources' => [
    'default_with_import' => false,
    'default_with_export' => false,
],
// config/moonshine.php
 
'model_resources' => [
    'default_with_import' => false,
    'default_with_export' => false,
],

Вы также можете отключить импорт и экспорт в ресурсе; для этого соответствующие методы должны возвращать null.

namespace App\MoonShine\Resources;
 
use App\Models\Post;
use MoonShine\Resources\ModelResource;
 
class PostResource extends ModelResource
{
    protected string $model = Post::class;
 
    protected string $title = 'Posts';
 
    public function import(): ?ImportHandler
    {
        return null;
    }
 
    public function export(): ?ExportHandler
    {
        return null;
    }
 
    //...
}
namespace App\MoonShine\Resources;
 
use App\Models\Post;
use MoonShine\Resources\ModelResource;
 
class PostResource extends ModelResource
{
    protected string $model = Post::class;
 
    protected string $title = 'Posts';
 
    public function import(): ?ImportHandler
    {
        return null;
    }
 
    public function export(): ?ExportHandler
    {
        return null;
    }
 
    //...
}

Импорт

Вы можете импортировать данные в админ-панель MoonShine.

Поля

Поля, которые будут участвовать в импорте, необходимо в ресурсе модели добавить метод useOnImport().

useOnImport(mixed $condition = null, ?Closure $fromRaw = null)
useOnImport(mixed $condition = null, ?Closure $fromRaw = null)
  • $condition - условие выполнения метода,
  • $fromRaw - замыкание, возвращающее значения из сырых данных.
namespace App\MoonShine\Resources;
 
use App\Enums\StatusEnum;
use App\Models\Post;
use MoonShine\Fields\Enum;
use MoonShine\Fields\ID;
use MoonShine\Resources\ModelResource;
 
class PostResource extends ModelResource
{
    protected string $model = Post::class;
 
    protected string $title = 'Posts';
 
    //...
 
    public function fields(): array
    {
        return [
            ID::make()
                ->useOnImport(),
 
            Enum::make('Status')
                ->attach(StatusEnum::class)
                ->useOnImport(fromRaw: static fn(string $raw, Enum $ctx) => StatusEnum::tryFrom($raw)),
        ];
    }
 
    //...
}
namespace App\MoonShine\Resources;
 
use App\Enums\StatusEnum;
use App\Models\Post;
use MoonShine\Fields\Enum;
use MoonShine\Fields\ID;
use MoonShine\Resources\ModelResource;
 
class PostResource extends ModelResource
{
    protected string $model = Post::class;
 
    protected string $title = 'Posts';
 
    //...
 
    public function fields(): array
    {
        return [
            ID::make()
                ->useOnImport(),
 
            Enum::make('Status')
                ->attach(StatusEnum::class)
                ->useOnImport(fromRaw: static fn(string $raw, Enum $ctx) => StatusEnum::tryFrom($raw)),
        ];
    }
 
    //...
}

Обязательно добавьте ID в импорт, иначе записи будут только добавляться без обновления существующих.

Обработчик

Также необходимо реализовать метод import() в ресурсе модели. Метод должен возвращать объект ImportHandler, который реализует алгоритм импорта данных.

namespace App\MoonShine\Resources;
 
use App\Models\Post;
use MoonShine\Handlers\ImportHandler;
use MoonShine\Resources\ModelResource;
 
class PostResource extends ModelResource
{
    protected string $model = Post::class;
 
    protected string $title = 'Posts';
 
    //...
 
    public function import(): ?ImportHandler
    {
        return ImportHandler::make('Import');
    }
 
    //...
}
namespace App\MoonShine\Resources;
 
use App\Models\Post;
use MoonShine\Handlers\ImportHandler;
use MoonShine\Resources\ModelResource;
 
class PostResource extends ModelResource
{
    protected string $model = Post::class;
 
    protected string $title = 'Posts';
 
    //...
 
    public function import(): ?ImportHandler
    {
        return ImportHandler::make('Import');
    }
 
    //...
}

Методы ImportHandler

Доступны необязательные методы для настройки импорта:

use MoonShine\Handlers\ImportHandler;
 
//...
 
public function import(): ?ImportHandler
{
    return ImportHandler::make('Import')
        // Указать ID пользователей, которые получат уведомление об окончании операции
        ->notifyUsers(fn() => [auth()->id()])
        // Выбор диска
        ->disk('public')
        // Выбор директории для сохранения файла импорта
        ->dir('/imports')
        // Удалить файл после импорта
        ->deleteAfter()
        // Разделитель для csv
        ->delimiter(',');
}
 
//...
use MoonShine\Handlers\ImportHandler;
 
//...
 
public function import(): ?ImportHandler
{
    return ImportHandler::make('Import')
        // Указать ID пользователей, которые получат уведомление об окончании операции
        ->notifyUsers(fn() => [auth()->id()])
        // Выбор диска
        ->disk('public')
        // Выбор директории для сохранения файла импорта
        ->dir('/imports')
        // Удалить файл после импорта
        ->deleteAfter()
        // Разделитель для csv
        ->delimiter(',');
}
 
//...

Если метод import() возвращает NULL, то кнопка импорта не появится на странице индекса.

События

Для изменения логики импорта можно использовать события ресурса модели.

//  MoonShine\Resources\ModelResource
 
public function beforeImportFilling(array $data): array
{
    return $data;
}
 
public function beforeImported(Model $item): Model
{
    return $item;
}
 
public function afterImported(Model $item): Model
{
    return $item;
}
//  MoonShine\Resources\ModelResource
 
public function beforeImportFilling(array $data): array
{
    return $data;
}
 
public function beforeImported(Model $item): Model
{
    return $item;
}
 
public function afterImported(Model $item): Model
{
    return $item;
}

Эти события вызываются в ImportHandler

// MoonShine\Handlers\ImportHandler
 
$data = $resource->beforeImportFilling($data);
 
$item->forceFill($data);
 
$item = $resource->beforeImported($item);
 
return tap(
    $item->save(),
    fn() => $resource->afterImported($item)
);
// MoonShine\Handlers\ImportHandler
 
$data = $resource->beforeImportFilling($data);
 
$item->forceFill($data);
 
$item = $resource->beforeImported($item);
 
return tap(
    $item->save(),
    fn() => $resource->afterImported($item)
);

Экспорт

В админ-панели MoonShine вы можете экспортировать все данные с учетом текущей фильтрации и сортировки.

По умолчанию данные экспортируются в формате xlsx, но есть возможность изменить формат на csv глобально или через метод csv() класса ExportHandler.

Глобальный формат экспорта

Вы можете изменить формат экспорта глобально в MoonShineServiceProvider:

use MoonShine\Providers\MoonShineApplicationServiceProvider;
use MoonShine\Resources\ModelResource;
 
class MoonShineServiceProvider extends MoonShineApplicationServiceProvider
{
    public function boot(): void
    {
        parent::boot();
 
        ModelResource::defaultExportToCsv();
    }
}
use MoonShine\Providers\MoonShineApplicationServiceProvider;
use MoonShine\Resources\ModelResource;
 
class MoonShineServiceProvider extends MoonShineApplicationServiceProvider
{
    public function boot(): void
    {
        parent::boot();
 
        ModelResource::defaultExportToCsv();
    }
}

Поля

В экспорте будут участвовать только те поля, у которых добавлен метод showOnExport().

showOnExport(mixed $condition = null, ?Closure $modifyRawValue = null)
showOnExport(mixed $condition = null, ?Closure $modifyRawValue = null)
  • $condition - условие выполнения метода,
  • $modifyRawValue - замыкание для получения сырого значения.
namespace App\MoonShine\Resources;
 
use App\Enums\StatusEnum;
use App\Models\Post;
use MoonShine\Fields\Enum;
use MoonShine\Fields\Text;
use MoonShine\Resources\ModelResource;
 
class PostResource extends ModelResource
{
    protected string $model = Post::class;
 
    protected string $title = 'Posts';
 
    //...
 
    public function fields(): array
    {
        return [
            Text::make('Title', 'title')
                ->showOnExport(),
 
            Enum::make('Status')
                ->attach(StatusEnum::class)
                ->showOnExport(modifyRawValue: static fn(StatusEnum $raw, Enum $ctx) => $raw->value),
        ];
    }
 
    //...
}
namespace App\MoonShine\Resources;
 
use App\Enums\StatusEnum;
use App\Models\Post;
use MoonShine\Fields\Enum;
use MoonShine\Fields\Text;
use MoonShine\Resources\ModelResource;
 
class PostResource extends ModelResource
{
    protected string $model = Post::class;
 
    protected string $title = 'Posts';
 
    //...
 
    public function fields(): array
    {
        return [
            Text::make('Title', 'title')
                ->showOnExport(),
 
            Enum::make('Status')
                ->attach(StatusEnum::class)
                ->showOnExport(modifyRawValue: static fn(StatusEnum $raw, Enum $ctx) => $raw->value),
        ];
    }
 
    //...
}

Обработчик

Также необходимо реализовать метод export() в ресурсе модели. Метод должен возвращать объект ExportHandler, который реализует алгоритм экспорта данных.

namespace App\MoonShine\Resources;
 
use App\Models\Post;
use MoonShine\Handlers\ExportHandler;
use MoonShine\Resources\ModelResource;
 
class PostResource extends ModelResource
{
    protected string $model = Post::class;
 
    protected string $title = 'Posts';
 
    //...
 
    public function export(): ?ExportHandler
    {
        return ExportHandler::make('Export');
    }
 
    //...
}
namespace App\MoonShine\Resources;
 
use App\Models\Post;
use MoonShine\Handlers\ExportHandler;
use MoonShine\Resources\ModelResource;
 
class PostResource extends ModelResource
{
    protected string $model = Post::class;
 
    protected string $title = 'Posts';
 
    //...
 
    public function export(): ?ExportHandler
    {
        return ExportHandler::make('Export');
    }
 
    //...
}

Методы ExportHandler

Доступны необязательные методы для настройки экспорта:

use MoonShine\Handlers\ExportHandler;
 
//...
 
public function export(): ?ExportHandler
{
    return ExportHandler::make('Export')
        // Указать ID пользователей, которые получат уведомление об окончании операции
        ->notifyUsers(fn() => [auth()->id()])
        // Выбор диска
        ->disk('public')
        // Имя файла
        ->filename(sprintf('export_%s', date('Ymd-His')))
        // Выбор директории для сохранения файла экспорта
        ->dir('/exports')
        // Если нужно экспортировать в формате csv
        ->csv()
        // Разделитель для csv
        ->delimiter(',')
        // Экспорт с подтверждением
        ->withConfirm();
}
 
//...
use MoonShine\Handlers\ExportHandler;
 
//...
 
public function export(): ?ExportHandler
{
    return ExportHandler::make('Export')
        // Указать ID пользователей, которые получат уведомление об окончании операции
        ->notifyUsers(fn() => [auth()->id()])
        // Выбор диска
        ->disk('public')
        // Имя файла
        ->filename(sprintf('export_%s', date('Ymd-His')))
        // Выбор директории для сохранения файла экспорта
        ->dir('/exports')
        // Если нужно экспортировать в формате csv
        ->csv()
        // Разделитель для csv
        ->delimiter(',')
        // Экспорт с подтверждением
        ->withConfirm();
}
 
//...

Если метод export() возвращает NULL, то кнопка экспорта не появится на странице индекса.

Методы обработчиков

ImportHandler и ExportHandler расширяют базовый класс Handler, который реализует дополнительные методы.

icon

// иконка для кнопки
icon(string $icon)
// иконка для кнопки
icon(string $icon)

queue

// запуск процессов в фоновом режиме
queue()
// запуск процессов в фоновом режиме
queue()

when

// условные методы
when($value = null, callable $callback = null, callable $default = null)
// условные методы
when($value = null, callable $callback = null, callable $default = null)

$value - условие,
$callback - функция обратного вызова, которая будет выполнена, если условие истинно TRUE,
$default - функция обратного вызова, которая будет выполнена, если условие ложно FALSE.

use MoonShine\Handlers\ImportHandler;
 
//...
 
public function import(): ?ImportHandler
{
    return ImportHandler::make('Import')
        ->when(
            true,
            fn($handler) => $handler->delimiter(','),
            fn($handler) => $handler->delimiter(';')
        );
}
 
//...
use MoonShine\Handlers\ImportHandler;
 
//...
 
public function import(): ?ImportHandler
{
    return ImportHandler::make('Import')
        ->when(
            true,
            fn($handler) => $handler->delimiter(','),
            fn($handler) => $handler->delimiter(';')
        );
}
 
//...

unless

// условные методы
unless($value = null, callable $callback = null, callable $default = null)
// условные методы
unless($value = null, callable $callback = null, callable $default = null)

$value - условие,
$callback - функция обратного вызова, которая будет выполнена, если условие ложно FALSE,
$default - функция обратного вызова, которая будет выполнена, если условие истинно TRUE.

Метод unless() является обратным методу when().

Пользовательская реализация

Может возникнуть ситуация, когда вы хотите изменить реализацию импорта или экспорта. Для этого необходимо реализовать собственный класс, расширяющий ImportHandler или ExportHandler.

Класс можно сгенерировать с помощью консольной команды:

php artisan moonshine:handler
php artisan moonshine:handler

После выполнения команды в директории app/MoonShine/Handlers будет создан базовый класс обработчика.