【Laravel】return で複数の変数を返せない。

Question

問題

複数の変数をreturnで返せない。

return [$posts, $lgtm_min, $lgtm_max];

エラー

ErrorException
compact(): Undefined variable: posts

どこか、returnの記述方法を間違えているようなのですが、それがわかりません。

試した例

return $posts, $lgtm_min, $lgtm_max;
return [$posts, $lgtm_min, $lgtm_max];
return array($posts, $lgtm_min, $lgtm_max);
return compact($posts, $lgtm_min, $lgtm_max);

詳細

fat controller解消のために、PostController.phpの絞り込み検索を分離させた。
（DetailedSearch.phpに処理を移行）

作成したDetailedSearch.phpは下記になる。
app/Services/DetailedSearch.php

<?php

namespace App\Services;

use Illuminate\Support\Facades\DB;

class DetailedSearch
{
  public static function DetailedSearch($query, $lgtm_min, $lgtm_max, $order)
  {
    //LGTM sum search
    if ($lgtm_min !== null) {
      $query->having('likes_count', '>=', $lgtm_min);
    }
    if ($lgtm_max !== null) {
      $query->having('likes_count', '<=', $lgtm_max);
    }

    if ($order == 'new') {
      $posts = $query->orderBy('posts.created_at', 'desc')->paginate(20);
    } else {
      $posts = $query->orderBy('likes_count', 'desc')->paginate(20);
    }


    return [$posts, $lgtm_min, $lgtm_max];
  }
}

このDetailedSearchをPostController.phpで利用し、結果の値を取得する。

DetailedSearch::DetailedSearch($query, $lgtm_min, $lgtm_max);が実際に利用した箇所です。

<?php

namespace App\Http\Controllers;

use App\Models\post;
use App\Models\tag;
use Illuminate\Http\Request;
use Illuminate\Support\Facades\Auth;
use Illuminate\Support\Facades\DB;
use App\Services\DetailedSearch;

class PostController extends Controller
{

public function my_posts(Request $request)
    {
        // values
        $lgtm_min = $request->input('lgtm-min');
        $lgtm_max = $request->input('lgtm-max');

        // query
        $query = Post::where("posts.user_id", "=", Auth::user()->id)->withCount('likes');

        //絞り込み処理
        DetailedSearch::DetailedSearch($query, $lgtm_min, $lgtm_max);

　　　　 //エラー：compact(): Undefined variable: posts
        return view('posts.my_posts', compact('posts', 'all_posts_count', 'keyword', 'order', 'lgtm_min', 'lgtm_max'));
    }

これで$postsを取得できると思ったが、結果はエラーが表示された。

下記が実際のエラーメッセージ

ErrorException
compact(): Undefined variable: posts

問題の絞り込み

$postsを定義できていないエラーのため、DetailedSearch.phpが失敗していることがわかる。

そこで、dd（$posts);を記述し、$postsが定義しているか？値を取得できているか確認した。

<?php

namespace App\Services;

use Illuminate\Support\Facades\DB;

class DetailedSearch
{
  public static function DetailedSearch($query, $lgtm_min, $lgtm_max, $order)
  {
    //LGTM sum search
    if ($lgtm_min !== null) {
      $query->having('likes_count', '>=', $lgtm_min);
    }
    if ($lgtm_max !== null) {
      $query->having('likes_count', '<=', $lgtm_max);
    }

    if ($order == 'new') {
      $posts = $query->orderBy('posts.created_at', 'desc')->paginate(20);
    } else {
      $posts = $query->orderBy('likes_count', 'desc')->paginate(20);
    }

   //ddを追加

    dd($posts);
    return [$posts, $lgtm_min, $lgtm_max];
  }
}

dd($posts)の結果、配列を取得できていることがわかる。

このことから、DetailedSearch.phpのreturn直前まで値を取得できているとわかった。

今度は,PostController.php側でdd($posts)を追加

DetailedSearch::DetailedSearch($query, $lgtm_min, $lgtm_max, $order);

// 追加
dd($posts);
return view('posts.my_posts', compact('posts', 'lgtm_min', 'lgtm_max'));

するとdd($posts)の箇所でエラーが表示された。

ErrorException
Undefined variable: posts

これらのことから、

DetailedSearch.phpのreturn [$posts, $lgtm_min, $lgtm_max];の記述に問題があるとわかった。

そこで、いくつかreturnについての記事を参考にしましたが、解決に至ってません。
https://www.php.net/manual/ja/language.references.return.php
https://qiita.com/tatsuo-iriyama/items/b0c2dda4426e42d8bc78

お忙しいと思いますが、ご教授のほどよろしくお願いします。

Answer 1

返り値を受け取ってないだけ。

list($posts, $lgtm_min, $lgtm_max) = DetailedSearch::DetailedSearch($query, $lgtm_min, $lgtm_max);

それよりもDetailedSearch()をstaticで書いてるほうが後で困る。
Laravelを知らない人が一番間違える所。

DBの処理するような部分はstaticメソッドで書かない。

サービスクラスに分離した時はこう使う。
（そもそも$query = Post::where…もDetailedSearch内に入れたほうがいいけど）

public function my_posts(Request $request, DetailedSearch $search)
{
    list($posts, $lgtm_min, $lgtm_max) = $search->DetailedSearch($query, $lgtm_min, $lgtm_max);
}

これの何が便利なのかはテストを書かないと理解できない。
DBを使う箇所を全部モックして無視できる。
Laravelのほとんどの機能はテストのためと言っても過言ではないのでとにかくテストを書かないとLaravelは理解できない。

Comments

[gyu]

無事できました！恥ずかしいほどに基本的な内容でした
ありがとうございました！！

Answer 2

赤枠の中に $posts がないのでエラーになってます。

Comments

[gyu]

わかりやすくありがとうございます！

Answer 3

DetailedSearch::DetailedSearch($query, $lgtm_min, $lgtm_max, $order);を呼んだのに、返り値を受け取っていないので、ただ捨てられています。

Comments

[maisumakun]

DetailedSearch::DetailedSearchの中の問題ではなく、「呼ぶ側」の問題です。

[gyu]

本当ですね！
いやーお恥ずかしい
ありがとうございました！！