.NET開発者のためのブログメディア
Laravelでのvalidationを使いこなす！基礎やエラーを実例で解説
- SE
- validationを使うとどのようになりますか？
- PM
- Laravelでのvalidationを使うと、入力の項目チェックができます。
目次
Laravelでのvalidationの使い方とは？
今回は、Laravelでのvalidationの使い方について説明します。validationを使うと、入力項目のチェックができます。
例えば、
・必須入力項目を入力しているか？
・メールアドレス形式になっているか？
・パスワードは8文字以上であるか？
・パスワードと確認用パスワードは一致しているか？
などのチェックを簡単に行えます。
これ以外にも多くのvalidationチェックが可能です。
Laravelでのvalidationの使い方に興味のある方はぜひご覧ください。
基本的な使い方
Laravelでのvalidationの基本的な使い方を紹介します。
Schemaは以下のように記述しています。name、email、password、password_confirmationを画面から入力させる想定です。
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 |
/** * Run the migrations. * * @return void */ public function up() { Schema::create('tasks', function (Blueprint $table) { $table->id(); $table->string('name'); $table->string('email'); $table->string('password'); $table->string('password_confirmation'); $table->timestamps(); }); } |
viewは以下のように記述しています。
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 |
<div class="form-group"> <label for="task" class="col-sm-3 control-label">Name</label> <div class="col-sm-6"> <input type="text" name="name" id="task-name" class="form-control"> </div> <label for="task" class="col-sm-3 control-label">Email</label> <div class="col-sm-6"> <input type="text" name="email" id="task-email" class="form-control"> </div> <label for="task" class="col-sm-3 control-label">Password</label> <div class="col-sm-6"> <input type="password" name="password" id="task-password" class="form-control"> </div> <label for="task" class="col-sm-3 control-label">Confirm Password</label> <div class="col-sm-6"> <input type="password" name="password_confirmation" id="task-password_confirmation" class="form-control"> </div> </div> |
validationはcontrollerに記述します。ここでは、name、email、passwordにvalidationを指定しています。
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 |
public function store(Request $request) { $task = new Task; // validationの追加 $rules = [ 'name' => ['required', 'string'], 'email' => ['email'], 'password' => ['required', 'min:8', 'confirmed'] ]; $this->validate($request, $rules); // ここまで $task->name = request('name'); $task->email = request('email'); $task->password = request('password'); $task->password_confirmation = request('password_confirmation'); $task->save(); return redirect('/tasks'); } |
validationの設定内容について説明します。
「required」は、必須入力項目であることを意味します。入力しない場合、データ登録されません。
「string」は文字列のみを受け付けます。数字を入力すると、データ登録されません。
「email」はメールアドレス形式であるか否かをチェックします。メールアドレス形式でないと、データ登録されません。
「min」は最小文字列数をチェックします。「min:8」とすることで、8文字以上入力されているか否かチェックします。8文字未満では、データ登録されません。
「confirmed」はこの場合は、password_confirmationと同値であるか否かをチェックします。passwordとpassword_confirmationが異なると、データ登録されません。
エラー表示
Laravelでのvalidationのエラー内容を画面表示する方法を紹介します。viewに以下のように記述します。
|
1 2 3 4 5 6 7 8 9 |
@if(count($errors) > 0) <div class="alert alert-danger"> <ul> @foreach ($errors->all() as $error) <li>{{ $error }}</li> @endforeach </ul> </div> @endif |
何も入力しないまま登録しようとすると、以下のメッセージが表示されます。
|
1 2 3 |
The name field is required. The email must be a valid email address. The password field is required. |
validationのエラー内容がリスト形式で表示されることが分かります。
特定のエラー内容のみ表示するには、以下のように記述します。
|
1 2 3 4 5 |
@if($errors->has('password')) <div class="error"> <p>{{ $errors->first('password') }}</p> </div> @endif |
何も入力しないまま登録しようとすると、以下のメッセージが表示されます。
|
1 |
The password field is required. |
passwordのエラーのみが表示されることが分かります。password以外のvalidationエラーは表示されません。
このようにLaravelでは、validationのエラー内容を取得、表示できます。
unique
Laravelにて、テーブル内でユニークであるか否かをチェックするuniqueについて紹介します。実際のソースコードを見てみましょう。
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 |
public function store(Request $request) { $task = new Task; // validationの追加 $rules = [ 'name' => ['required', 'string', 'unique:tasks'], 'email' => ['email'], 'password' => ['required', 'min:8', 'confirmed'] ]; $this->validate($request, $rules); // ここまで $task->name = request('name'); $task->email = request('email'); $task->password = request('password'); $task->password_confirmation = request('password_confirmation'); $task->save(); return redirect('/tasks'); } |
1レコード登録後に、nameに同じ値を使ってレコード登録しようとすると、以下のようにvalidationエラーになります。
|
1 |
The name has already been taken. |
このようにLaravelでは、テーブル内でユニークであるか否かをチェックできます。
bail
Laravelでvalidationエラーになったら、以降のvalidationチェックをしないbailについて紹介します。実際のソースコードを見てみましょう。
|
1 2 3 4 5 6 |
$rules = [ 'name' => ['bail', 'required', 'string', 'unique:tasks'], 'email' => ['email'], 'password' => ['required', 'min:8', 'confirmed'] ]; $this->validate($request, $rules); |
例えば、nameのstringでvalidationエラーになった場合、uniqueはチェックしません。
- SE
- Laravelでのvalidationの基本的な使い方やエラーがわかりました。
- PM
- 解説を参考に試してみてください。
まとめ
いかがでしたでしょうか。Laravelでのvalidationの使い方について説明しました。validationを使うと、入力項目のチェックができます。
これ以外にも多くのvalidationチェックが可能です。
ぜひご自身でLaravelのソースコードを書いて、理解を深めてください。
