Laravel追加自定义访问器时如何传递参数？

Laravel默认的模型访问器是为自动转换属性设计的，不支持直接传递参数。以下是几个可行的解决方案：

方案一：使用普通方法替代访问器 #

直接在模型中定义一个带参数的普通方法，放弃访问器的自动追加特性（如果不需要自动加载的话）：

// 移除$appends中的leave_balances（如果不需要自动追加）
// protected $appends = ['leave_balances'];

public function getLeaveBalances($parameter) {
    // 在这里使用$parameter实现业务逻辑
    // 示例：根据参数筛选并计算余额
    return $this->leaveTransactions()->where('type', $parameter)->sum('remaining');
}

调用方式：

$payslip = Payslip::find(1);
\Log::debug($payslip->getLeaveBalances("PARAMETER"));

方案二：临时属性+访问器结合 #

如果需要保留访问器的属性访问语法，可以通过临时存储参数的方式实现：

protected $appends = ['leave_balances'];
// 定义临时属性存储参数
private $leaveBalanceParam;

// 设置参数的方法，支持链式调用
public function setLeaveBalanceParam($param) {
    $this->leaveBalanceParam = $param;
    return $this;
}

public function getLeaveBalancesAttribute() {
    // 校验参数是否存在
    if (is_null($this->leaveBalanceParam)) {
        throw new \RuntimeException('必须先设置休假余额参数');
    }
    
    // 使用临时参数执行逻辑
    return $this->computeLeaveBalance($this->leaveBalanceParam);
}

// 封装具体计算逻辑的私有方法
private function computeLeaveBalance($param) {
    // 业务逻辑实现
}

调用方式：

$payslip = Payslip::find(1);
\Log::debug($payslip->setLeaveBalanceParam("PARAMETER")->leave_balances);

方案三：查询时传入参数（适用于批量场景） #

如果需要在批量查询时为每个模型传入参数，可以结合查询闭包或自定义范围：

// 自定义查询范围
public function scopeWithLeaveBalances($query, $parameter) {
    return $query->with(['leaveTransactions' => function($q) use ($parameter) {
        $q->where('type', $parameter);
    }]);
}

调用时先预加载关联数据，再在模型中基于关联数据计算：

$payslips = Payslip::withLeaveBalances("PARAMETER")->get();
foreach ($payslips as $payslip) {
    $balance = $payslip->leaveTransactions->sum('remaining');
    \Log::debug($balance);
}

内容的提问来源于stack exchange，提问作者Taha Malik