Laravel Eloquentを使うときのロジック置き場所がわかりません

Question

LaravelでEloquentを使った開発をしています。

公式等のサンプルではコントローラからEloquentモデルのwhereだったりgetだったりを使っているようです。
ただ、記事や講演会で「コントローラにロジックが書かれるのは良くない」と目に耳にします。

このような場合、Eloquentモデルクラスに関数を書いて、それをコントローラから呼び出すのが良いのでしょうか？
それとも、コントローラでもEloquentモデルクラスでもない別の場所の方が良いのでしょうか？

サンプルなどでよく見る例

<?php

use App\User;

class UserController extends Controller
{
  public function showUser(){
    $users = User::all();   // これが「ロジックの流出」？
    return view('view.users')->with("users", $users);
  }
}

<?php

namespace App;

class User extends Model
{
  protected $table = "user";

  // ここに関数を書いて、叩くようにする？
  // 例えば static getAllUsers() のような関数？
}

Answer 1

例えば、１ヶ月いないに支払いをした有効なユーザーを一覧表示する機能があったとして

public function showUser()
{

    $users = User::where('status', 'active')->where('last_payment_at', '>=', Carbon::now()->subMonth());
    return view('user.show',compact("users"));
}

みたいなコードがあるとします。
また、１ヶ月いないに支払いをした有効なユーザー`にメールを送るバッチ処理があるとします

public function handle()
{
    $users = User::where('status', 'active')->where('last_payment_at', '>=', Carbon::now()->subMonth());
    foreach($users as $user) {
        // ...
    }

}

同じコードが複数の場所に散見されてしまうようになります。
このようになんども１ヶ月いないに支払いをした有効なユーザーを書くようならModelに書いてまとめた方がよいと思いますが

例示されているUser::allだけなら、コントローラから呼び出すUser::allがUser:: getAllUsersに変わるだけなので意味がないと思います

Comments

[Tatsuki-sth]

ありがとうございます。
実際はいくつかのコントローラから同一の処理を呼ぶことが予測されていましたが、例示のために背景を省いた簡潔な処理を書きました。

後々リファクタリングする可能性もありますが、一旦はモデルに処理を詰め込んでいこうと思います。

[mikkame]

流れとしてはコントローラー肥大化しすぎ（FatController）→モデルに詰め込む→モデル肥大化しすぎ→（FatModel）→サービス層を作ろう！
って流れなんですけど、量が多くなければ適当に書いていいと思います

Answer 2

要件次第です。
なんでもかんでもコントローラに書くのは良くないですが、なんでもかんでもモデルに書くのもよくありません。
デフォルト機能だけで済むならわざわざラップする必要ないでしょうし。

そもそも、その講演会ではなんの前提や例もなく「良くない」と言っていたのでしょうか。

「ロジック」と言っても一概にこれと言えない部分があります。

なので「要件次第」
または「プロジェクトのルール次第」

実装は統一されたほうが良いので、もし今ないならルールを整備するところからでしょうか。

Comments

[Tatsuki-sth]

なるほど、ありがとうございます。

ルールを決めるとは言うものの、ある程度スタンダードな様式や、ベストプラクティス的なものがあるのかと思いこの質問をしました。
実際のところ、私が回答で書いたようなモデルに関数を書くといったことはよくあるのでしょうか？

[m.ts10806]

んー。
どのようにも書けるのでしたらひとつのことを実現するためにとれる手段はひとつのではないので、
そういった意味ではプログラミングの世界って「ベストプラクティス」って存在しないと思って良いです。
回答序盤に書いた通り、もしデフォルトの機能だけで済むならわざわざラップした別機能を自ら準備する必要はないと考えます。
htmlspecialcharsのように「長いから短縮したい」という要件でもあれば別でしょうけど。