[액션.내장된액션] CreateAction

개요

Filament에는 Eloquent 레코드를 생성할 수 있는 미리 만들어진 액션이 포함되어 있습니다. 트리거 버튼을 클릭하면 모달이 열리고 그 안에 폼이 표시됩니다. 사용자가 폼을 작성하면 해당 데이터가 검증되어 데이터베이스에 저장됩니다. 다음과 같이 사용할 수 있습니다:

use Filament\Actions\CreateAction;
use Filament\Forms\Components\TextInput;

CreateAction::make()
    ->model(Post::class)
    ->form([
        TextInput::make('title')
            ->required()
            ->maxLength(255),
        // ...
    ])

이 액션을 테이블의 헤더에 추가하고 싶다면, Filament\Tables\Actions\CreateAction을 사용할 수 있습니다:

use Filament\Forms\Components\TextInput;
use Filament\Tables\Actions\CreateAction;
use Filament\Tables\Table;

public function table(Table $table): Table
{
    return $table
        ->headerActions([
            CreateAction::make()
                ->form([
                    TextInput::make('title')
                        ->required()
                        ->maxLength(255),
                    // ...
                ]),
        ]);
}

저장 전 데이터 커스터마이징

때때로, 데이터가 데이터베이스에 최종적으로 저장되기 전에 폼 데이터를 수정하고 싶을 수 있습니다. 이를 위해 mutateFormDataUsing() 메서드를 사용할 수 있으며, 이 메서드는 배열 형태의 $data에 접근하여 수정된 버전을 반환합니다:

CreateAction::make()
    ->mutateFormDataUsing(function (array $data): array {
        $data['user_id'] = auth()->id();

        return $data;
    })

생성 프로세스 커스터마이징

레코드가 생성되는 방식을 using() 메서드로 조정할 수 있습니다:

use Illuminate\Database\Eloquent\Model;

CreateAction::make()
    ->using(function (array $data, string $model): Model {
        return $model::create($data);
    })

$model은 모델의 클래스 이름이지만, 원한다면 직접 하드코딩한 클래스로 대체할 수 있습니다.

생성 후 리다이렉트

폼이 제출될 때 커스텀 리다이렉트를 설정하려면 successRedirectUrl() 메서드를 사용할 수 있습니다:

CreateAction::make()
    ->successRedirectUrl(route('posts.list'))

생성된 레코드를 사용하여 리다이렉트하고 싶다면, $record 파라미터를 사용하세요:

use Illuminate\Database\Eloquent\Model;

CreateAction::make()
    ->successRedirectUrl(fn (Model $record): string => route('posts.edit', [
        'post' => $record,
    ]))

저장 알림 커스터마이징

레코드가 성공적으로 생성되면, 사용자에게 해당 작업의 성공을 알리는 알림이 전송됩니다.

이 알림의 제목을 커스터마이징하려면 successNotificationTitle() 메서드를 사용하세요:

CreateAction::make()
    ->successNotificationTitle('사용자 등록 완료')

전체 알림을 커스터마이징하려면 successNotification() 메서드를 사용하세요:

use Filament\Notifications\Notification;

CreateAction::make()
    ->successNotification(
       Notification::make()
            ->success()
            ->title('사용자 등록 완료')
            ->body('사용자가 성공적으로 생성되었습니다.'),
    )

알림을 완전히 비활성화하려면 successNotification(null) 메서드를 사용하세요:

CreateAction::make()
    ->successNotification(null)

라이프사이클 훅

훅을 사용하여 액션의 라이프사이클 내 여러 시점에 코드를 실행할 수 있습니다. 예를 들어, 폼이 저장되기 전에 실행할 수 있습니다.

사용 가능한 여러 훅이 있습니다:

CreateAction::make()
    ->beforeFormFilled(function () {
        // 폼 필드가 기본값으로 채워지기 전에 실행됩니다.
    })
    ->afterFormFilled(function () {
        // 폼 필드가 기본값으로 채워진 후에 실행됩니다.
    })
    ->beforeFormValidated(function () {
        // 폼이 제출될 때 폼 필드가 검증되기 전에 실행됩니다.
    })
    ->afterFormValidated(function () {
        // 폼이 제출될 때 폼 필드가 검증된 후에 실행됩니다.
    })
    ->before(function () {
        // 폼 필드가 데이터베이스에 저장되기 전에 실행됩니다.
    })
    ->after(function () {
        // 폼 필드가 데이터베이스에 저장된 후에 실행됩니다.
    })

생성 프로세스 중단

언제든지 라이프사이클 훅이나 변환 메서드 내부에서 $action->halt()를 호출하여 전체 생성 프로세스를 중단할 수 있습니다:

use App\Models\Post;
use Filament\Notifications\Actions\Action;
use Filament\Notifications\Notification;

CreateAction::make()
    ->before(function (CreateAction $action, Post $record) {
        if (! $record->team->subscribed()) {
            Notification::make()
                ->warning()
                ->title('활성화된 구독이 없습니다!')
                ->body('계속하려면 요금제를 선택하세요.')
                ->persistent()
                ->actions([
                    Action::make('subscribe')
                        ->button()
                        ->url(route('subscribe'), shouldOpenInNewTab: true),
                ])
                ->send();
        
            $action->halt();
        }
    })

액션 모달도 함께 닫고 싶다면, 중단하는 대신 액션을 완전히 cancel()할 수 있습니다:

$action->cancel();

마법사 사용하기

생성 프로세스를 다단계 마법사로 쉽게 변환할 수 있습니다. form() 대신, steps() 배열을 정의하고 Step 객체를 전달하세요:

use Filament\Forms\Components\MarkdownEditor;
use Filament\Forms\Components\TextInput;
use Filament\Forms\Components\Toggle;
use Filament\Forms\Components\Wizard\Step;

CreateAction::make()
    ->steps([
        Step::make('Name')
            ->description('카테고리에 고유한 이름을 지정하세요')
            ->schema([
                TextInput::make('name')
                    ->required()
                    ->live()
                    ->afterStateUpdated(fn ($state, callable $set) => $set('slug', Str::slug($state))),
                TextInput::make('slug')
                    ->disabled()
                    ->required()
                    ->unique(Category::class, 'slug'),
            ])
            ->columns(2),
        Step::make('Description')
            ->description('추가 세부 정보를 입력하세요')
            ->schema([
                MarkdownEditor::make('description'),
            ]),
        Step::make('Visibility')
            ->description('누가 볼 수 있는지 제어하세요')
            ->schema([
                Toggle::make('is_visible')
                    ->label('고객에게 표시됩니다.')
                    ->default(true),
            ]),
    ])

이제 새 레코드를 생성하여 마법사를 직접 확인해보세요! 편집은 여전히 리소스 클래스 내에 정의된 폼을 사용합니다.

모든 단계를 건너뛸 수 있도록 자유로운 이동을 허용하려면, skippableSteps() 메서드를 사용하세요:

CreateAction::make()
    ->steps([
        // ...
    ])
    ->skippableSteps()

"다시 생성" 비활성화

모달에서 "다시 생성" 버튼을 제거하고 싶다면, createAnother(false) 메서드를 사용할 수 있습니다:

CreateAction::make()
    ->createAnother(false)