How to order by using appended attribute in Larave

Question

I created an appends attribute in Laravel Model, from the code below.

    protected $appends = array('total'=>'');

And I set the returned value.

    public function getTotalAttribute(){
           return ProductPart::where('product_id',$this->id)->count();
    }

Then I want to order records from database by using total attribute

I tried to use Product::orderBy('total','desc')->get() but it didn't work.

Does anybody has some suggestions to this?

Answer 1

As mentioned, the proposed solution using a sortBy() callback does not work with paging.
Here is an alternative to the accepted solution:

orderByRaw()

If the appended attributes can be calculated from the fields in your query you can instead use orderByRaw(), like so:

// For example, booking percentage
$query->orderByRaw('bookings_count / total_count');

Check out a more advanced example here: laravel orderByRaw() on the query builder

Answer 2

use sortBy for ASC

$collection->sortBy('field');

use sortByDesc for DESC

$collection->sortByDesc('field');

Answer 3

If working with attributes those are not always available instantly (e.g. for freshly created models).

As expansion on Ayobami Opeyemi's answer you should be able to use Collection's sortBy if you force the attribute to evaluate by calling its function directly:

$products = Product::all();
$products = $products->sortBy(function($product){
    return $product->getTotalAttribute();
});

https://laravel.com/docs/master/collections#method-sortby

Answer 4

the orderBy takes an actual database field not an appended one

try this

$products = Product::all();
$products = $products->sortBy(function($product){
    return $product->total;
});

Answer 5

You can use the sortBy method from collections.

$products = Product::all();
$products = $products->sortBy('total');