バージョン: master

予知 (Precognition)

Introduction
ライブ検証
配列の検証
検証ルールのカスタマイズ
ファイルのアップロードの処理
副作用の管理
Testing

導入 (Introduction)

Laravel Precognition を使用すると、将来の HTTP リクエストの結果を予測できます。 Precognition の主な使用例の 1 つは、アプリケーションのバックエンド検証ルールを複製することなく、フロントエンド JavaScript アプリケーションに「ライブ」検証を提供できることです。

Laravel が「事前認識リクエスト」を受信すると、ルートのすべてのミドルウェアが実行され、フォームリクエストの検証を含むルートのコントローラの依存関係が解決されますが、実際にはルートのコントローラメソッドは実行されません。

Inertia 2.3 では、Precognition サポートが組み込まれています。詳細については、Inertiaフォームのドキュメントを参照してください。以前の Inertia バージョンには Precognition 0.x が必要です。

ライブ検証 (Live Validation)

Vueの使用

Laravel Precognition を使用すると、フロントエンド Vue アプリケーションで検証ルールを複製することなく、ライブ検証エクスペリエンスをユーザーに提供できます。その仕組みを説明するために、アプリケーション内で新しいユーザーを作成するためのフォームを構築してみましょう。

まず、ルートの事前認識を有効にするには、HandlePrecognitiveRequests ミドルウェアをルート定義に追加する必要があります。ルートの検証ルールを格納するフォームリクエストも作成する必要があります。

use App\Http\Requests\StoreUserRequest;
use Illuminate\Foundation\Http\Middleware\HandlePrecognitiveRequests;

Route::post('/users', function (StoreUserRequest $request) {
    // ...
})->middleware([HandlePrecognitiveRequests::class]);

次に、NPM 経由で Vue 用の Laravel Precognition フロントエンドヘルパをインストールする必要があります。

npm install laravel-precognition-vue

Laravel Precognition パッケージがインストールされていると、Precognition の useForm 関数を使用してフォームオブジェクトを作成し、HTTP メソッド (post)、ターゲット URL (/users)、および初期フォームデータを提供できるようになります。

次に、ライブ検証を有効にするには、入力の名前を指定して、各入力の change イベントでフォームの validate メソッドを呼び出します。

<script setup>
import { useForm } from 'laravel-precognition-vue';

const form = useForm('post', '/users', {
    name: '',
    email: '',
});

const submit = () => form.submit();
</script>

<template>
    <form @submit.prevent="submit">
        <label for="name">Name</label>
        <input
            id="name"
            v-model="form.name"
            @change="form.validate('name')"
        />
        <div v-if="form.invalid('name')">
            {{ form.errors.name }}
        </div>

        <label for="email">Email</label>
        <input
            id="email"
            type="email"
            v-model="form.email"
            @change="form.validate('email')"
        />
        <div v-if="form.invalid('email')">
            {{ form.errors.email }}
        </div>

        <button :disabled="form.processing">
            Create User
        </button>
    </form>
</template>

ユーザーがフォームに入力すると、Precognition はルートのフォームリクエスト内の検証ルールを活用したライブ検証出力を提供します。フォームの入力が変更されると、デバウンスされた「プリコグニティブ」検証リクエストが Laravel アプリケーションに送信されます。フォームの setValidationTimeout 関数を呼び出すことで、デバウンスタイムアウトを構成できます。

form.setValidationTimeout(3000);

検証リクエストが進行中の場合、フォームの validating プロパティは true になります。

<div v-if="form.validating">
    Validating...
</div>

検証リクエストまたはフォームの送信中に返された検証エラーは、フォームの errors オブジェクトに自動的に設定されます。

<div v-if="form.invalid('email')">
    {{ form.errors.email }}
</div>

フォームの hasErrors プロパティを使用して、フォームにエラーがあるかどうかを確認できます。

<div v-if="form.hasErrors">
    <!-- ... -->
</div>

入力の名前をフォームの valid 関数と invalid 関数にそれぞれ渡すことで、入力が検証に合格したか失敗したかを判断することもできます。

<span v-if="form.valid('email')">
    ✅
</span>

<span v-else-if="form.invalid('email')">
    ❌
</span>

フォーム入力は、変更されて検証応答が受信された場合にのみ、有効または無効として表示されます。

Precognition を使用してフォームの入力のサブセットを検証している場合、エラーを手動でクリアすると便利な場合があります。これを実現するには、フォームの forgetError 関数を使用できます。

<input
    id="avatar"
    type="file"
    @change="(e) => {
        form.avatar = e.target.files[0]

        form.forgetError('avatar')
    }"
>

これまで見てきたように、入力の change イベントにフックして、ユーザーが操作する個々の入力を検証できます。ただし、ユーザーがまだ操作していない入力を検証する必要がある場合があります。これは、次のステップに進む前に、ユーザーが操作したかどうかに関係なく、表示されているすべての入力を検証する「ウィザード」を構築する場合に一般的です。

Precognition を使用してこれを行うには、validate メソッドを呼び出して、検証するフィールド名を only 構成キーに渡す必要があります。検証結果は、onSuccess または onValidationError コールバックで処理できます。

<button
    type="button"
    @click="form.validate({
        only: ['name', 'email', 'phone'],
        onSuccess: (response) => nextStep(),
        onValidationError: (response) => /* ... */,
    })"
>Next Step</button>

もちろん、フォーム送信に対する応答に応じてコードを実行することもできます。フォームの submit 関数は、Axios リクエストの Promise を返します。これにより、応答ペイロードにアクセスしたり、送信成功時にフォーム入力をリセットしたり、失敗したリクエストを処理したりするための便利な方法が提供されます。

const submit = () => form.submit()
    .then(response => {
        form.reset();

        alert('User created.');
    })
    .catch(error => {
        alert('An error occurred.');
    });

フォームの processing プロパティを検査することで、フォーム送信リクエストが処理中かどうかを判断できます。

<button :disabled="form.processing">
    Submit
</button>

反応の使用

Laravel Precognition を使用すると、フロントエンド React アプリケーションで検証ルールを複製することなく、ライブ検証エクスペリエンスをユーザーに提供できます。その仕組みを説明するために、アプリケーション内で新しいユーザーを作成するためのフォームを構築してみましょう。

use App\Http\Requests\StoreUserRequest;
use Illuminate\Foundation\Http\Middleware\HandlePrecognitiveRequests;

Route::post('/users', function (StoreUserRequest $request) {
    // ...
})->middleware([HandlePrecognitiveRequests::class]);

次に、NPM 経由で React 用の Laravel Precognition フロントエンドヘルパをインストールする必要があります。

npm install laravel-precognition-react

ライブ検証を有効にするには、各入力の change および blur イベントをリッスンする必要があります。 change イベントハンドラーでは、setData 関数を使用してフォームのデータを設定し、入力の名前と新しい値を渡す必要があります。次に、blur イベントハンドラーで、入力の名前を指定してフォームの validate メソッドを呼び出します。

import { useForm } from 'laravel-precognition-react';

export default function Form() {
    const form = useForm('post', '/users', {
        name: '',
        email: '',
    });

    const submit = (e) => {
        e.preventDefault();

        form.submit();
    };

    return (
        <form onSubmit={submit}>
            <label htmlFor="name">Name</label>
            <input
                id="name"
                value={form.data.name}
                onChange={(e) => form.setData('name', e.target.value)}
                onBlur={() => form.validate('name')}
            />
            {form.invalid('name') && <div>{form.errors.name}</div>}

            <label htmlFor="email">Email</label>
            <input
                id="email"
                value={form.data.email}
                onChange={(e) => form.setData('email', e.target.value)}
                onBlur={() => form.validate('email')}
            />
            {form.invalid('email') && <div>{form.errors.email}</div>}

            <button disabled={form.processing}>
                Create User
            </button>
        </form>
    );
};

form.setValidationTimeout(3000);

検証リクエストが進行中の場合、フォームの validating プロパティは true になります。

{form.validating && <div>Validating...</div>}

検証リクエストまたはフォームの送信中に返された検証エラーは、フォームの errors オブジェクトに自動的に設定されます。

{form.invalid('email') && <div>{form.errors.email}</div>}

フォームの hasErrors プロパティを使用して、フォームにエラーがあるかどうかを確認できます。

{form.hasErrors && <div><!-- ... --></div>}

入力の名前をフォームの valid 関数と invalid 関数にそれぞれ渡すことで、入力が検証に合格したか失敗したかを判断することもできます。

{form.valid('email') && <span>✅</span>}

{form.invalid('email') && <span>❌</span>}

フォーム入力は、変更されて検証応答が受信された場合にのみ、有効または無効として表示されます。

<input
    id="avatar"
    type="file"
    onChange={(e) => {
        form.setData('avatar', e.target.files[0]);

        form.forgetError('avatar');
    }}
>

これまで見てきたように、入力の blur イベントにフックして、ユーザーが操作する個々の入力を検証できます。ただし、ユーザーがまだ操作していない入力を検証する必要がある場合があります。これは、次のステップに進む前に、ユーザーが操作したかどうかに関係なく、表示されているすべての入力を検証する「ウィザード」を構築する場合に一般的です。

<button
    type="button"
    onClick={() => form.validate({
        only: ['name', 'email', 'phone'],
        onSuccess: (response) => nextStep(),
        onValidationError: (response) => /* ... */,
    })}
>Next Step</button>

もちろん、フォーム送信に対する応答に応じてコードを実行することもできます。フォームの submit 関数は、Axios リクエストの Promise を返します。これにより、応答ペイロードにアクセスしたり、フォーム送信が成功したときにフォームの入力をリセットしたり、失敗したリクエストを処理したりするための便利な方法が提供されます。

const submit = (e) => {
    e.preventDefault();

    form.submit()
        .then(response => {
            form.reset();

            alert('User created.');
        })
        .catch(error => {
            alert('An error occurred.');
        });
};

フォームの processing プロパティを検査することで、フォーム送信リクエストが処理中かどうかを判断できます。

<button disabled={form.processing}>
    Submit
</button>

Alpine と Blade の使用

Laravel Precognition を使用すると、フロントエンド Alpine アプリケーションで検証ルールを複製することなく、ライブ検証エクスペリエンスをユーザーに提供できます。その仕組みを説明するために、アプリケーション内で新しいユーザーを作成するためのフォームを構築してみましょう。

use App\Http\Requests\CreateUserRequest;
use Illuminate\Foundation\Http\Middleware\HandlePrecognitiveRequests;

Route::post('/users', function (CreateUserRequest $request) {
    // ...
})->middleware([HandlePrecognitiveRequests::class]);

次に、NPM 経由で Alpine 用の Laravel Precognition フロントエンドヘルパをインストールする必要があります。

npm install laravel-precognition-alpine

次に、resources/js/app.js ファイルで Precognition プラグインを Alpine に登録します。

import Alpine from 'alpinejs';
import Precognition from 'laravel-precognition-alpine';

window.Alpine = Alpine;

Alpine.plugin(Precognition);
Alpine.start();

Laravel Precognition パッケージをインストールして登録すると、Precognition の $form "マジック" を使用してフォームオブジェクトを作成し、HTTP メソッド (post)、ターゲット URL (/users)、および初期フォームデータを提供できるようになります。

ライブ検証を有効にするには、フォームのデータを関連する入力にバインドし、各入力の change イベントをリッスンする必要があります。 change イベントハンドラーでは、入力の名前を指定してフォームの validate メソッドを呼び出す必要があります。

<form x-data="{
    form: $form('post', '/register', {
        name: '',
        email: '',
    }),
}">
    @csrf
    <label for="name">Name</label>
    <input
        id="name"
        name="name"
        x-model="form.name"
        @change="form.validate('name')"
    />
    <template x-if="form.invalid('name')">
        <div x-text="form.errors.name"></div>
    </template>

    <label for="email">Email</label>
    <input
        id="email"
        name="email"
        x-model="form.email"
        @change="form.validate('email')"
    />
    <template x-if="form.invalid('email')">
        <div x-text="form.errors.email"></div>
    </template>

    <button :disabled="form.processing">
        Create User
    </button>
</form>

form.setValidationTimeout(3000);

検証リクエストが進行中の場合、フォームの validating プロパティは true になります。

<template x-if="form.validating">
    <div>Validating...</div>
</template>

検証リクエストまたはフォームの送信中に返された検証エラーは、フォームの errors オブジェクトに自動的に設定されます。

<template x-if="form.invalid('email')">
    <div x-text="form.errors.email"></div>
</template>

フォームの hasErrors プロパティを使用して、フォームにエラーがあるかどうかを確認できます。

<template x-if="form.hasErrors">
    <div><!-- ... --></div>
</template>

入力の名前をフォームの valid 関数と invalid 関数にそれぞれ渡すことで、入力が検証に合格したか失敗したかを判断することもできます。

<template x-if="form.valid('email')">
    <span>✅</span>
</template>

<template x-if="form.invalid('email')">
    <span>❌</span>
</template>

フォーム入力は、変更されて検証応答が受信された場合にのみ、有効または無効として表示されます。

<button
    type="button"
    @click="form.validate({
        only: ['name', 'email', 'phone'],
        onSuccess: (response) => nextStep(),
        onValidationError: (response) => /* ... */,
    })"
>Next Step</button>

フォームの processing プロパティを検査することで、フォーム送信リクエストが処理中かどうかを判断できます。

<button :disabled="form.processing">
    Submit
</button>

古いフォームデータを再入力する

上で説明したユーザー作成の例では、Precognition を使用してライブ検証を実行しています。ただし、フォームを送信するために従来のサーバー側のフォーム送信を実行しています。したがって、サーバー側のフォーム送信から返された「古い」入力エラーと検証エラーをフォームに入力する必要があります。

<form x-data="{
    form: $form('post', '/register', {
        name: '{{ old('name') }}',
        email: '{{ old('email') }}',
    }).setErrors({{ Js::from($errors->messages()) }}),
}">

あるいは、XHR 経由でフォームを送信したい場合は、Axios リクエスト Promise を返すフォームの submit 関数を使用することもできます。

<form
    x-data="{
        form: $form('post', '/register', {
            name: '',
            email: '',
        }),
        submit() {
            this.form.submit()
                .then(response => {
                    this.form.reset();

                    alert('User created.')
                })
                .catch(error => {
                    alert('An error occurred.');
                });
        },
    }"
    @submit.prevent="submit"
>

Axiosの構成

Precognition 検証ライブラリは、Axios HTTP クライアントを使用して、アプリケーションのバックエンドにリクエストを送信します。便宜上、アプリケーションで必要に応じて Axios インスタンスをカスタマイズできます。たとえば、laravel-precognition-vue ライブラリを使用する場合、アプリケーションの resources/js/app.js ファイル内の各送信リクエストに追加のリクエストヘッダーを追加できます。

import { client } from 'laravel-precognition-vue';

client.axios().defaults.headers.common['Authorization'] = authToken;

または、アプリケーション用に構成された Axios インスタンスがすでにある場合は、代わりにそのインスタンスを使用するように Precognition に指示することもできます。

import Axios from 'axios';
import { client } from 'laravel-precognition-vue';

window.axios = Axios.create()
window.axios.defaults.headers.common['Authorization'] = authToken;

client.use(window.axios)

配列の検証 (Validating Arrays)

ワイルドカードを使用して、配列またはネストされたオブジェクト内のフィールドを検証できます。各 * は単一のパスセグメントと一致します。

// Validate email for all users in an array...
form.validate('users.*.email');

// Validate all fields in a profile object...
form.validate('profile.*');

// Validate all fields for all users...
form.validate('users.*.*');

検証ルールのカスタマイズ (Customizing Validation Rules)

リクエストの isPrecognitive メソッドを使用して、予測リクエスト中に実行される検証ルールをカスタマイズできます。

たとえば、ユーザー作成フォームでは、最終的なフォーム送信時にのみパスワードが「侵害されていない」ことを検証したい場合があります。予知的検証リクエストの場合、パスワードが必須であり、最低 8 文字であることを単純に検証します。 isPrecognitive メソッドを使用すると、フォームリクエストで定義されたルールをカスタマイズできます。

<?php

namespace App\Http\Requests;

use Illuminate\Foundation\Http\FormRequest;
use Illuminate\Validation\Rules\Password;

class StoreUserRequest extends FormRequest
{
    /**
     * Get the validation rules that apply to the request.
     *
     * @return array
     */
    protected function rules()
    {
        return [
            'password' => [
                'required',
                $this->isPrecognitive()
                    ? Password::min(8)
                    : Password::min(8)->uncompromised(),
            ],
            // ...
        ];
    }
}

ファイルのアップロードの処理 (Handling File Uploads)

デフォルトでは、Laravel Precognition は、事前認識検証リクエスト中にファイルをアップロードまたは検証しません。これにより、大きなファイルが不必要に複数回アップロードされることがなくなります。

この動作のため、フィールドを指定するアプリケーション対応するフォームリクエストの検証ルールをカスタマイズしますが完全なフォーム送信の場合にのみ必要であることを確認する必要があります。

/**
 * Get the validation rules that apply to the request.
 *
 * @return array
 */
protected function rules()
{
    return [
        'avatar' => [
            ...$this->isPrecognitive() ? [] : ['required'],
            'image',
            'mimes:jpg,png',
            'dimensions:ratio=3/2',
        ],
        // ...
    ];
}

すべての検証リクエストにファイルを含めたい場合は、クライアント側のフォームインスタンスで validateFiles 関数を呼び出すことができます。

form.validateFiles();

副作用の管理 (Managing Side-Effects)

HandlePrecognitiveRequests ミドルウェアをルートに追加するときは、予測リクエスト中にスキップする必要がある他のミドルウェアに副作用があるかどうかを考慮する必要があります。

たとえば、各ユーザーがアプリケーションと行う「インタラクション」の合計数を増加させるミドルウェアがある場合でも、事前認識リクエストをインタラクションとしてカウントしたくない場合があります。これを実現するには、インタラクション数を増やす前に、リクエストの isPrecognitive メソッドをチェックします。

<?php

namespace App\Http\Middleware;

use App\Facades\Interaction;
use Closure;
use Illuminate\Http\Request;

class InteractionMiddleware
{
    /**
     * Handle an incoming request.
     */
    public function handle(Request $request, Closure $next): mixed
    {
        if (! $request->isPrecognitive()) {
            Interaction::incrementFor($request->user());
        }

        return $next($request);
    }
}

テスト (Testing)

テストで事前認識リクエストを作成したい場合、Laravel の TestCase には、Precognition リクエストヘッダーを追加する withPrecognition ヘルパが含まれています。

さらに、予知的リクエストが成功したことを主張したい場合、たとえば検証エラーを返さなかった場合は、レスポンスで assertSuccessfulPrecognition メソッドを使用できます。

it('validates registration form with precognition', function () {
    $response = $this->withPrecognition()
        ->post('/register', [
            'name' => 'Taylor Otwell',
        ]);

    $response->assertSuccessfulPrecognition();

    expect(User::count())->toBe(0);
});

public function test_it_validates_registration_form_with_precognition()
{
    $response = $this->withPrecognition()
        ->post('/register', [
            'name' => 'Taylor Otwell',
        ]);

    $response->assertSuccessfulPrecognition();
    $this->assertSame(0, User::count());
}

導入 (Introduction)​

ライブ検証 (Live Validation)​

Vueの使用​

反応の使用​

Alpine と Blade の使用​

古いフォームデータを再入力する​

Axiosの構成​

配列の検証 (Validating Arrays)​

検証ルールのカスタマイズ (Customizing Validation Rules)​

ファイルのアップロードの処理 (Handling File Uploads)​

副作用の管理 (Managing Side-Effects)​

テスト (Testing)​

導入 (Introduction)

ライブ検証 (Live Validation)

Vueの使用

反応の使用

Alpine と Blade の使用

古いフォームデータを再入力する

Axiosの構成

配列の検証 (Validating Arrays)

検証ルールのカスタマイズ (Customizing Validation Rules)

ファイルのアップロードの処理 (Handling File Uploads)

副作用の管理 (Managing Side-Effects)

テスト (Testing)