LaravelのEloquentにはクエリビルダでチェーンを組むための命名規則に従ったメソッド作成方法があります。scopeHogehoge()とするとModel::hogehoge()とするとクエリビルダが走ります。この状態のまま次のようにチェーンを組めるのが利点です。
1 | User::hogehoge()->orderBy('fuga')->limit(30); |
検索などでクエリの一部を使いまわしたい時などとても助かります。助かるのですが、この手法はモデルにも継承元であるEloquentにも記述されていないメソッドを呼び出しており、IDEのヘルパが効かず、警告も出力されます。次のようにコメントを記述することで対策できますが、コメントを経由して改めてscopeHogehoge()を検索する必要があります。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 | /** * @method static Builder|User newModelQuery() * @method static Builder|User newQuery() * @method static Builder|User query() * @mixin Eloquent * * @method static Builder|User Hogehoge() */class User extends Model{ public function scopeHogehoge($query) { return $query->where('なんやかんや'); }} |
クエリが増えるにつれどんどんコメント→実際の記述と追うのが面倒になりだします。自分の知る使えそうな小技は二つです。一つはコメントの長大化の弊害がありますが次のようにコメントすることです。@seeはによってIDEはジャンプができる様になります。PhpStormならCtrl+Bです。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | /** * @method static Builder|User newModelQuery() * @method static Builder|User newQuery() * @method static Builder|User query() * @mixin Eloquent * * @method static Builder|User Hogehoge() * @see \App\Models\Eloquents\User::scopeHogehoge */class User extends Model{ public function scopeHogehoge($query) { return $query->where('なんやかんや'); }} |
もう一つはstaticなクエリビルドメソッドを作ることです。Model::からクエリビルドする時はEloquentクラス中の次のメソッドが呼ばれています。これを使うことで任意のクエリをグローバルスコープ等欠けさせることなく使えます。staticなのでクエリビルド用の別クラスを用意することも簡単です。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 | class Eloquent{... /** * Begin querying the model. * * @return \Illuminate\Database\Eloquent\Builder */ public static function query() { return (new static)->newQuery(); } /** * Get a new query builder for the model's table. * * @return \Illuminate\Database\Eloquent\Builder */ public function newQuery() { return $this->registerGlobalScopes($this->newQueryWithoutScopes()); }...} |
次が例です。再利用するあてのないメソッドならあと腐れなくstaticにできます。またこのstaticメソッドでビルダーを返せば、後にクエリビルド用のメソッドチェーンを続けることもできます。
1 2 3 4 | public static function hogehoge($name){ return self::query()->whereName($name)->first();} |
