グローバルスコープ

Last-modified: Wed, 12 Sep 2018 17:03:49 JST (37d)

ユーザ認証するシステムでは、関連するテーブルのwhere条件に常にuser_idを付けたり、
削除フラグ条件を付けて回らないといけなかったりします。
これ地味に面倒ですよね。

そこで、laravelでは、グローバルスコープという仕組みがありまして、
指定したモデルの全クエリに条件を付けてくれる仕組みがあります。
(ただし、uniqueなどバリデーションは対象外のようです)
今回ログイン履歴参照モデルにグローバルスコープを適用する例を挙げます。

まず、グローバルスコープを適用する前のログイン履歴参照画面コントローラはこんな感じです。

    public function index()
    {
        $user = Auth::user();
        $datas = LoginHistory::query()
            ->where('user_id',$user->id)
            ->orderBy('updated_at','desc')
            ->paginate(25);

        // ビューを返す
        return view('show_history', ['datas' => $datas]);
    }

これをこうしたいわけですね。

    public function index()
    {
        $datas = LoginHistory::query()
            ->orderBy('updated_at','desc')
            ->paginate(25);

        // ビューを返す
        return view('show_history', ['datas' => $datas]);
    }

ではまず、グローバルスコープを作成します。
これは自動生成できないので、App\Scopes\AuthUserScope.phpって感じでつくります。
中身は以下のような感じです。

<?php

namespace App\Scopes;

use Illuminate\Database\Eloquent\Scope;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Support\Facades\Auth;

class AuthUserScope implements Scope
{
    /**
     * Eloquentクエリビルダへ適用するスコープ
     *
     * @param  \Illuminate\Database\Eloquent\Builder  $builder
     * @param  \Illuminate\Database\Eloquent\Model  $model
     * @return void
     */
    public function apply(Builder $builder, Model $model)
    {
        $user=Auth::user();
        $builder->where('user_id', $user->id);
    }
}

次に作成したグローバルスコープをモデルに適用します。
モデルに以下のメソッドを追加し、bootメソッドをオーバーライドします。

    /**
     * モデルの「初期起動」メソッド
     *
     * @return void
     */
    protected static function boot()
    {
        parent::boot();

        static::addGlobalScope(new AuthUserScope());
    }

これで、

where user_id = $user->id

を撤廃することができました。
なお、これを設定すると、設定したモデルで透過的に条件付けされるので、
あまり多用しないほうがいいです。大抵現場が混乱します(汗


Counter: 21, today: 3, yesterday: 0

このページの参照回数は、21です。