Replicate action

#概述

Filament 包含一个可以复制 Eloquent 记录的预制 Action。你可以这样使用：

use Filament\Actions\ReplicateAction;
 
ReplicateAction::make()
    ->record($this->post)
use Filament\Actions\ReplicateAction;

ReplicateAction::make()
    ->record($this->post)

如果你想复制表格行记录，请使用 Filament\Tables\Actions\ReplicateAction 替换：

use Filament\Tables\Actions\ReplicateAction;
use Filament\Tables\Table;
 
public function table(Table $table): Table
{
    return $table
        ->actions([
            ReplicateAction::make(),
            // ...
        ]);
}
use Filament\Tables\Actions\ReplicateAction;
use Filament\Tables\Table;

public function table(Table $table): Table
{
    return $table
        ->actions([
            ReplicateAction::make(),
            // ...
        ]);
}

#排除属性

excludeAttributes() 方法用于告知 Action 复制记录时，应该排除哪些字段：

ReplicateAction::make()
    ->excludeAttributes(['slug'])
ReplicateAction::make()
    ->excludeAttributes(['slug'])

#填充到表单前自定义数据

如果你想要在数据填充到表单前，对数据进行修改；你可以使用 mutateRecordDataUsing() 方法，修改 $data 数组，并且返回其填充到表单前修改的版本：

ReplicateAction::make()
    ->mutateRecordDataUsing(function (array $data): array {
        $data['user_id'] = auth()->id();
 
        return $data;
    })
ReplicateAction::make()
    ->mutateRecordDataUsing(function (array $data): array {
        $data['user_id'] = auth()->id();

        return $data;
    })

#复制后重定向

使用 successRedirectUrl() 方法中，你可以对表单提交后的重定向进行自定义设置：

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

如果你想要使用复制后的记录进行重定向，请使用 $record 参数：

use Illuminate\Database\Eloquent\Model;
 
ReplicateAction::make()
    ->successRedirectUrl(fn (Model $replica): string => route('posts.edit', [
        'post' => $replica,
    ]))
use Illuminate\Database\Eloquent\Model;

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

#自定义复制通知

记录复制成功后，会发送一个通知给用户，说明操作成功：

要自定义通知标题，请使用 successNotificationTitle() 方法：

ReplicateAction::make()
    ->successNotificationTitle('Category replicated')
ReplicateAction::make()
    ->successNotificationTitle('Category replicated')

使用 successNotification() 方法，你可以自定义整个通知：

use Filament\Notifications\Notification;
 
ReplicateAction::make()
    ->successNotification(
       Notification::make()
            ->success()
            ->title('Category replicated')
            ->body('The category has been replicated successfully.'),
    )
use Filament\Notifications\Notification;

ReplicateAction::make()
    ->successNotification(
       Notification::make()
            ->success()
            ->title('Category replicated')
            ->body('The category has been replicated successfully.'),
    )

#生命周期钩子

钩子可用在 Action 生命周期的各种节点中执行代码，比如表单数据保存之前。

use Illuminate\Database\Eloquent\Model;
 
ReplicateAction::make()
    ->before(function () {
        // Runs before the record has been replicated.
    })
    ->beforeReplicaSaved(function (Model $replica): void {
        // Runs after the record has been replicated but before it is saved to the database.
    })
    ->after(function (Model $replica): void {
        // Runs after the replica has been saved to the database.
    })
use Illuminate\Database\Eloquent\Model;

ReplicateAction::make()
    ->before(function () {
        // Runs before the record has been replicated.
    })
    ->beforeReplicaSaved(function (Model $replica): void {
        // Runs after the record has been replicated but before it is saved to the database.
    })
    ->after(function (Model $replica): void {
        // Runs after the replica has been saved to the database.
    })

#中断复制处理过程

在任何时候，你都可以在生命周期钩子或者 mutation 方法中，调用 $action->halt()，中断整个复制处理过程：

use Filament\Notifications\Actions\Action;
use Filament\Notifications\Notification;
 
ReplicateAction::make()
    ->before(function (ReplicateAction $action) {
        if (! $this->record->team->subscribed()) {
            Notification::make()
                ->warning()
                ->title('You don\'t have an active subscription!')
                ->body('Choose a plan to continue.')
                ->persistent()
                ->actions([
                    Action::make('subscribe')
                        ->button()
                        ->url(route('subscribe'), shouldOpenInNewTab: true),
                ])
                ->send();
        
            $action->halt();
        }
    })
use Filament\Notifications\Actions\Action;
use Filament\Notifications\Notification;

ReplicateAction::make()
    ->before(function (ReplicateAction $action) {
        if (! $this->record->team->subscribed()) {
            Notification::make()
                ->warning()
                ->title('You don\'t have an active subscription!')
                ->body('Choose a plan to continue.')
                ->persistent()
                ->actions([
                    Action::make('subscribe')
                        ->button()
                        ->url(route('subscribe'), shouldOpenInNewTab: true),
                ])
                ->send();
        
            $action->halt();
        }
    })

如果你想同时关闭 Action 模态框，你可以使用 cancel() 完全取消该 Action：

$action->cancel();
$action->cancel();

Edit on GitHub

Still need help? Join our Discord community or open a GitHub discussion