laravelのEloquentクラスのbootメソッド

著者:杉浦

laravelのEloquentクラスのbootメソッド

 laravelはモデルの基盤をEloquentというクラスで定義しています。boot()はこのEloquentが呼び出されたときに走ることになる関数です。laravel5.6のソースコード(vendor\laravel\framework\src\Illuminate\Database\Eloquent\Model.php)には次の様にあります。

    /**
     * The "booting" method of the model.
     * モデルの「初期起動」メソッド
     *
     * @return void
     */
    protected static function boot()
    {
        static::bootTraits();
    }

    /**
     * Boot all of the bootable traits on the model.
     * モデル上の起動可能なすべてのtraitを起動します
     *
     * @return void
     */
    protected static function bootTraits()
    {
        $class = static::class;

        $booted = [];

        foreach (class_uses_recursive($class) as $trait) {
            $method = 'boot'.class_basename($trait);

            if (method_exists($class, $method) && ! in_array($method, $booted)) {
                forward_static_call([$class, $method]);

                $booted[] = $method;
            }
        }
    }

 これにある様にbootはbootTraitsを呼びだしbootTraitsは頭にbootクラス名とあるtraitのメソッドを呼び出します。bootメソッドに追記する事、bootトレイトを作ることでモデル呼び出し時に様々なことが出来ます。特に便利な使い方はグローバルスコープです。グローバルスコープは次の様に記述する事でクエリビルダを呼び出す際に必ず記述したクエリがつくというものです。

    protected static function boot()
    {
        parent::boot();
        static::addGlobalScope('auth_post', function (Builder $builder) {
            $post_key = Users::findOrFail(auth()->id())->post_key;

            $builder->where('post.primary_key', $post_key);
        });
    }

 上記のコードでは今ログインしているuserに関連するpostでwhereをかけています。ログインしているユーザに関してのみのデータを扱う、という処理は頻繁に現れます。このようなほぼ必ずするべき記述をモデルクラス内の各メソッドで何度も記述することは無駄であり、bootメソッドの利用はこれを解決します。

  • この記事いいね! (0)

著者について

杉浦 administrator