Laravel 検索＋ページネーションのappneds()について

Question

Laravel5.5を使用しています。

写真の一覧機能の、idで検索をしてページネーションも使って表示する部分です。

idで検索して、ページネーションで2ページ目を見ても3ページ目を見てもそのidで検索した状態を保持しようと思い、実装は色々と過去の質問を見てできました。

▼こちら参考にしました。
https://teratail.com/questions/193544

実装できたのですが、どうしてそうなっているのかわからず…教えていただけると嬉しいです。

コード

検索する部分のView
補足：photoにはcat_idを保持してまして、そのcat_idで検索をさせたいと思いました。

<div class="col-sm-4" style="padding:20px 0; padding-left:0px;">
        <label>
            Cats情報
        <form class="form-inline" action="{{ route('admin.photoindex') }}">
            <div class="form-group">
                <input type="text" name="cat_id" value="{{ $catid ?? '' }}" class="form-control" placeholder="cat_id">
            </div>
            <input type="submit" value="検索" class="btn btn-apply ml-2">
        </form>
        </label>
    </div>
<!--↑↑ 検索フォーム ↑↑-->

PhotosController

 // adminのphotoページでユーザーからの写真一覧を表示する機能 検索機能で修正
    public function adminphotoindex(Request $request) {
        
        //キーワード受け取り
        $catid = $request->input('cat_id');
        if (!empty($catid)) {
            $photos = Photo::whereNotNull('user_id')->where('cat_id', $catid)->orderBy('created_at', 'desc')->paginate(3)->appends($request->except(['user_id']));
        }
        else {
            $photos = Photo::whereNotNull('user_id')->orderBy('created_at', 'desc')->paginate(3);
            
        }
        
        $users = User::all();
        $cats = Cat::all();
        
        return view('admin.photo', [
            'photos' => $photos,
            'users' => $users,
            'cats' => $cats,
            'catid' => $catid
            ]);
    }

質問

PhotosControllerで、cat_idで検索された時に、

$photos = Photo::whereNotNull('user_id')->where('cat_id', $catid)->orderBy('created_at', 'desc')->paginate(3)->appends($request->except(['user_id']));

でphotos情報を抜き出しているのですが、

->appends($request->except(['user_id']))

の部分は何をしているのでしょうか…？
上記の部分は、検索条件を保持するために加えました。

https://readouble.com/laravel/5.3/ja/pagination.html
によると、appendsメソッドは、ページネーションリンクにクエリ文字列を付け加えるものとありますが、
なぜ、

except(['user_id'])

なのかがわかりません…　うまく実装されているのですが、ご存じの方いらっしゃいましたら教えていただけると嬉しいです。
何卒、よろしくお願いいたします。

Comments

[m.ts10806]

ドキュメントで理解できない場合、フレームワークのコアソースを追っていくことになります。
どこまで調べられたのでしょう？
あと5.5を使っていながら5.3のドキュメントを参照されているようですが、それで本当に問題ないですか？

[mikeko0901]

ググってあのページにたどり着きましたが、5.3でした…
5.5見なければいけないところですよね…申し訳ございません

Answer 1

exceptは指定したものを除いて取得するメソッドです
https://readouble.com/laravel/5.5/ja/requests.html

なので、たとえば、cat_id、user_idがリクエストで送信されてきたとすると
except(['user_id'])はuser_idを除くものを取得するので、cat_idだけ取得されます。
appendsは記載の通り、クエリ文字付け足すので
cat_idの値が3だとしたら、?hoge=3のようにパラメータに付けたされます

Comments

[mikeko0901]

ありがとうございます！
渡しているのはcat_idだけなので、except で　user_idを除いても望んでいた表示になっていたのですね・・ありがとうございます。

Answer 2

わかっていないものを実装しないでください。