Laravel Eloquentで作る「いいね」数ランキングリスト

はじめに

メディア系サイトを構築している際、ユーザーや投稿をランキング形式で取得したい場合があるかと思います。
ランキングの基準を「いいね」数にしている場合投稿といいねを別テーブルにし、リレーションを設定するのが一般的だと思います。
リレーション先のいいね数をカウントしてソートします。

何が問題か？

Laravel Eloquentを用いてソートを実装する場合orderByを使用します。

ProductController.php

public function list()
    {
        $products = Product::with('likes')->orderBy(Product::CREATED_AT, 'desc')->paginate();
        return $products;
    }

orderByはテーブルのカラムを利用して（第一引数）降順・昇順（第二引数）を決定します。
そのためcount()を用いて「いいね」数を取得してもそれはカラムではないため、orderByできません。

実装

withcount()を使用します。引数に取得したいリレーションテーブル名を入れると'○○_count'というデータをカラム扱いとして取得できます。この値はカラム扱いなため、きちんとorderByできます。

ProductController.php

public function list()
    {
        $products = Product::withCount('likes')->orderBy('likes_count', 'desc')->paginate();
        return $products;
    }