NaifyForm

NaifyFormとは

入力チェックの条件やエラー文言がコントローラや画面ごとに散らばると、仕様変更のたびに確認する範囲が広がります。

NaifyForm（ナイフィフォーム）は、受け付けるフィールドの定義、入力値の検証、エラーメッセージの整形・管理を1か所にまとめるパッケージです。Form・Field・Validator・Messageに役割を分け、どの項目をどのルールで検証するかをコード上で追いやすくしています。

HTTPリクエストやセッション、DB、テンプレートエンジンには直接依存しません。配列の入力データを渡して検証できるため、WebフォームだけでなくAPIやバッチ処理の入力チェックにも同じ書き方で使えます。

使い始めるには

NaifyForm\NaifyFormからフォームを生成し、set()で受け付ける項目と検証ルールを定義します。Session::form()やSession::csrf()と組み合わせた確認画面付きフォーム（入力→確認→登録→完了）の全体コードは、フォームと入力検証の実装例で紹介しています。

use NaifyForm\NaifyForm;

require __DIR__ . '/libs/NaifyForm/NaifyForm.php';
NaifyForm::boot();

$form = NaifyForm::create($_POST);

$form->set('name', 'お名前')
    ->required()
    ->isString()
    ->length(1, 50);

$form->set('email', 'メールアドレス')
    ->required()
    ->isString()
    ->isEmail();

$form->set('age', '年齢')
    ->isInteger()
    ->range(18, 120);

if ($form->validate()->hasError()) {
    $messages = $form->getMessages();     // 項目ごとのエラーメッセージ配列
    $errorList = $form->getMessageList(); // 1次元のエラーメッセージ一覧
    return;
}

// 定義したフィールド（name, email, age）の入力値だけを取得する
$data = $form->getInput();

getInput()は、set()で定義した項目のキーだけを元の入力配列から抽出して返します。未定義の余分なパラメータが後続の処理へ混ざるのを防げます。値の型変換やトリムなどの暗黙な書き換えは行いません。

検証ルールとメッセージ管理

Fieldのメソッドをつなげて、必須・型・文字種・長さ・数値範囲・選択肢・他項目との一致・トークン一致などのルールを登録できます。

エラーメッセージは、アプリ全体の共通文言、特定項目だけの文言、フィールド個別の文言の順で上書きできます。DBの重複確認など、単項目ルール以外の業務エラーもaddError()で同じ結果にまとめられます。

// アプリ全体や特定項目のメッセージをまとめて設定する
NaifyForm::message()->load([
    'is_required'       => '{%label%}を入力してください。',
    'email.is_required' => '連絡先メールアドレスは必須です。',
]);

// フィールド単位でメッセージを上書きする
$form->set('password_confirm', '確認用パスワード')
    ->required()
    ->sameField('password')
    ->message->set('is_same_field', '{%same_field%}と同じ値を入力してください。');

// ルール検証のあとに業務上のエラーを追加する
if (!$form->validate()->hasError() && $userRepo->existsEmail($form->getInput()['email'])) {
    $form->addError('email', 'このメールアドレスはすでに登録されています。', 'duplicate');
}

対応する範囲

主要クラス

普段の実装では、入口のNaifyFormと、項目定義・検証結果を受け持つForm・Fieldを中心に使います。