FormRequest on ララジャパン

Laravel FormRequestのユニットテスト（２）

Tue, 24 Jun 2025 08:48:33 +0900

FormRequestのユニットテスト２記事目の今回は、prepareForValidation()を含めてテストをしたい場合はどうするのか？についてご紹介します。前回に続いて、「店舗情報更新画面」のバリデーション・認可処理を行うShopUpdateRequestを例にテストを作成します。

前回の記事はこちらからどうぞ。

テスト対象

ShopUpdateRequestにはprepareForValidation()が定義されています。name要素の半角カタカナを全角カタカナに変換する、というものです。

・・・・・
    protected function prepareForValidation(): void
    {
        // 店舗名の半角カタカナを全角カタカナに変換
        $this->merge([
            'name' => mb_convert_kana($this->input('name') ?? '', 'KV'),
        ]);
    }
・・・・・

prepareForValidation()を含めたテスト

prepareForValidation()も含めてテストを行う場合、rules()単体のテストで使ったValidator::make()による検証ではprepareForValidation()は呼ばれないので、少し工夫する必要があります。

Laravel7の時に当サイトでご紹介したFormRequestのテストの記事で記載の$this->app->resolving…を使用した手法は現在も有効ですので、そちらを使って以下のようなテストを書くことができます。

    #[Test]
    #[DataProvider('validationWithKanaConversionDataProvider')]
    public function 店舗名の半角カタカナが全角カタカナに変換されること(array $input, string $expected): void
    {
        $input = array_merge(
            $input,
            [
                'description' => 'テスト用の説明文です',
                'active_flag' => 'Y'
            ],
        );

        $adminUser = User::factory()->create(['role' => 'admin']);
        $this->actingAs($adminUser);

        // インスタンス作成時に実行する処理を設定
        $this->app->resolving(ShopUpdateRequest::class, function ($resolved) use ($input) {
            $resolved->merge($input);
        });

        $request = app(ShopUpdateRequest::class);

        $this->assertEquals($expected, $request->input('name'));
    }

    public static function validationWithKanaConversionDataProvider(): array
    {
        return [
            '半角カタカナ' => [
                ['name' => 'ﾃｽﾄｼｮｯﾌﾟ'],
                'テストショップ',
            ],
            '漢字混在' => [
                ['name' => 'ﾃｽﾄ店舗'],
                'テスト店舗',
            ],
            '全角カタカナ' => [
                ['name' => 'テストショップ'],
                'テストショップ',
            ],
        ];
    }

app(ShopUpdateRequest::class)を実行した時点でprepareForValidation()だけでなくauthorize()、rules()、messages()の全てが呼ばれます。なのでauthorize()を設定している場合は認証を通すための準備も必要になりますので、ご注意ください。

FormRequest全体をテストしながら、ルートパラメータも取得したい場合

先ほどのコードでFormRequestの各メソッドを通した全体的なテストが可能となりましたが、ルートパラメータを取得してのテストも同時に行いたい場合は追加の情報が必要となります。前回の記事内、rules()単体のテストの項でご紹介したように、リクエストインスタンスにはルート情報がセットされていないからでしたね。

先ほどのテストコードにあった$this->app->resolving()の中でルート情報をセットできるように編集します。setRouteResolver()を使って、以下のように記述します。

・・・・・
        $this->app->resolving(ShopUpdateRequest::class, function ($resolved) use ($input, $shop) {
            $resolved->merge($input);

            $route = Route::getRoutes()->match($resolved);
            $route->setParameter('shop', $shop);
            $resolved->setRouteResolver(fn() => $route);
        });

        $request = app(ShopUpdateRequest::class);
・・・・・

ただ、ここまでするのであればFeatureテストで書いたほうがシンプルなテストコードで書けるかもしれませんね。

包括的なテストとメソッド単体のテストまとめ

FormRequest全体を通したテストを行えば、より実際の動作に近い形の検証が可能です。ですがシンプルなFormRequestの時や、バリデーションに焦点を当てたテストを書きたい場合などは、より軽量な方法としてrules()・autorize()単体のテストとするほうが良いと思いますので、FormRequestの内容に応じて使い分けたほうが良さそうです。

前回と今回の記事でご紹介したテストの書き方を簡単に以下にまとめましたので、FormRequestのテストを作成する際のご参考になれば嬉しいです。

テスト対象	テスト方法
`authorize()`	`$request->authorize()` を直接呼び出す
`rules()`	`Validator::make($data, $request->rules(), $request->messages())`
`rules()`（ルートパラメータ必要な場合）	`setRouteResolver()` でルート情報を設定
`prepareForValidation()` を含めた検証	`$this->app->resolving()` + `app(FormRequest::class)`
`prepareForValidation()` + ルートパラメータ	`resolving()` 内で `setRouteResolver()` でルート情報を設定

Laravel FormRequestのユニットテスト（１）

Mon, 02 Jun 2025 01:29:15 +0900

Laravel12.xでFormRequestのユニットテストを作成します。今回の記事では基本的なテストから、少しややこしい$this->route()のようなルートパラメータを取得する必要がある場合の書き方などをご紹介します。

テスト対象

店舗情報の更新画面にて、入力データのバリデーション・認可処理を行うShopUpdateRequestが今回のテスト対象です。

入力項目は、店舗名（name）・店舗説明（description）・有効フラグ（active_flag）の３つ。rules()では必須チェックや文字数チェックなどの基本的なバリデーションと、nameに関しては他店舗と重複不可のユニーク制約も設定されています。

また、認可処理authorize()では管理者のみが実行可能なように設定されています。

App/Http/Requests/ShopUpdateRequest.php

namespace App\Http\Requests;

use Illuminate\Foundation\Http\FormRequest;
use Illuminate\Validation\Rule;

class ShopUpdateRequest extends FormRequest
{
    /**
     * Determine if the user is authorized to make this request.
     */
    public function authorize(): bool
    {
        return auth()->user()->role === 'admin';
    }

    /**
     * Get the validation rules that apply to the request.
     *
     * @return array<string, \Illuminate\Contracts\Validation\ValidationRule|array<mixed>|string>
     */
    public function rules(): array
    {
        $shop = $this->route('shop');

        return [
            'name' => [
                'required',
                'string',
                'max:20',
                Rule::unique('shops')->ignore($shop),
            ],
            'description' => ['required', 'string', 'max:100'],
            'active_flag' => ['required', Rule::in(['Y', 'N'])],
        ];
    }

    public function messages(): array
    {
        return [
            'name.required'        => '名前は必須です',
            'name.max'             => '名前は20文字以内で入力してください',
            'name.unique'          => 'この名前は既に使用されています',
            'description.required' => '説明は必須です',
            'description.max'      => '説明は100文字以内で入力してください',
            'active_flag.required' => 'アクティブフラグは必須です',
            'active_flag.in'       => 'アクティブフラグは Y または N で入力してください',
        ];
    }

    protected function prepareForValidation(): void
    {
        // 店舗名の半角カタカナを全角カタカナに変換
        $this->merge([
            'name' => mb_convert_kana($this->input('name') ?? '', 'KV'),
        ]);
    }
}

そしてコントローラー側では、以下のような定義となっています。

App/Http/Controllers/ShopController.php

・・・・・
use App\Http\Requests\ShopUpdateRequest;

class ShopController extends Controller
{
・・・・・
    public function update(ShopUpdateRequest $request, Shop $shop): RedirectResponse
    {
        $shop->update($request->validated());
        
        return redirect()->route('shops.show', $shop)
            ->with('success', '店舗情報を更新しました。');
    }
・・・・・
}

authorize()のテスト

まずはauthorize()のテストから。認証はadminユーザーのみ通ることができる、ということを検証します。

以下のようにRequestインスタンスから直接authorize()を呼び出してテストします。

Tests/Unit/Http/Requests/ShopUpdateRequestTest.php

namespace Tests\Unit\Http\Requests;

use App\Http\Requests\ShopUpdateRequest;
use App\Models\User;
use Illuminate\Foundation\Testing\RefreshDatabase;
use PHPUnit\Framework\Attributes\Test;
use Tests\TestCase;

class ShopUpdateRequestTest extends TestCase
{
    use RefreshDatabase;

    #[Test]
    public function 管理者でないユーザーの場合は認証が通らない(): void
    {
        $normalUser = User::factory()->create(['role' => 'user']);
        $this->actingAs($normalUser);

        $request = new ShopUpdateRequest;
        $this->assertFalse($request->authorize());
    }

    #[Test]
    public function 管理者の場合は認証が通る(): void
    {
        $adminUser = User::factory()->create(['role' => 'admin']);
        $this->actingAs($adminUser);

        $request = new ShopUpdateRequest;
        $this->assertTrue($request->authorize());
    }
}

rules()のテスト

次に、rules()のテストです。正常系のテストは以下のように書くことができます。

Tests/Unit/Http/Requests/ShopUpdateRequestTest.php

・・・・・
use Illuminate\Support\Facades\Validator;
use PHPUnit\Framework\Attributes\DataProvider;
・・・・・

    #[Test]
    #[DataProvider('validationDataProvider')]
    public function 正常形のテスト(array $data): void
    {
        $rules = (new ShopUpdateRequest)->rules();

        $validator = Validator::make($data, $rules);

        $this->assertTrue($validator->passes());
    }

    public static function validDataProvider(): array
    {
        return [
            '文字数制限OK' => [
                [
                    'name'        => str_repeat('a', 20),
                    'description' => str_repeat('a', 100)
                    'active_flag' => 'Y',
                ],
            ],
        ];
    }

現時点で最新のLaravel12でも、テストの書き方は特に変わりません。このままデータプロバイダに他の正常系のパターンを追加していけばOKです。

次は異常系のテストです。エラーメッセージも同時に検証したいので、Validator::make()の第３引数にエラーメッセージの配列$request->messages()を渡しています。

Tests/Unit/Http/Requests/ShopUpdateRequestTest.php

・・・・・
    #[Test]
    #[DataProvider('invalidDataProvider')]
    public function 異常系のテスト(array $data, array $messages): void
    {
        $request = new ShopUpdateRequest;

        $validator = Validator::make($data, $request->rules(), $request->messages());

        $this->assertTrue($validator->fails());
        $this->assertSame($messages, $validator->errors()->toArray());
    }

    public static function invalidDataProvider(): array
    {
        return [
            '空値を許容しない' => [
                'data' => [
                    'name'        => '',
                    'description' => '',
                    'active_flag' => '',
                ],
                'messages' => [
                    'name'        => ['名前は必須です'],
                    'description' => ['説明は必須です'],
                    'active_flag' => ['アクティブフラグは必須です'],
                ],
            ],
            '文字数オーバー' => [
                'data' => [
                    'name'        => str_repeat('a', 21),
                    'description' => str_repeat('a', 101),
                    'active_flag' => 'Y',
                ],
                'messages' => [
                    'name'        => ['名前は20文字以内で入力してください'],
                    'description' => ['説明は100文字以内で入力してください'],
                ],
            ],
        ];
    }

このような形で、異常系もデータプロバイダにテストデータを追加していけばOKです。

ですが、nameプロパティで１つ問題があります。nameプロパティに設定されている以下のようなunique()制約は、このテストのままでは検証できません。

        $shop = $this->route('shop');
・・・・・
        Rule::unique('shops')->ignore($shop),

$this->route()で取得しているルートパラメーターは、現状のテストではnullとなってしまうからです。

テスト時は実際のHTTPリクエストとして実行するわけではないため、ルート情報が設定されていないことが原因のようです。テスト時にルートパラメータを取り扱うにはどうしたらいいでしょうか。

ルート情報を含んだリクエストインスタンスを作成する

ルートパラメータを含めたバリデーションテストをする場合、リクエストインスタンスにルート情報を設定する必要があります。

ここで、検証対象のルーティングを確認します。

PUT|PATCH   shops/{shop} ............................. shops.update › ShopController@update

ルーティング情報がわかったので、さっそくルート情報を持ったFormRequestインスタンスを作成してゆきましょう。まずはcreate()というFormRequestクラスに定義されているメソッドを使用します。

１. create()でリクエストインスタンスを作成

        $request = ShopUpdateRequest::create(
            route('shops.update', $shop),
            'PUT',
            $input
        );

第１引数にURL、第２引数にHTTPメソッド、第３引数に入力データを渡します。これで、ルーティング情報に合わせたリクエストインスタンスが作成できます。

入力情報もセットできているので、$request->input()での値取得も可能です。

よく使われる$request->merge($data)でも入力データをセットできますが、ルーティングがすでに用意されている場合は今回のようにcreate()を使うことで、より実際のHTTPリクエストに近い状況を作成することができます。

2. FormRequestクラスのsetRouteResolver()でルートパラメータを設定

リクエスト情報はセットできましたが、$this->route()を有効にするにはさらにルート情報をリクエストに適用する必要があります。インスタンスの作成に続いて、以下のようにデータを適用します。

        $request = ShopUpdateRequest::create(
         ・・・・・
        );

        // 実際のルートマッチングを取得し、リクエストに適用
        $route = Route::getRoutes()->match($request);
        $route->setParameter('shop', $currentShop);
        $request->setRouteResolver(fn () => $route);

setRouteResolver()は$requestにルートを紐付けるメソッドです。これでやっと、テストコード内で$this->route(‘shop’)でデータが取得できるようになりました。

ちゃんとデータが取得できるのかをtinkerでも確認してみます。

$ php artisan tinker                                                 
Psy Shell v0.12.8 (PHP 8.2.27 — cli) by Justin Hileman
> $shop = App\Models\Shop::factory()->create();                                                       
= App\Models\Shop {#6265
    name: "有限会社 桐山",
・・・・・

> $request = App\Http\Requests\ShopUpdateRequest::create(
    route('shops.update', $shop),    
    'PUT', 
    ['name' => 'テスト店舗', 'description' => 'テスト説明', 'active_flag' => 'Y']);

= App\Http\Requests\ShopUpdateRequest {#6306
・・・・・
  }

> $route = Route::getRoutes()->match($request);
= Illuminate\Routing\Route {#976
・・・・・

> $route->setParameter('shop', $shop);
= null

> $request->setRouteResolver(fn() => $route);
= App\Http\Requests\ShopUpdateRequest {#6306
・・・・・

> $request->route('shop');　　// これで取得できるようになった！
= App\Models\Shop {#6265
    name: "有限会社 桐山",
・・・・・

問題なく取得できています！

ルートパラメータを使ったunique制約のユニットテスト

上記の方法を使った「既存のショップ名と重複不可」の検証テストコードは、以下のようになります。

・・・・・
use App\Models\Shop;
use Illuminate\Support\Facades\Route;
・・・・・

    #[Test]
    public function 既存のショップ名と重複不可(): void
    {
        // 既存のショップを作成
        Shop::factory()->create(['name' => '既存のショップ名']);

        // 更新対象のショップを作成
        $currentShop = Shop::factory()->create(['name' => '現在のショップ名']);

        // 更新リクエストのデータ
        $input = [
            'name'        => '既存のショップ名', // 既存のショップ名と重複
            'description' => 'テスト用の説明文です',
            'active_flag' => 'Y',
        ];

        // リクエストインスタンスの作成
        $request = ShopUpdateRequest::create(
            route('shops.update', $currentShop),
            'PUT',
            $input
        );

        // 実際のルートマッチングを取得し、リクエストに適用
        $route = Route::getRoutes()->match($request);
        $route->setParameter('shop', $currentShop);
        $request->setRouteResolver(fn () => $route);

        // バリデーション実行
        $validator = Validator::make($request->all(), $request->rules(), $request->messages());

        // バリデーションが失敗することをアサート
        $this->assertTrue($validator->fails());

        // エラーメッセージに重複エラーが含まれることをアサート
        $this->assertTrue($validator->errors()->has('name'));
        $this->assertEquals('この名前は既に使用されています', $validator->errors()->first('name'));
    }

テストデータ準備のため少しコードが長くなりましたが、バリデーションの実行・アサートの部分は先ほどの異常系のテストと同じです。

次回は引き続き、prepareForValidation()を含めたテストの書き方をご紹介します。

バリデーション後のRequestの処理

Mon, 20 Jun 2022 06:07:34 +0900

FormRequestのバリデーションを問題なくパスしたら、コントローラで$request->validatedで配列としてフォームの入力値を取得できます。取得後の値は安全なのでそのままDBに保存することも可能です。しかし、その配列から必要のない値を抜いたり、足りない値を追加したりとかの処理はどうするかという説明です。

会員登録のFormRequest

例として会員登録の画面を使います。画面はこんな感じです。

その画面の入力をチェックするFormRequestは以下と定義します。

namespace App\Http\Requests;

use App\Rules\CaptchaRule;
use App\Rules\CustomerPasswordRule;
use Illuminate\Foundation\Http\FormRequest;

class CustomerRequest extends FormRequest
{
    public function rules()
    {
        $rules = [
            'email'                => ['required', 'email', 'unique:customer,email'],
            'password'             => ['required', new CustomerPasswordRule, 'confirmed'],
            'name'                 => ['required'],
            'g-recaptcha-response' => ['required', new CaptchaRule],
        ];

        return $rules;
    }
}

CustomerPasswordRuleやCaptchaRuleは事前に用意したカスタムのバリデーションのクラスです。

CustomerRequestのバリデーションを問題なく通過したら、以下のようにコントローラでDBに保存します。

namespace App\Http\Controllers\User;

use App\Http\Controllers\Controller;
use App\Http\Requests\CustomerRequest;
use App\Models\Customer;
use Illuminate\Foundation\Auth\RegistersUsers;

class RegisterController extends Controller
{
    use RegistersUsers;

...
    /**
     * 会員の登録
     *
     * @param  \App\Http\Requests\CustomerRequest  $request
     * @return \Illuminate\Http\RedirectResponse
     */
    public function register(CustomerRequest $request)
    {
        $validated = $request->validated();

        Customer::create($validated);
        ...
    }
}

ここでのregister()メソッドの$validatedの値の中身を見てみましょう。

$validated = [
  "email" => "test@example.com",
  "password" => "Test1234567890!",
  "name" => "テスト太郎",
  "g-recaptcha-response" => "03AGdBq26f1ycQWiqz2OeBFz....",
]

DBに保存するのに必要なのは、email, password（暗号化する）、nameの３つだけで、キャプチャのg-recaptach-responseは必要でありませんので、先の配列値から抜く必要あります。また、会員が有効かどうかを指定するactive_flagが必要なので、その値を配列に加える必要あります。

このような処理を行うには、Laravelのバージョン8.x以降では、以下のようにvalidated()を使わずに、safe(), merge(), except()を使って可能です。

...
    $input = $request->safe()
        ->merge(['active_flag' => 'Y'])
        ->except(['g-recaptcha-response']);

    Customer::create($input);
...

safeは、バリデーションをパスした値を抽出し、mergeは値を追加、exceptは値を削除です。しかし、mergeとexceptの使用の順番には注意してください。これらを逆にするとエラーとなってしまいます。なぜなら、exceptは配列を返すのでその後にメソッドの連結ができません。

処理の結果の配列は、以下のようになります。

$input = [
  "email" => "test@example.com",
  "password" => "Test1234567890!",
  "name" => "テスト太郎",
  "active_flag" => "Y",
]

よりフレキシブルな処理を望むなら、以下のようにcollect()を通してCollectionのオブジェクトにすることです。

...
    $input = $request->safe()
        ->collect()
        ->except(['g-recaptcha-response'])
        ->merge(['active_flag' => 'Y'])
        ->all();

    Customer::create($input);
...

さて、safe()の対応がないLaravel 7.xではどう対応しましょう。こちらも、配列をCollectionにしてしまえば、問題ありません。

...
    $input = collect($request->validated())
        ->except(['g-recaptcha-response'])
        ->merge(['active_flag' => 'Y']
        ->all();

    Customer::create($input);
...

私としては、Collectionを使用した方が好きです。以下のように、ケースにより配列の中身を変えることも簡単です。

       $input = collect($request->validated())
            ->when(! $request->active_flag, function ($collection) {
                return $collection->put('active_flag', 'N'); // 値がないときはNとする
            })
            ->when(! $request->paymethod_id, function ($collection) {
                $collection->forget([ // 値がないときは、以下の設定は必要ではない
                    'paymethod_id',
                    'card_number',
                    'card_exp',
                    'card_holder',
                ]);

                return $collection;
            })
            ->all();

FormRequestでオーソリ（認可）

Sun, 24 Oct 2021 02:23:14 +0900

FormRequestの話はいつも入力値のバリデーションが中心ですが、入力値とは関係ないアクセスのオーソリ（認可）もFormRequest内で設定可能です。その説明のための簡単な例として、登録したユーザーが自分の名前などのプロフィールを編集するするときに、最後の編集から24時間経過しないと次の変更ができない、というのはどうでしょう。

まず、FormRequestをaritisanの実行で作成します。

$ php artisan make:request UserEditRequest

以下のようにオーソリのための関数、authorize()を定義します。

app/Http/Request/UserEditRequest.php

namespace App\Http\Requests;

use Illuminate\Foundation\Http\FormRequest;

class UserEditRequest extends FormRequest
{
    /**
     * Determine if the user is authorized to make this request.
     *
     * @return bool
     */
    public function authorize()
    {
        $user = auth()->user();

        // レコードの更新日と現在の差分を時間で計算
        $diff = Carbon::parse($user->updated_at)->diffInHours(Carbon::now());

        return ($diff > 24); //差分が24時間超ならＯＫ、そうでないならアクセス不可
    }

    /**
     * Get the validation rules that apply to the request.
     *
     * @return array
     */
    public function rules()
    {
        return [
            'name'  => 'required',
        ];
    }
}

次に、編集画面のコントローラで先のFormRequestを以下のように使用して、

namespace App\Http\Controllers;

use App\Http\Requests\UserEditRequest;

class UserController extends Controller
{
    /**
     * Create a new controller instance.
     *
     * @return void
     */
    public function __construct()
    {
        $this->middleware('auth');
    }

    /**
     * Show the form for editing the specified resource.
     *
     * @return \Illuminate\Http\Response
     */
    public function edit()
    {
        $user = auth()->user();

        return view('edit');
    }

    /**
     * Update the specified resource in storage.
     *
     * @param  \App\Http\Requests\UserEditRequest $request
     * @return \Illuminate\Http\Response
     */
    public function update(UserEditRequest $request) //　ここでFormRequestを使用
    {
        $user = auth()->user();        
        
        $user->update($request->validated());

        return redirect()->route('home');
    }
}

過去24時間内にすでにレコードを変更したという仮定で、編集画面の保存ボタンを押すと以下のように403の画面に遷移します。

しかしこれでは、どうしてエラーとなったかユーザーには謎ですね。拒否された理由のメッセージを表示したいです。

以下のように、FormRequestのfailedAuthorization()を使えば、

app/Http/Requests/UserEditRequest.php

...
    /**
     * Handle a failed authorization attempt.
     *
     * @return void
     *
     * @throws \Illuminate\Auth\Access\AuthorizationException
     */
    protected function failedAuthorization()
    {
        throw new AuthorizationException('最後の編集から２４時間経過しないと編集可能となりません');
    }
...

今度は親切なメッセージのエラー表示となります。

配列値の入力のためのFormRequest（２）エラーを見やすく

Sun, 12 Sep 2021 12:42:49 +0900

前回は１行１項目で３行の入力フォームの話でした。今回は難度をアップして１行３項目で３行の入力フォームの話です。

複数行・複数項目の入力フォーム

今回のフォームはこんな感じです。前回より複雑でしょう。

コントローラは、前回と同様ですが、FormRequestはItemsRequestとします。

app/Controllers/Form2Controller.php

namespace App\Http\Controllers;

use App\Http\Requests\ItemsRequest;
use Illuminate\Http\Request;

class Form2Controller extends Controller
{
    /**
     * Show the form for creating a new resource.
     *
     * @return \Illuminate\Http\Response
     */
    public function create()
    {
         return view('form2');
    }

    /**
     * Store a newly created resource in storage.
     *
     * @param  App\Http\Requests\ItemsRequest  $request
     * @return \Illuminate\Http\Response
     */
    public function store(ItemsRequest $request)
    {
       ddd($request->validated());
    }
}

ブレードは、

resources/views/form2.blade.php

...
<div class="container-fluid">
  <div class="row">
    <div class="col-md-12 col-lg-12 mt-2">
      <div class="card card-primary">

        <div class="card-header">
          <h3 class="card-title">複数行のフォーム</h3>
        </div>

        <form method="POST" action="{{ route('form2.store') }}" class="form-horizontal" novalidate="">
          @csrf
          <div class="card-body">
            @error('names')
              <div class="invalid-feedback d-block">{{ $message }}</div>
            @enderror
            <div class="table-responsive">
              <table class="table table-bordered table-hover table-sm">
                <thead>
                  <tr>
                    <th>アイテム名</th>
                    <th class="col-2">価格</th>
                    <th class="col-1">個数</th>
                  </tr>
                </thead>
                <tbody>

                  @for ($i = 0; $i < 3; $i++)
                    <tr>
                      <td>
                        <input class="form-control" maxlength="255" name="names[]" type="text" value="{{ old('names.'.$i) }}">
                        @error('names.'.$i)
                          <span class="invalid-feedback d-block">{{ $message }}</span>
                        @enderror
                      </td>
                      <td>
                        <input class="form-control" maxlength="10" name="prices[]" type="text" value="{{ old('prices.'.$i) }}">
                        @error('prices.'.$i)
                          <span class="invalid-feedback d-block">{{ $message }}</span>
                        @enderror
                      </td>
                      <td>
                        <input class="form-control" maxlength="5" name="quantities[]" type="text" value="{{ old('quantities.'.$i) }}">
                        @error('quantities.'.$i)
                        <span class="invalid-feedback d-block">{{ $message }}</span>
                        @enderror
                      </td>
                    </tr>

                  @endfor
                </tbody>
              </table>
            </div>
          </div>

          <div class="card-footer">
            <button class="btn btn-primary float-right mr-2" type="submit">保存</button>
          </div>
        </form>
      </div><!-- card -->
    </div>
  </div><!-- row -->
</div>
...

FormRequestは、

app/Http/Requests/ItemsRequest.php

namespace App\Http\Requests;

use Illuminate\Foundation\Http\FormRequest;
use Illuminate\Contracts\Validation\Validator;
use Illuminate\Validation\ValidationException;

class ItemsRequest extends FormRequest
{
    protected function prepareForValidation()
    {
        $names = $prices = $quantities = [];

        // nullを削除するために入力データを作成しなおす
        foreach($this->names as $i => $name) {
            if ($name === null) {
                continue;
            }

            array_push($names, $name);
            array_push($prices, $this->prices[$i]);
            array_push($quantities, $this->quantities[$i]);
        }

        $this->merge([
            'names'      => $names,
            'prices'     => $prices,
            'quantities' => $quantities,
        ]);
    }

    /**
     * Get the validation rules that apply to the request.
     *
     * @return array
     */
    public function rules()
    {
        return [
            'names'        => 'required|array', // 必ず１行の入力が必要
            'names.*'      => 'nullable|string',
            'prices.*'     => 'required_with:names.*|integer',
            'quantities.*' => 'required_with:names.*|integer|min:1',
        ];
    }

    public function attributes()
    {
        return [
            'names.*'      => 'アイテム名',
            'prices.*'     => '価格',
            'quantities.*' => '個数',
        ];
    }

    public function messages()
    {
        return [
            'names.required'             => '必ず１つの入力が必要です',
            'prices.*.required_with'     => '「アイテム名」が入力されているときは「価格」は必須です.',
            'prices.*.integer'           => '「価格」は整数の入力が必要です.',
            'quantities.*.required_with' => '「アイテム名」が入力されているときは「個数」は必須です.',
            'quantities.*.integer'       => '「個数」は整数の入力が必要です.',
            'quantities.*.min:1'         => '「個数」は最低１です.',
        ];
    }
}

エラーの出力はこんな感じです。

エラーの出力を見やすくする

先のエラーの出力、個数や価格の列の幅が短いので醜いですね。

考えついたのは、エラーのテキストを一緒にして１行すべてを使って表示しては。ということで、エラーを加工が必要です。Laravelにはしっかりそのための関数もあるのです。

ItemRequest.phpに以下のように、failedValidation()なる関数を追加します。

app/Http/Requests/ItemsRequest.php

namespace App\Http\Requests;

use Illuminate\Foundation\Http\FormRequest;
use Illuminate\Contracts\Validation\Validator;
use Illuminate\Validation\ValidationException;

class ItemsRequest extends FormRequest
{
...
    /**
     * Override the parent function
     *
     * @param  \Illuminate\Contracts\Validation\Validator  $validator
     * @return void
     *
     * @throws \Illuminate\Validation\ValidationException
     */
    protected function failedValidation(Validator $validator)
    {
        $errorsPerRow = [];

        foreach ($validator->errors()->getMessages() as $field => $messages) {
            $i = explode('.', $field)[1] ?? null; // 例えば、name.1なら1を取り出す

            $errorsPerRow['row.'.$i][] = $messages[0]; // 各行でのすべてのエラーを配列に
        }

        foreach ($errorsPerRow as $key => $messages) {
            $validator->errors()->add($key, implode(' ', $messages)); //　各行でのエラーを１つにまとめる
        }

        throw (new ValidationException($validator))
            ->errorBag($this->errorBag)
            ->redirectTo($this->getRedirectUrl());
    }
}

上の関数は、バリデーションが失敗したときにコールされる関数で、関数内で、各行のすべての項目のエラーを合わせて、row.0などのようなキーにエラーメッセージを割り当てて、新たなエラーを作成します。

そしてそれを、ブレードで以下のように出力できるようにします。

...
        <form method="POST" action="{{ route('form2.store') }}" class="form-horizontal" novalidate="">
          @csrf
          <div class="card-body">
            @error('names')
              <div class="invalid-feedback d-block">{{ $message }}</div>
            @enderror
            <div class="table-responsive">
              <table class="table table-bordered table-hover table-sm">
                <thead>
                  <tr>
                    <th>アイテム名</th>
                    <th class="col-2">価格</th>
                    <th class="col-1">個数</th>
                  </tr>
                </thead>
                <tbody>

                  @for ($i = 0; $i < 3; $i++)
                    <tr>
                      <td>
                        <input class="form-control" maxlength="255" name="names[]" type="text" value="{{ old('names.'.$i) }}">
                       </td>
                      <td>
                        <input class="form-control" maxlength="10" name="prices[]" type="text" value="{{ old('prices.'.$i) }}">
                       </td>
                      <td>
                        <input class="form-control" maxlength="5" name="quantities[]" type="text" value="{{ old('quantities.'.$i) }}">
                       </td>
                    </tr>
                    @error('row.'.$i)
                    <tr>
                      <td colspan="3">
                        <span class="invalid-feedback d-block">{{ $message }}</span>
                      </td>
                    </tr>
                    @enderror
                  @endfor
                </tbody>
              </table>
            </div>
          </div>

          <div class="card-footer">
            <button class="btn btn-primary float-right mr-2" type="submit">保存</button>
          </div>
        </form>
...

各項目のエラー表示を削除して、 @error(‘row.’.$i)で行ごとのエラーの表示としています。

結果は以下のように表示が改善されたエラー出力となります。

最後に

いろいろな形態の入力フォームがあるなか、前回も今回も追加専用のフォームの話でしたが、もちろんコードを変更すれば編集のフォームともなります。

配列値の入力のためのFormRequest

Tue, 07 Sep 2021 07:25:55 +0900

配列値の入力、つまり複数行に同じ入力項目を持つフォームの話です。お客様の登録などのフォームとは違って、バリデーションや画面でのエラーの表示など複雑な部分が多いです。しかし、コントローラで対応するより、FormRequestを使うとすっきりしたコードとなります。

配列値の入力フォーム

各行の入力項目が１つのケースから作成してみます。以下のような画面です。行数は固定で、最大３つまでのメールアドレスの入力が可能です。

コントローラのコードは、極力シンプルにして、投稿が成功したらバリデートした値を出力します。

app/Http/Controllers/FormController.php

namespace App\Http\Controllers;

use App\Http\Requests\EmailsRequest;
use Illuminate\Http\Request;

class FormController extends Controller
{
    /**
     * Show the form for creating a new resource.
     *
     * @return \Illuminate\Http\Response
     */
    public function create()
    {
         return view('form');
    }

    /**
     * Store a newly created resource in storage.
     *
     * @param  App\Http\Requests\EmailsRequest  $request
     * @return \Illuminate\Http\Response
     */
    public function store(EmailsRequest $request)
    {
       ddd($request->validated());
    }
}

ブレードは、

resources/views/form.blade.php

...
<div class="container-fluid">
  <div class="row">
    <div class="col-md-12 col-lg-12 mt-2">
      <div class="card card-primary">

        <div class="card-header">
          <h3 class="card-title">複数行のフォーム</h3>
        </div>

        <form method="POST" action="{{ route('form.store') }}" class="form-horizontal" novalidate="">
          @csrf
          <div class="card-body">
            @error('emails')
              <div class="invalid-feedback d-block">{{ $message }}</div>
            @enderror            
            <div class="table-responsive">
              <table class="table table-bordered table-hover table-sm">
                <thead>
                  <tr>
                    <th>メールアドレス</th>
                  </tr>
                </thead>
                <tbody>
                  @for ($i = 0; $i < 3; $i++)
                  <tr>
                    <td>
                      <input class="form-control" maxlength="255" name="emails[]" type="text" value="{{ old('emails.'.$i) }}">
                      @error('emails.'.$i)
                        <span class="invalid-feedback d-block">{{ $message }}</span>
                      @enderror
                    </td>
                   </tr>
                  @endfor
                </tbody>
              </table>
            </div>
          </div>

          <div class="card-footer">
            <button class="btn btn-primary float-right mr-2" type="submit">保存</button>
          </div>
        </form>
      </div><!-- card -->
    </div>
  </div><!-- row -->
</div>
...

そして、FormRequestは、

app/Http/Requests/EmailsRequest.php

namespace App\Http\Requests;

use Illuminate\Foundation\Http\FormRequest;

class EmaisRequest extends FormRequest
{
    /**
     * Get the validation rules that apply to the request.
     *
     * @return array
     */
    public function rules()
    {
        return [
            'emails.*' => 'nullable|email|distinct', // nullableとしているのは空行を許すため
        ];
    }

    public function messages()
    {
        return [
            'emails.*.email'    => '不正なメールです',
            'emails.*.distinct' => '重複の入力があります'
        ];
    }
}

実際に入力するとエラーはこんな感じで出力されます。

そしてバリデートされた値はこんな感じです。

しかし、これではDBに保存するときにいちいちnullを外す必要ありますね。これもFormRequestで処理したいです。

入力値の加工

FormRequestで入力値を加工するには、以下のようにprepareForValidation()を追加して処理します。

app/Http/Requests/EmailsRequest.php

...
class EmailsRequest extends FormRequest
{
    protected function prepareForValidation()
    {
        $emails = collect($this->emails)
            ->filter(function ($email) {
                return $email !== null; //ここでnull値を削除
            })->all();

        $this->merge([
            'emails' => $emails,
        ]);
    }

    /**
     * Get the validation rules that apply to the request.
     *
     * @return array
     */
    public function rules()
    {
        return [
            'emails'   => 'required|array', //入力を必須とする
            'emails.*' => 'nullable|email|distinct',
        ];
    }

    public function messages()
    {
        return [
            'emails.required'   => '必ず１つの入力が必要です',
            'emails.*.email'    => '不正なメールです',
            'emails.*.distinct' => '重複の入力があります'
        ];
    }
}

最低１つの入力を条件とするために、‘emails’ => ‘required|array’, もrules()も追加しています。

さて、先の投稿でバリデートされたデータは、今度は以下のようにnullの値はなくなりました。

そして、何も入力がなく投稿された場合は以下のようなエラーとなります。

ちなみに、最低２つの入力を条件としたいときは、ルールを、‘emails’ => ‘required|array|min:2’, とすればよいです。

FormRequestのユニットテスト

Sun, 18 Oct 2020 01:17:02 +0900

前回のFormRequestの入力補正を例にして、そのユニットテストを作成してみます。

ルールの部分だけのテスト

まず、テスト作成のコマンドを実行します。

$ php artisan make:test App/Http/Requests/EventRequestTest

実行すると、テストのファイルはLaravelのディレクトリ構造を真似て、tests/Feature/App/Http/Requestsのディレクトリに作成されます。

作成されたテストを以下のように編集します。

app/tests/Feature/App/Http/Requests/EventRequestTest.php

namespace Tests\Feature\App\Http\Requests;

use App\Http\Requests\EventRequest;

use Illuminate\Foundation\Testing\RefreshDatabase;
use Illuminate\Foundation\Testing\WithFaker;
use Tests\TestCase;

class EventRequestTest extends TestCase
{
    /**
     * @test
     * @dataProvider validationProvider
     */
    public function validation($expected, $data)
    {
        $rules = (new EventRequest())->rules(); // rules()だけを抜き出す
        $validator = validator($data, $rules);

        $this->assertEquals($expected, $validator->passes());
    }

    public function validationProvider()
    {
        return [
            [
                true,
                [
                    'start_at' => '2020-01-01 00:00:00',
                    'end_at'   => '2020-01-01 01:00:00',
                ],
            ],
            [
                false,
                [
                    'start_at' => '2020-01-01 00:00:00',
                    'end_at'   => '2020-01-01 24:00:00', // 24時はない
                ],
            ]
        ];
    }
}

実行すれば、こんな感じでパスです。あとはvalidationProvider()のテストケースを増やしていくだけです。

PHPUnit 8.5.8 by Sebastian Bergmann and contributors.

..                                                                  2 / 2 (100%)

Time: 152 ms, Memory: 22.00 MB

OK (2 tests, 2 assertions)

しかし、ちょっと待ってください!

EventRequestでは以下のようにprepareForValidation()が使用されています。つまり、実際の入力の項目（date, start_hr, end_hr）を合わせて新規の項目（start_at, end_at）を作成しています。

...
    protected function prepareForValidation()
    {
        // ここでDBに収納する項目を作成
        $this->merge([
            'start_at' => sprintf('%s %02d:00:00', $this->date, $this->start_hr),
            'end_at'   => sprintf('%s %02d:59:59', $this->date, $this->end_hr),
        ]);
    }
...

先のテストでは、ルールだけのテストなのでこの部分のテストをスキップしてしまっているのです。

ベターなテスト

やはり、直接画面から入力されるテストをしたいということで、$this->post(’/event’)とかの使用も考えましたが、DBデータを用意する必要や認証も考えてやらないやら、ちょいと面倒です。

ということで、以下の記事を見つけました。

https://dev.to/dsazup/testing-laravel-form-requests-853

これを参照して先のテストを変更しました。今度は、dateとstart_hrとend_hrがテストデータとなっていることに注意してください。

namespace Tests\Feature\App\Http\Requests;

use App\Http\Requests\EventRequest;

use Illuminate\Foundation\Testing\RefreshDatabase;
use Illuminate\Foundation\Testing\WithFaker;
use Illuminate\Validation\ValidationException;

use Tests\TestCase;

class EventRequestTest extends TestCase
{
    /**
     * @test
     * @dataProvider validationProvider
     */
    public function validation($expected, $data)
    {
       $this->assertEquals($expected, $this->validate($data));
    }

    // ここが先の記事からとってきたところ、LaravelのFormRequestServiceProvider::boot()を参照したらしい。
    protected function validate($data)
    {
        $this->app->resolving(EventRequest::class, function ($resolved) use ($data){
            $resolved->merge($data);
        });

        try {
            app(EventRequest::class);

            return true;
        } catch (ValidationException $e) {
            return false;
        }
    }

    public function validationProvider()
    {
        return [
            [
                true,
                [
                    'date'     => '2020-01-01',
                    'start_hr' => '0',
                    'end_hr'   => '1',
                ],
            ],
            [
                false,
                [
                    'date'     => '2020-01-01',
                    'start_hr' => '0',
                    'end_hr'   => '24',
                ],
            ]
        ];
    }
}

実行してみると、

PHPUnit 8.5.8 by Sebastian Bergmann and contributors.

..                                                                  2 / 2 (100%)

Time: 145 ms, Memory: 22.00 MB

OK (2 tests, 2 assertions)

うまいこと成功です！

テストにより問題発見！

テストケースを増やしてみます。

...
    public function validationProvider()
    {
        return [
...
            [
                true,
                [
                    // 同じ時間は、00:00:00と00:59:59となるのでOK
                    'date'     => '2020-01-01',
                    'start_hr' => '0',
                    'end_hr'   => '0',
                ],
           ],
           [
                false,
                [
                    'date'     => '2020-01-01',
                    'start_hr' => 'a',
                    'end_hr'   => 'b',
                ],
            ]
        ];
    }
}

PHPUnit 8.5.8 by Sebastian Bergmann and contributors.

...F                                                                4 / 4 (100%)

Time: 268 ms, Memory: 22.00 MB

There was 1 failure:

1) Tests\Feature\App\Http\Requests\EventRequestTest::validation with data set #3 (false, array('2020-01-01', 'a', 'b'))
Failed asserting that true matches expected false.

あれれ、エラーになりました。　これでは、‘2020-01-01’, ‘a’, ‘b’の入力でも正しいということになってしまいます。これはおかしい。

問題は、EventRequest::prepareForValidation()の部分で、以下のようにsprintf()で文字列が０に変換されることです。tinkerを使って検証してみると、

>>> $data = (object)['date' => '2020-01-01', 'start_hr' => 'a', 'end_hr' => 'b'];
=> {#4452
     +"date": "2020-01-01",
     +"start_hr": "a",
     +"end_hr": "b",
   }
>>> sprintf('%s %02d:00:00', $data->date, $data->start_hr, $data->end_hr);
=> "2020-01-01 00:00:00"

ゼロになっていましたね。

さて、この修正は以下となりました。start_atを作成するFormRequestの関数で、start_hr, end_hrを先にチェックして違法なら、invalidという文字列を与えることにしました。

...
   protected function prepareForValidation()
    {
        if (! preg_match('/^[0-9]{1,2}$/', $this->start_hr)) { // ２桁の数字でないときは、'invalid'とする
            $start_at = 'invalid';
        } else {
            $start_at = sprintf('%s %02d:00:00', $this->date, $this->start_hr);
        }

        if (! preg_match('/^[0-9]{1,2}$/', $this->end_hr)) {
            $end_at = 'invalid';
        } else {
            $end_at = sprintf('%s %02d:59:59', $this->date, $this->end_hr);
        }

        $this->merge([
            'start_at' => $start_at,
            'end_at'   => $end_at,
        ]);
    }
...

実行すると、今度はパスです。

PHPUnit 8.5.8 by Sebastian Bergmann and contributors.

....                                                                4 / 4 (100%)

Time: 203 ms, Memory: 22.00 MB

OK (4 tests, 4 assertions)

FormRequestで入力値を補正（２）

Sat, 10 Oct 2020 01:20:11 +0900

FormRequestで入力値を補正を以前紹介しましたが、今度はちょっと違う補正の紹介です。何が違うというと、今度はバリデーションの後でなくバリデーション前に入力値を変えます。入力項目とDBに保存する項目の形態が違うときにとても便利です。とりあえず、それが必要なケースの説明から。

まず、DBに保存するのは、start_at（開始日時）とend_at（終了日時）の日時タイプ（mysqlならDATETIME）の２つ項目とします。しかし、両方の項目ともに日付は同じという仮定。いくつかのUIのバリエーションが考えられますが、私が考えたのは以下。

つまり、入力項目は、日付、開始時刻（数字）、終了時刻（数字）の３つの入力項目です。

日付はjquery-uiでカレンダーからの選択も可能（以下）であるし、時刻もドロップダウン、とすることもできますね。

画面から入ってくるのは、date, start_hr, end_hrの３つの値なのですが、さて、これらの入力値をバリデーションにかけて、DBには、start_atとend_atの２つの項目に保存するには、どうしたらよいでしょうか？

そこで登場するのが、FormRequestです。

まず、以下のコマンドでFormRequestファイルを、app/Http/Requestsのディレクトリに作成します。

$ php artisan make:request EventRequest

作成されたファイルを以下のように編集します。

app/Http/Requests/EventRequest.php

namespace App\Http\Requests;

use Illuminate\Foundation\Http\FormRequest;

class EventRequest extends FormRequest
{
    /**
     * Get the validation rules that apply to the request.
     *
     * @return array
     */
    public function rules()
    {
        return [
            'start_at'     => 'required|date|date_format:Y-m-d H:i:s',
            'end_at'       => 'required|date|date_format:Y-m-d H:i:s|after:start_at',
        ];
    }

    public function messages()
    {
        return [
            'date_format' => '不正な日時のフォーマットです',
        ];
    }

   public function attributes()
    {
        return [
            'start_at' => '開始日時',
            'end_at'   => '終了日時',
        ];
    }

    /**
     * Prepare the data for validation.
     *
     * @return void
     */
    protected function prepareForValidation()
    {
        // ここでDBに収納する項目を作成
        $this->merge([
            'start_at' => sprintf('%s %02d:00:00', $this->date, $this->start_hr),
            'end_at'   => sprintf('%s %02d:59:59', $this->date, $this->end_hr),
        ]);
    }
}

ここ、preparedForValidation()の関数において、入力値を、start_atとend_atの入力値に変換しています。DBではそれらの項目はDateTimeのタイプなので、時間だけでなく分や秒も足すこと必要です。

コントローラのメソッドでは、以下のようにコールします。store()の引数が、通常のRequestでなくEventRequestとなっていることに注意を。

app/Http/Controllers/EventController.php

namespace App\Http\Controllers;

use App\Http\Controllers\Controller;
use App\Http\Requests\EventRequest;

class EventController extends Controller
{
...
    /**
     * Store
     *
     * @param  \App\Http\Requests\EventRequest $request
     * @return \Illuminate\Http\RedirectResponse
     */
    public function store(EventRequest $request)
    {
        dd($request->all());
...

実行すると、dd()の出力は、

array:6 [▼
  "_token" => "npq1EPLTVvthufpgQiIpXIkxpwMPEsEEIBIzYf5A"
  "date" => "2020-10-08"
  "start_hr" => "8"
  "end_hr" => "17"
  "start_at" => "2020-10-08 08:00:00"
  "end_at" => "2020-10-08 17:59:59"
]

FormRequestでルールを共有

Tue, 24 Mar 2020 04:28:31 +0900

世界中大変なことになっていますね。私が住んでいるところも、子供たちの学校は４月いっぱい休み、レストランやバーはテイクアウトのみとなっています。それらのビジネスに携わっている人たちは本当に困っていると思います。逆に、私を含めてこのブログを読んでくれる人たちは、インターネットのおかげで忙しくなっているくらいと思います。その有難さを胸に、日々精進と行きましょう！

今回は、またもやFormRequestの話で、１つのコントローラーにおいてあるいは複数のコントローラでどうバリデーションのルールを共有の仕方を考えてみます。

ルールを共有する必要性

ルールをコントローラ間で共有する必要があるのは、重複の定義をせずに一か所で管理をして間違いを防ぎたいからです。

会員レコードを例にとると、

ユーザー画面での会員登録ユーザー画面で名前や住所などの会員情報更新ユーザー画面でパスワード変更さらに、管理画面ではユーザー画面と同様に、新規、更新、パスワード更新の機能が必要となります。

つまり、少なくともユーザー画面と管理画面で２つのコントローラーが必要で、それぞれの入力画面に異なるFormRequestを作成すれば６つ必要となります。そして、それぞれにルールの定義があるわけですが、いくつかは明らかに同じものを定義することになります。将来の管理性を考えるとどうかしたいですね。

ルールの共有の仕方

ルールを共有するにはいくつかのやり方ありますが、ここでは、以前書いた以下のブログを利用してみます。

コントローラー中でのルールの共有

そこでは、１つのコントローラ内でのルールの共有していますが、今度はFormRequest内でルールを共有します。そのために、先に書いた６つのFormRequestを作成する代わりに、１つのFormRequestを作成してそれを複数のコントローラのメソッドで共有とします。

まず、以前のコードを以下に再掲載します。

namespace App\Http\Controllers;
 
use Illuminate\Http\Request;
use Illuminate\Validation\Rule;
 
use App\User;
 
class UserController extends Controller
{
    public function rule($action, User $user = null)
   {
        // 共有するルール　kana, mailcode, phone_with_dashはカスタムバリデーター
        $rules = [
            'name'        => 'required',
            'name_kana'   => 'required|kana',
            'mailcode'    => 'required|mailcode',
            'prefecture'  => 'required',
            'city'        => 'required',
            'address1'    => 'required',
            'phone'       => 'required|phone_with_dash',
        ];
 
       // 共有しないルール
       switch ($action) {
            case 'store':　// レコード作成のためのルールを追加
                $rules['password']      = 'required|min:8|max:20|confirmed';
                $rules['email']         = 'required|email|unique:users';
                break;
 
            case 'update': // レコード編集のためのルールを追加
                $rules['email'] = [
                    'required',
                    'email',
                    Rule::unique('users')->ignore($user->id), //現在のレコード以外のレコードで重複がないかチェック
                ];
                break;
        }
 
        return [
            // rules
            $rules,
            // messages
            [
                'password.min' => '8から20文字長でお願いします',
                'password.max' => '8から20文字長でお願いします'
            ]
            // attributes
        ];
    }
...
    public function store(Request $request)
    {
        $request->validate(...$this->rules('store'));
        ...
    }
...
    public function update(Request $request, User $user)
    {
        $request->validate(...$this->rules('update', $user));
        ...
    }
...
}

FormRequestを使用すると、rules()の部分がUserFormRequestに移って、

...
    public function store(UserFormRequest $request)
    {
        ...
    }
...
    public function update(UserFormRequest $request, User $user)
    {
        ...
    }
...
}

となりますが、問題は、上と違って$actionや$userなどのパラメータを渡すことができません。どうしたらよいでしょう？

そこで登場するのが、$this->route()のメソッドです。UserFormRequestの中で、以下のようにそれらの情報が取り出せます。名前付きのルートがわかれば、それで条件分岐できます。

        $route= $this->route()->getName(); // 現在のrouteの名前を取得
        $user = $this->route('user'); // update(UserFormRequest $request, User $user)の$userを取得

以下が、UserFormRequestのコードです。

namespace App\Http\Requests;

use Illuminate\Foundation\Http\FormRequest;

class UserFormRequest extends FormRequest
{
    /**
     * Determine if the user is authorized to make this request.
     *
     * @return bool
     */
    public function authorize()
    {
        return true;
    }

    /**
     * Get the validation rules that apply to the request.
     *
     * @return array
     */
    public function rule()
    {
        $route= $this->route()->getName(); // 現在のrouteの名前を取得
        $user = $this->route('user'); // update(UserFormRequest $request, User $user)の$userを取得

        // 共有するルール　kana, mailcode, phone_with_dashはカスタムバリデーター
        $rules = [
            'name'        => 'required',
            'name_kana'   => 'required|kana',
            'mailcode'    => 'required|mailcode',
            'prefecture'  => 'required',
            'city'        => 'required',
            'address1'    => 'required',
            'phone'       => 'required|phone_with_dash',
        ];
 
       // 共有しないルール
       switch ($route) {
            case 'user.store':　// レコード作成のためのルールを追加
                $rules['password']      = 'required|min:8|max:20|confirmed';
                $rules['email']         = 'required|email|unique:users';
                break;
 
            case 'user.update': // レコード編集のためのルールを追加
                $rules['email'] = [
                    'required',
                    'email',
                    Rule::unique('users')->ignore($user->id), //現在のレコード以外のレコードで重複がないかチェック
                ];
                break;
        }
 
        return $rules;
    }

    public function messages()
    {
        return [
                'password.min' => '8から20文字長でお願いします',
                'password.max' => '8から20文字長でお願いします'
        ];
    }
}

FormRequestで入力値を補正

Fri, 13 Mar 2020 23:59:58 +0900

FormRequestの続きです。FormRequestは、ユーザーの入力をチェックしてくれるだけでなく、入力値も変えてくれることができます。

例えば、フォームにおいて以下のようなチェックボックスがあったとき、

	<div class="form-group row">
		<label for="subscribe" class="col-md-4 col-form-label text-md-right">メルマガを購読？</label>

		<div class="col-md-6">
			<input id="subscribe" type="checkbox" class="form-control" name="subscribe" value="Y">
		</div>
	</div>

チェックをオンにすれば、リクエストにはY（Yesの意味）の値が返ってきますが、チェックがオフなら何も値が返ってきません。それゆえに、例えばチェックなしをDBにN（Noの意味）として保存したいなら、どうしましょう？

私のFormRequestの継承元のFormRequestのLaravelのコードを見ると、以下のようなメソッドがあります。

vendor/laravel/framework/src/Illuminate/Foundation/Http/FormRequest.php

...
    /**
     * Get data to be validated from the request.
     *
     * @return array
     */
    public function validationData()
    {
        return $this->all();
    }
...

このメソッドを上書きして、

app/Http/Requests/UserRequest.php

namespace App\Http\Requests;

use Illuminate\Foundation\Http\FormRequest;

class UserRequest extends FormRequest
{
    /**
     * Determine if the user is authorized to make this request.
     *
     * @return bool
     */
    public function authorize()
    {
        return true;
    }

    /**
     * Get the validation rules that apply to the request.
     *
     * @return array
     */
    public function rules()
    {
        return [
            'name'  => 'required',
            'email' => 'required|email',
            'subscribe' => 'string',　// これを忘れずに！
        ];
    }

    public function validationData()
    {
        $all = parent::validationData();

        //値がないなら、'N'を入れる
        if (! $this->has('subscribe')) {
            $all['subscribe'] = 'N';
        }

        return $all;
    }
}

ルールにおいては、チェックボックスの項目（subscribe）のルールが必ず必要です。

こうすれば、

namespace App\Http\Controllers;

use App\Http\Requests\UserRequest;

class UserController extends Controller
{
    public function __construct()
    {
        $this->middleware('auth');
    }

    public function edit()
    {
    	$user = auth()->user();

    	return view('user_edit')->with(compact('user'));
    }

    public function update(UserRequest $request)
    {
        dd($request->validated()); // デバッグ文を入れる

    	auth()->user()->update($request->validated());

    	return redirect()->route('home');
    }
}

フォームでsubmitすると、上で入れたデバッグ文の実行は、

array:3 [▼
  "name" => "kenji"
  "email" => "kenji@lotsofbytes.com"
  "subscribe" => "N"
]

と返してくれます。

FormRequestを使う

Mon, 09 Mar 2020 11:58:03 +0900

コントローラーのファイルが大きくなってきたな、と思ったら、FormRequestを使ってみようかと真剣に考え始めました。まずは、FormRequestとは何ものかの紹介からです。

FormRequestを使わないコントローラ

FormRequestを使わないコントローラというのは、例えば以下のコードに代表されます。

namespace App\Http\Controllers;

use Illuminate\Http\Request;

class UserController extends Controller
{
    public function __construct()
    {
        $this->middleware('auth'); //認証したユーザーのみがアクセス可能
    }

    public function edit()
    {
    	$user = auth()->user();　// 認証したユーザーの情報を取得

    	return view('user_edit')->with(compact('user'));
    }

    public function update(Request $request)
    {
       // リクエストのバリデーション
    	$validated = $request->validate([
    		'name'  => 'required',
    		'email' => 'required|email',
    	]);

        // DBの情報を更新
    	auth()->user()->update($validated);

        // ホーム画面へリダイレクト
    	return redirect()->route('home');
    }
}

このコントローラを使用する、routeは以下のように定義されます。

routes/web.php

Route::get('/', function () {
    return view('welcome');
});

Auth::routes();

Route::get('/home', 'HomeController@index')->name('home');

Route::get('/user/edit', 'UserController@edit')->name('user.edit');
Route::put('/user/edit', 'UserController@update')->name('user.update');

よく見て欲しいのは、UserController::update()のメソッド。リクエストの入力値をバリデートして、バリデーションをパスした入力値をそのまま、EloquestのUserオブジェクト(auth()->user)のupdate()に渡して更新です。

ちなみに、このコントローラは、ログインしたユーザーが自分の情報を編集するためです。Laravelのデフォルトのプロジェクトにはユーザー認証のコードがついてきますが、この機能はありません。

FormRequestを使用したら

まず、コマンドラインから、FormRequestの作成です。

$ php artisan make:request UserRequest

これで、UserRequest.phpが作成されます。それを以下のように編集します。

app/Http/Requests/UserRequest.php

amespace App\Http\Requests;

use Illuminate\Foundation\Http\FormRequest;

class UserRequest extends FormRequest
{
    /**
     * Determine if the user is authorized to make this request.
     *
     * @return bool
     */
    public function authorize()
    {
        return true; // すでにUserController::__construct()でチェックしてあるので、true
    }

    /**
     * Get the validation rules that apply to the request.
     *
     * @return array
     */
    public function rules()
    {
        return [
            'name'  => 'required',
            'email' => 'required|email',
        ];
    }
}

見ての通り、コントローラにあったバリデーションルールが移動されています。

コントローラの方は、

namespace App\Http\Controllers;

use App\Http\Requests\UserRequest; //ここで宣言

class UserController extends Controller
{
    public function __construct()
    {
        $this->middleware('auth');
    }

    public function edit()
    {
    	$user = auth()->user();

    	return view('user_edit')->with(compact('user'));
    }

    public function update(UserRequest $request)
    {
    	auth()->user()->update($request->validated());　// １行になりました

    	return redirect()->route('home');
    }
}

FormRequestを使うことでコントローラのコードの行数は減りました。しかし、FormRequestの定義のファイルが増えて全体のコードの行数は増えたことも事実。今回のような、簡単なコードではあまり得したことにはならない感じですね。ない方がわかりやすいとも思えます。しかし、もしバリデーションルールがもっとたくさんあったら、FormRequestはベターなのは明らかです。コードが複雑になったらリファクターして新規の関数を作成するのと同じかな。

しかし、FormRequestを使うことに関して他の利点はなんでしょう？次回からそれらの利点を探ってみます。

編集のブレード

参考として、作成したブレードファイルも掲載します。resources/views/auth/register.blade.phpをもとにしましたが、Eメールの入力において、type=“email”のところ、type=“text”にしています。バリデーションエラーの表示をテストしたかったためです。

resources/views/user_edit.blade.pohp

@extends('layouts.app')

@section('content')
<div class="container">
    <div class="row justify-content-center">
        <div class="col-md-8">
            <div class="card">
                <div class="card-header">{{ __('Register') }}</div>

                <div class="card-body">
                    <form method="POST" action="{{ route('user.edit') }}">
                        @csrf
                        @method('PUT')

                        <div class="form-group row">
                            <label for="name" class="col-md-4 col-form-label text-md-right">{{ __('Name') }}</label>

                            <div class="col-md-6">
                                <input id="name" type="text" class="form-control @error('name') is-invalid @enderror" name="name" value="{{ old('name', $user->name) }}" required autocomplete="name" autofocus>

                                @error('name')
                                    <span class="invalid-feedback" role="alert">
                                        <strong>{{ $message }}</strong>
                                    </span>
                                @enderror
                            </div>
                        </div>

                        <div class="form-group row">
                            <label for="email" class="col-md-4 col-form-label text-md-right">{{ __('E-Mail Address') }}</label>

                            <div class="col-md-6">
                                <input id="email" type="text" class="form-control @error('email') is-invalid @enderror" name="email" value="{{ old('email', $user->email) }}" required autocomplete="email">

                                @error('email')
                                    <span class="invalid-feedback" role="alert">
                                        <strong>{{ $message }}</strong>
                                    </span>
                                @enderror
                            </div>
                        </div>

                        <div class="form-group row mb-0">
                            <div class="col-md-6 offset-md-4">
                                <button type="submit" class="btn btn-primary">
                                    {{ __('Register') }}
                                </button>
                            </div>
                        </div>
                    </form>
                </div>
            </div>
        </div>
    </div>
</div>
@endsection

フォームリクエスト：コントローラからバリデーションを分離

Wed, 30 Sep 2015 11:40:55 +0900

「重複回避-DB重複エラーを利用」で使用した以下のコントローラのメソッドをここでもう一度掲載します。

public function postSignup(Request $request)
{
    $rules = [
      'email'      => 'required|email|unique:member,email',
      'password'   => 'required|min:6|max:20|confirmed',
      'first_name' => 'required',
      'last_name'  => 'required'
    ];

    $messages = [
       'email.unique' => "Eメールアドレスはすでに使用されています"
    ];

    $this->validate($request, $rules, $messages);

    try 
    {
      $member = Member::create($request->all());
    }
    catch(IlluminateDatabaseQueryException $e)
    {
      $errorCode = $e->errorInfo[1];

      if($errorCode == 1062) //重複エラーをここでキャッチ
      {
        return back()->withInput()->withErrors(['email' => "Eメールアドレスはすでに使用されています"]);
      }
    }

　　return "登録完了";
}

フォームでの入力により送信された値は、このメソッドのパラメータ変数$requestに収められます。それらをバリデーションして、エラーがあれば表示、なければ新規の会員のDBレコードを作成。さらに、タイミングエラーにより逃れた重複エラーも発生するならキャッチ。まとまってとてもわかりやすいです。これはこれで十分と思います。

しかし、このコントローラのコードがより複雑になったときに、たとえば、新規会員、編集、パスワードの編集と会員関連のバリデーションを一箇所に集めて管理性を高めたいときはどうしましょう？

もちろん、１つのコントローラでpostSignup()のようにそれぞれのメソッドで対応するのも１つのやり方、しかし、会員のすべての処理を１つのコントローラで対応することはできません。例えば、ユーザーはエンドユーザーだけでなく管理者も会員処理が必要となります。その場合は少なくともユーザーと管理者に別々のコントローラを持つことになるでしょう。そうなら、モデルのMember.phpに入れるのも１つの手です。

ここでは、それらとまったく違う手法、フォームリクエストを紹介します。ララベル5.1以降が必要です。

フォームリクエストは、まずapp/Http/Requests/MemberRequest.phpのファイルを作成して、以下のように先のコントローラのバリデーション部分を移行します。

namespace AppHttpRequests;

use AppHttpRequestsRequest;

class MemberRequest extends Request {
    public function authorize()
    {
      return true;
    }

    public function rules()
    {
      return [
        'email'      => 'required|email|unique:member,email',
        'password'   => 'required|min:6|max:20|confirmed',
        'first_name' => 'required',
        'last_name'  => 'required'
      ];
    }
}

これにより先のコントローラは以下のようにシンプルになります。

public function postSignup(MemberRequest $request)
{
    try 
    {
      $member = Member::create($request->all());
    }
    catch(IlluminateDatabaseQueryException $e)
    {
      $errorCode = $e->errorInfo[1];

      if($errorCode == 1062) //重複エラーをここでキャッチ
      {
        return back()->withInput()->withErrors(['email' => "Eメールアドレスはすでに使用されています"]);
      }
    }

　　return "登録完了";
}

パラメータにおいて、$requestのタイプが、RequestからMemberRequestに変わったことに注意してください。

さて、validateの関数のコールはどこへ行ったのでしょうね？

validateの関数のコールは、MemberRequestのオブジェクトが生成されるとともに、その中で実行されます。そしてエラーがあれば画面にエラーを表示し、エラーがなければ、postSignup()の残りのコードを処理します。

今回はシンプルな例でしたが、将来はより複雑な例を紹介しましょう。