Laravelのwithとpaginateを引数として渡す

Question

Laravelの機能で、
・eacger loadしてくれるメソッドのwith
・ページネーションしてくれるメソッドのpaginate

というものがあり、大変便利ではあると思うのですが,
withやpaginateを使う、または使わないというのを引数で指定するというのはメソッドの作りとして良いのでしょうか？

例えば、
Postという投稿があるとし

投稿一覧を取得できるような以下のようなメソッドを作成するということです。

    public function getPosts($with = [], $isPaginate = false)
    {
        $posts = Post::with($with);
        
        if($isPaginate){
            $posts->paginate(10)
        }
        
        return $posts->get();
    }

このメソッドは
このように呼び出すことで

$this->getPosts(['comments'], true);

投稿とそれに紐づくコメントを取得し、ページネーションの形式で渡してくれます
また、このように呼び出すことで

$this->getPosts(['user'], true);

postしたユーザーを一緒に取得でき、
また以下で

$this->getPosts();

投稿一覧のcollectionを返してくれます。
一見便利そうなのですが、メソッドの作りとして
いかがでしょうか？

懸念するのは、
CollectionかLengthAwarePaginatorのオブジェクトを返すかわからないため、戻り値のタイプヒンティングをかけないということです。
また、
特にこのようにやっている人が見当たらなかったので不安に思い質問しました。

Answer 1

引数の値がどこからやってくるものなのかによる気がする。

とはいえ、コントローラには書かないと思います。

model に scope で実装するかな…

class Post extends Model
{
    public function scopeWithComments(Builder $builder)
    {
        return $builder->with(['comments']);
    }
}

と思ったけど、paginate() は Collection 返すから、スコープでは実装できませんね。

Comments

[renren643]

追記したんですが、comments決めうちじゃなくて動的に引数で渡したいんですよね.,,,,
当然コントローラには書かないですが,
getPostsメソッドはサービスクラスか,レポジトリクラスに記載するつもりでした。

[phper.k]

一応scopeも引数で渡すことができます。
あまり意味ないですけどね。

ただ、どうしてこのような実装をする必要があるかの方が気になります。
自分の場合、その必要があるようなシステムを開発したことがありません。

[renren643]

SPAなのですが
・投稿一覧をコメント付きで取得=>フロントにjsonで返却する際には、postでcommentsをeagerloadしつつpaginateできるようにしたい
・ Userの全員に対してバッチ処理をする際にはpaginateは不要
的な感じですかね

[phper.k]

そういう目的だったら、自分は一つにまとめるようなことはしないでしょうね。
目的ごとに関数は分けると思います。

Answer 2

そのくらいなら好きなように書けばいいけど
Buildingモデル内に書いたほうがいいのでは。

Comments

[renren643]

回答ありがとうございます。
すみません、コード修正しました。

Postモデル内に書いたほうがいいってことですよね