パスワードリセット

• イントロダクション
• データベースの検討事項
• ルート定義
• ビュー
• パスワードリセット後の処理
• カスタマイズ

イントロダクション

{tip} さっそく取り掛かりたいですか？ 真新しいLaravelアプリケーションでphp artisan make:authを実行し、ブラウザでhttp://your-app.dev/registerか、アプリケーションで割りつけた別のURLへアクセスするだけです。この一つのコマンドで、パスワードリセットを含めた、認証システム全体のスカフォールディングの面倒をみます。

大抵のWebアプリケーションはパスワードをリセットする手段を提供しています。それぞれのアプリケーションで何度も実装する代わりに、Laravelはパスワードリマインダを送り、パスワードリセットを実行する便利な方法を提供しています。

{note} Laravelのパスワードリセット機能を使用開始する前に、ユーザーがIlluminate\Notifications\Notifiableトレイトを使用していることを確認してください。

データベースの検討事項

利用開始するには、App\UserモデルがIlluminate\Contracts\Auth\CanResetPassword契約を実装しているか確認してください。もちろん、フレームワークに用意されているApp\Userモデルでは、既にこのインターフェイスが実装されています。Illuminate\Auth\Passwords\CanResetPasswordトレイトで、このインターフェイスで実装する必要のあるメソッドが定義されています。

リセットトークンテーブルマイグレーションの生成

次にパスワードリセットトークンを保存しておくためのテーブルを作成します。このテーブルのマイグレーションは、最初からLaravelのdatabase/migrationsディレクトリに含まれています。ですから、データベースマイグレートするために必要なのは次のコマンド実行だけです。

php artisan migrate

ルート定義

Laravelはパスワードリセットリンクのメールを送信し、ユーザーのパスワードをリセットするために必要なロジックを全部含んでいる、Auth\ForgotPasswordControllerとAuth\PasswordControllerを用意しています。パスワードリセットに必要な全ルートは、make:auth Artisanコマンドで生成します。

php artisan make:auth

ビュー

ビューについても、make:authコマンドを実行すれば、パスワードリセットに必要な全てが生成されます。ビューはresources/views/auth/passwordsに生成されます。アプリケーションに合わせ、自由にカスタマイズしてください。

パスワードリセット後の処理

ユーザーのパスワードをリセットするルートとビューを定義できたら、ブラウザーで/password/resetのルートへアクセスするだけです。フレームワークに含まれている ForgotPasswordControllerは、パスワードリセットリンクを含むメールを送信するロジックを含んでいます。一方のResetPasswordControllerはユーザーパスワードのリセットロジックを含んでいます。

パスワードがリセットされたら、そのユーザーは自動的にアプリケーションにログインされ、/homeへリダイレクトされます。パスワードリセット後のリダイレクト先をカスタマイズするには、ResetPasswordControllerのredirectToプロパティを定義してください。

protected $redirectTo = '/dashboard';

{note} デフォルトでパスワードリセットトークンは、一時間有効です。これは、config/auth.phpファイルのexpireオプションにより変更できます。

カスタマイズ

認証ガードのカスタマイズ

auth.php設定ファイルにより、複数のユーザーテーブルごとに認証の振る舞いを定義するために使用する、「ガード」をそれぞれ設定できます。用意されているResetPasswordControllerコントローラのguardメソッドをオーバーライドすることにより、選択したガードを使用するようにカスタマイズできます。このメソッドは、ガードインスタンスを返す必要があります。

use Illuminate\Support\Facades\Auth;

protected function guard()
{
    return Auth::guard('guard-name');
}

パスワードブローカーのカスタマイズ

複数のユーザーテーブルに対するパスワードをリセットするために使用する、別々のパスワード「ブローカー」をauth.phpファイルで設定できます。用意されているForgotPasswordControllerとResetPasswordControllerのbrokerメソッドをオーバーライドし、選んだブローカーを使用するようにカスタマイズができます。

use Illuminate\Support\Facades\Password;

/**
 *パスワードリセットに使われるブローカの取得
 *
 * @return PasswordBroker
 */
protected function broker()
{
    return Password::broker('name');
}

リセットメールのカスタマイズ

パスワードリセットリンクをユーザーへ送るために使用する、通知クラスは簡単に変更できます。手始めに、UserモデルのsendPasswordResetNotificationメソッドをオーバーライドしましょう。このメソッドの中で、皆さんが選んだ通知クラスを使用し、通知を送信できます。パスワードリセット$tokenは、メソッドの第1引数として受け取ります。

/**
 * パスワードリセット通知の送信
 *
 * @param  string  $token
 * @return void
 */
public function sendPasswordResetNotification($token)
{
    $this->notify(new ResetPasswordNotification($token));
}