恢复操作

简介

Filament 包含一个能够恢复软删除的 Eloquent 记录的操作。当触发按钮被点击时，会打开一个模态框要求用户确认。你可以像这样使用它：

use Filament\Actions\RestoreAction;

// 创建一个恢复操作，用于恢复软删除的记录
// 点击后会显示确认模态框，用户确认后才会执行恢复
// 恢复后记录会重新出现在查询结果中
RestoreAction::make()

或者如果你想将其添加为表格批量操作，让用户可以选择要恢复哪些行，可以使用 Filament\Actions\RestoreBulkAction：

use Filament\Actions\RestoreBulkAction;
use Filament\Tables\Table;

// 在表格工具栏中添加批量恢复操作
// 用户可以勾选多行，然后一次性恢复选中的所有软删除记录
public function table(Table $table): Table
{
    return $table
        ->toolbarActions([
            // 批量恢复操作会显示在表格顶部的工具栏中
            RestoreBulkAction::make(),
        ]);
}

恢复后重定向

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

use Filament\Actions\RestoreAction;

// 设置恢复成功后的重定向 URL
// 用户确认恢复后会被重定向到文章列表页面
RestoreAction::make()
    ->successRedirectUrl(route('posts.list'))

除了 $record，successRedirectUrl() 函数还可以注入各种工具作为参数。

自定义恢复通知

当记录成功恢复时，会向用户发送一条通知，表示操作成功。

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

use Filament\Actions\RestoreAction;

// 自定义恢复成功通知的标题
RestoreAction::make()
    ->successNotificationTitle('User restored')  // 设置通知标题为 "User restored"

除了允许静态值，successNotificationTitle() 方法还接受一个函数来动态计算。你可以向该函数注入各种工具作为参数。

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

use Filament\Actions\RestoreAction;
use Filament\Notifications\Notification;

// 完全自定义成功通知的外观和内容
RestoreAction::make()
    ->successNotification(
       Notification::make()
            ->success()  // 设置通知类型为成功（绿色）
            ->title('User restored')  // 通知标题
            ->body('The user has been restored successfully.'),  // 通知正文内容
    )

除了允许静态值，successNotification() 方法还接受一个函数来动态计算。你可以向该函数注入各种工具作为参数。

要完全禁用通知，请使用 successNotification(null) 方法：

use Filament\Actions\RestoreAction;

// 完全禁用成功通知
// 用户恢复记录后不会看到任何通知消息
RestoreAction::make()
    ->successNotification(null)

生命周期钩子

你可以使用 before() 和 after() 方法在记录恢复前后执行代码：

use Filament\Actions\RestoreAction;

// 生命周期钩子允许你在恢复操作的不同阶段执行自定义代码
RestoreAction::make()
    ->before(function () {
        // 在记录恢复之前运行
        // 可以用于检查权限、记录日志或执行前置操作
    })
    ->after(function () {
        // 在记录恢复之后运行
        // 可以用于清理关联数据、发送通知或触发后续操作
    })

这些钩子函数可以注入各种工具作为参数。

提高批量恢复操作的性能

默认情况下，RestoreBulkAction 会将所有 Eloquent 记录加载到内存中，然后逐个循环恢复。

如果你要恢复大量记录，你可能需要使用 chunkSelectedRecords() 方法每次获取较少数量的记录。这将减少应用程序的内存使用：

use Filament\Actions\RestoreBulkAction;

// 使用 chunkSelectedRecords() 分批处理大量记录
// 每次只从数据库加载 250 条记录到内存，减少内存占用
// 适用于需要恢复成千上万条记录的场景
RestoreBulkAction::make()
    ->chunkSelectedRecords(250)  // 每批处理 250 条记录

Filament 在恢复记录前将 Eloquent 记录加载到内存中有两个原因：

• 允许在恢复前使用模型策略对集合中的单个记录进行授权（例如使用 authorizeIndividualRecords('restore')）。
• 确保在恢复记录时运行模型事件，例如模型观察者中的 restoring 和 restored 事件。

如果你不需要单个记录的策略授权和模型事件，可以使用 fetchSelectedRecords(false) 方法，该方法不会在恢复前将记录获取到内存中，而是通过单个查询直接恢复：

use Filament\Actions\RestoreBulkAction;

// 使用 fetchSelectedRecords(false) 直接恢复，不加载记录到内存
// 这会跳过单个记录的策略授权检查和模型事件
// 适用于不需要这些功能且需要最高性能的场景
RestoreBulkAction::make()
    ->fetchSelectedRecords(false)  // 禁用记录预加载，直接恢复