イントロダクション
Tip!! 素早く始めたいですか? 真新しくインストールしたLaravelアプリケーションに
laravel/ui
Composerパッケージをインストールし、php artisan ui vue --auth
を実行してください。データベースをマイグレーションし、http://your-app.test/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\ResetPasswordController
を用意しています。パスワードリセットに必要な全ルートは、laravel/ui
Composerパッケージを使用して生成できます。
composer require laravel/ui --dev
php artisan ui vue --auth
ビュー
パスワードリセットに必要なすべてのビューは、laravel/ui
Composerパッケージを使用して生成できます。
composer require laravel/ui --dev
php artisan ui vue --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;
/**
* パスワードリセットの間、使用されるガードの取得
*
* @return \Illuminate\Contracts\Auth\StatefulGuard
*/
protected function guard()
{
return Auth::guard('guard-name');
}
パスワードブローカーのカスタマイズ
複数のユーザーテーブルに対するパスワードをリセットするために使用する、別々のパスワード「ブローカー」をauth.php
ファイルで設定できます。用意されているForgotPasswordController
とResetPasswordController
のbroker
メソッドをオーバーライドし、選んだブローカーを使用するようにカスタマイズができます。
use Illuminate\Support\Facades\Password;
/**
*パスワードリセットに使われるブローカの取得
*
* @return PasswordBroker
*/
public function broker()
{
return Password::broker('name');
}
リセットメールのカスタマイズ
パスワードリセットリンクをユーザーへ送るために使用する、通知クラスは簡単に変更できます。手始めに、User
モデルのsendPasswordResetNotification
メソッドをオーバーライドしましょう。このメソッドの中で、皆さんが選んだ通知クラスを使用し、通知を送信できます。パスワードリセット$token
は、メソッドの第1引数として受け取ります。
/**
* パスワードリセット通知の送信
*
* @param string $token
* @return void
*/
public function sendPasswordResetNotification($token)
{
$this->notify(new ResetPasswordNotification($token));
}