ルールロジックのファイルを作る

Laravel8でカスタムルールを作成してテストする。

2022.01.22

こんにちはjunです。最近Laravelをガッツリ使うプロジェクトがありました。APIではバリデーションを通す際、Laravel標準のルールでは対応できないものがあったのでカスタムルールを作りました。

対応できないものは以下の通りです。

ひらがな
独自のユーザー名ルール
独自のパスワードルール

この記事ではFormRequestでも簡単に使えるようなカスタムルールの作り方と、テストの方法を解説したと思います。

ルールロジックのファイルを作る

Laravelでは以下のコマンドで一発でルールクラスを作ってくれます。

php artisan make:rule RuleName

そうすると app/Rules配下に新しいファイルが作成されます。（ディレクトリはない場合、自動的に作られます。）

ルールファイルは以下のような構成になっています。

app/Rules/RuleName.php

<?php

namespace App\Rules;

use Illuminate\Contracts\Validation\Rule;

class RuleName implements Rule
{
    /**
     * Create a new rule instance.
     *
     * @return void
     */
    public function __construct()
    {
        //
    }

    /**
     * Determine if the validation rule passes.
     *
     * @param  string  $attribute
     * @param  mixed  $value
     * @return bool
     */
    public function passes($attribute, $value)
    {
        // ここに判定ロジックを記述する。最終的に判定結果のBooleanを返す
    }

    /**
     * Get the validation error message.
     *
     * @return string
     */
    public function message()
    {
        // エラー時のメッセージ
        return 'The validation error message.';
    }
}