Laravel function 取 Model id vs function 取 Model 本身

Question

I want to know what should be the best approach to make function:

function get_total_payment($payment_id){
   return PaymentModel::where('payment_id', $payment_id )->sum('amount');
}

function get_total_payment($payments){
    return $payments->sum('amount');
}

what I think is the second approch is save us when refactoring code.

both work but I want to know the pros and cons

Answer 1

In my opinion, I think it's better to use eloquent scopes to make the total work on many different situations. see the examples below:

function scopeGetTotalPayment($query){
     $query->sum('amount')
}

now you can Implement it for different situations. see the examples below:

//get the total amount of payments for the whole payments in the table
$totalPayment = PaymentModel::getTotalPayment();

//get the total payments for a specific user 
$totalPayment = PaymentModel::where('user_id', $userId)->getTotalPayment();
 

In the end, it depends on you. you can either use the scopes or stick with the normal sum. I think that the added value of using the scope in your case is only for making the name clear and to make it work for a specific column.

read more about eloquent scopes: https://laravel.com/docs/9.x/eloquent#query-scopes