深入理解Filament-approvals中的审批流程实现-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_07172/article/details/148507147

深入理解Filament-approvals中的审批流程实现

filament-approvals 项目地址: https://gitcode.com/gh_mirrors/fi/filament-approvals

概述

Filament-approvals是一个基于Laravel框架的审批流程管理包，它通过与Laravel Process Approval包的集成，为Filament管理后台提供了强大的审批流程功能。本文将详细介绍如何在实际项目中实现一个完整的审批流程，特别是针对模型状态变更和通知发送的场景。

核心概念

审批流程组成

Filament-approvals的审批系统由几个关键部分组成：

审批流(Flow)：定义整个审批过程的框架
审批步骤(Step)：审批流程中的各个阶段
审批动作(Action)：审批过程中执行的具体操作

生命周期钩子

系统提供了重要的生命周期方法，特别是onApprovalCompleted，它会在审批流程完成时自动触发，开发者可以在此方法中实现业务逻辑。

实现审批流程

基础配置

首先需要在模型中引入必要的trait和接口：

use RingleSoft\LaravelProcessApproval\Contracts\ApprovableModel;
use RingleSoft\LaravelProcessApproval\Traits\IsApprovable;

class Incident extends Model implements ApprovableModel
{
    use IsApprovable;
    
    // 模型定义...
}

审批完成回调

实现onApprovalCompleted方法是关键，它会在所有审批步骤完成后执行：

public function onApprovalCompleted(ProcessApproval $approval): bool
{
    $this->update([
        'approved' => true,
        'status' => 'active'
    ]);
    
    // 发送通知给发起人
    $this->creator->notify(new IncidentApprovedNotification($this));
    
    return true;
}

审批流程定义

在Filament后台中，需要定义审批流程和步骤：

创建审批流程，关联到Incident模型
添加审批步骤，指定每个步骤的审批角色
设置最终步骤为自动完成，触发状态变更

常见问题解决

回调方法不触发

如果onApprovalCompleted方法没有被调用，检查以下几点：

确保模型正确实现了ApprovableModel接口
确认使用了IsApprovable trait
检查审批流程的最后一步是否设置为"完成流程"
验证ProcessApproval类的导入是否正确

状态管理最佳实践

建议采用以下模式管理审批状态：

const STATUS_PENDING = 'pending';
const STATUS_APPROVED = 'approved';
const STATUS_REJECTED = 'rejected';

// 在模型中
protected $casts = [
    'approved' => 'boolean',
    'status' => 'string'
];

高级用法

条件审批

可以在审批步骤中实现条件逻辑：

public function onApprovalCompleted(ProcessApproval $approval): bool
{
    if($this->priority === 'high') {
        $this->notifyEmergencyTeam();
    }
    
    return parent::onApprovalCompleted($approval);
}

审批历史追踪

建议添加审批历史记录：

public function onApprovalCompleted(ProcessApproval $approval): bool
{
    ApprovalHistory::create([
        'model_id' => $this->id,
        'model_type' => get_class($this),
        'action' => 'approved',
        'performed_by' => auth()->id(),
        'performed_at' => now()
    ]);
    
    return true;
}