laravel5.5のauth認証の条件拡張

Question

前提・実現したいこと

laravel5.5のauth認証の条件拡張をしたいです。
delete_flg = 0
start_date > today

この条件を追加したいのですが、start_dateの比較演算子を ＝ から ＞ に変更することが出来ません。
どこを修正すればよろしいでしょうか。

該当のソースコード

     protected function credentials(Request $request)
     {
         return array_merge($request->only($this->username(), 'password'), ['delete_flg' => '0','start_date' => Carbon::today()]);
     }

Comments

[m.ts10806]

私が不勉強なだけかもしれませんが、提示のコードだけではauthの機能を使っているようには見受けられません。
もう少し全体の流れが分かるコードとしてご提示いただけませんか？

Answer 1

それが使われるのは\Illuminate\Auth\EloquentUserProvider::retrieveByCredentialsですが、処理が以下のようになっていて$query->where($key, $value);の形で条件を設定するだけなので、このままでは=の条件でしか設定できません。

    /**
     * Retrieve a user by the given credentials.
     *
     * @param  array  $credentials
     * @return \Illuminate\Contracts\Auth\Authenticatable|null
     */
    public function retrieveByCredentials(array $credentials)
    {
        if (empty($credentials) ||
           (count($credentials) === 1 &&
            array_key_exists('password', $credentials))) {
            return;
        }

        // First we will add each credential element to the query as a where clause.
        // Then we can execute the query and, if we found a user, return it in a
        // Eloquent User "model" that will be utilized by the Guard instances.
        $query = $this->createModel()->newQuery();

        foreach ($credentials as $key => $value) {
            if (! Str::contains($key, 'password')) {
                $query->where($key, $value); // ←この部分
            }
        }

        return $query->first();
    }

従って、EloquentUserProviderをもとにカスタムユーザープロバイダを作成してそれを使うようにするのが正攻法だと思います。EloquentUserProviderを継承したクラスでretrieveByCredentialsを置き換えるぐらいで作成できるでしょう。

また、他の部分にも影響するのでここだけの問題ではなくなりますが、start_dateについての条件をグローバルスコープで設定してしまう方法もあると思います。

Answer 2

認証のカスタムガードを作成すると良いです。
EloquentUserProviderを継承して、retrieveByCredentialsをオーバーライドします。
Laravel 5.8 認証 カスタムガードの追加

以下の質問を参考にしてください。
Laravel での認証処理のカスタマイズについて。

Answer 3

解決済みですが，気軽に導入できるパッケージを作成したので宣伝がてら投稿します。

mpyw/scoped-auth: Apply specific scope for user authentication.

<?php

namespace App;

use Illuminate\Auth\Authenticatable;
use Illuminate\Contracts\Auth\Authenticatable as UserContract;
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Database\Eloquent\Model;
use Mpyw\ScopedAuth\AuthScopable;

class User extends Model implements UserContract, AuthScopable
{
    use Authenticatable;

    public function scopeForAuthentication(Builder $query): Builder
    {
        return $query
            ->where('start_date', '>', Carbon::today())
            ->where('delete_flg', '=', 0);
    }
}

Comments

[mpyw]

注意: 5.8 以上（ EloquentUserProvider が 5.7→5.8 でリファクタリングされているため）

[退会済みユーザー]

ここで＋１するより、スターつけたほうがいいですよね。

[mpyw]

ありがとうございますｗ