Laravel での認証処理のカスタマイズについて。

Question

Laravel 5.6 にて認証処理をカスタマイズしております。

users テーブルにて、status という状態の項目を追加し、
１、または、４の場合のみログイン可能としたいと思っています。

以下の様にオーバーライドしておりますが、
statusはどの様に記述すれば良いでしょうか？

    protected function credentials(Request $request)
    {
        $credentials = $request->only($this->username(), 'password');
        $credentials['status'] = 1; // 状態ステータス有効のみログイン可能　1 or 4 
                                    // 4のor 条件はどの様に追加しますか？
        return $credentials;

    }

Answer 1

いろいろ方法はありますが，標準の Auth::attempt() を使う方法に乗るのであれば，UserProvider を自分で実装する方法が一番きれいなのでお勧めしておきます。

• 方法: 認証 6.0 Laravel
• 継承するデフォルト実装: auth/EloquentUserProvider.php

LoginController::credentials() をオーバーライドした上でこちらも実装してください。

• HTTP リクエストからクレデンシャル配列を取り出す責務 → LoginController::credentials()
• クレデンシャル配列を使ってデータベースから取ってきてユーザオブジェクトまたはNULLを返す責務 → UserProvider::retrieveByCredentials(array $credentials)

実装例 （PHP7.1以降向け）

<?php

declare(strict_types=1);

namespace App\Auth;

use Illuminate\Auth\EloquentUserProivder;
use Illuminate\Contracts\Auth\Authenticatable;

class StatusAwareEloquentUserProvider extends EloquentUserProivder
{
    public function retrieveByCredentials(array $credentials): ?Authenticatable
    {
        if (!isset($credentials['email'])) return null;

        return $this->newModelQuery()
            ->whereEmail($credentials['email'])
            ->whereIn('status', [1, 4])
            ->first();
    }
}

<?php

declare(strict_types=1);

namespace App\Providers;

use App\Auth\AppUserProvider;
use Illuminate\Support\Facades\Auth;
use Illuminate\Foundation\Application;
use Illuminate\Foundation\Support\Providers\AuthServiceProvider as ServiceProvider;

class AuthServiceProvider extends ServiceProvider
{
    public function boot(): void
    {
        $this->registerPolicies();

        Auth::provider('status_aware_eloquent', function (Application $app, array $config) {
            return new StatusAwareEloquentUserProvider($app['hash'], $config['model']);
        });
    }
}

    'providers' => [
        'users' => [
            'driver' => 'status_aware_eloquent',
            'model' => App\User::class,
        ],
    ],

Comments

[hrsi_teratail]

すいません、単純でいいのですが、credentialsの中で処理を判定させたいのですが、可能でしょうか？

$credentials['status'] = 1or 4;

のようなイメージです。

[mpyw]

それが不可能なのでこの回答をさせていただいたまでです。

Answer 2

以下のメソッドをオーバライドしました。

    public function login(Request $request)
    {
        // 入力のバリデーション
        $this->validateLogin($request);

        // ログインに何回も失敗するとログインできなくなる仕組み
        if ($this->hasTooManyLoginAttempts($request)) {
            $this->fireLockoutEvent($request);

            return $this->sendLockoutResponse($request);
        }

         // 実際のログインのチェック
        if ($this->attemptLogin($request)) {


            // この時点でログイン済みユーザの情報はAuthで保持されているが、
            // リクエストインスタンスには存在しない

//0:準備中、1:運用中、2:停止、3:解約、4:トライアル

            $status = Auth::guard('clinic')->user()->status;

            if ($status == 1 || $status == 4) {
            //dd('ログイン成功', $status);

    
            } else {
           //dd('ログイン失敗', $status);
                
                $this->logout($request);


                // return redirect()->back()
                //     ->withInput()
                //     ->with('alert', 'アカウントが有効になっていません。確認メール中のリンクをクリックし、有効にしてください。');


                // ログイン失敗、なので試行回数をインクリメント
                $this->incrementLoginAttempts($request);

                // ログイン失敗のレスポンス生成
                return $this->sendFailedLoginResponse($request);

            }


            // ログイン成功、以下はオリジナルコード
            return $this->sendLoginResponse($request);

        }


        // ログイン失敗、なので試行回数をインクリメント
        $this->incrementLoginAttempts($request);

        // ログイン失敗のレスポンス生成
        return $this->sendFailedLoginResponse($request);
        

    }