導入 - 検証およびフィルタ

クライアント側の検証

QuickForm によって、クライアント側でのフォームの検証に必要な javascript を生成することができます。 この機能は、あらゆる型の要素あるいはグループに対して使用できます。 クライアント側で javascript が off になっている場合は、 サーバ側の検証が常に実行されます。

$form->addRule('email', 'E-Mail is required', 'required', null, 'client');

組み込みの検証規則

QuickForm では、フォームの検証によく使用されるいくつかの規則を組み込みで提供しています。 中には、追加のパラメータ $format を addRule() / addGroupRule() に渡す必要があるものもあります。

検証クラス

リリース 3.2 以降、組み込みの検証規則はすべて HTML_QuickForm_Rule クラスのサブクラスとなります。独自のサブクラスを作成し、validate() および getValidationScript() の両メソッドを実装することも可能です。 実際の例は、ソースを参照ください。

検証関数およびメソッド

もっと複雑な検証が必要な場合、QuickForm では独自の関数を使用して 要素やグループの検証を行うことが可能です。また、クラスのメソッドをコールすることもできます。 この場合ｈあ、PEAR の Validate パッケージやその他のクラスが使用できます。 独自の関数を使用したい場合には、以下の 2 つの選択肢があります。

1. registerRule() を使用して関数を登録します。$type には 'callback' を使用し、新しい規則名を $ruleName で指定します。その後 addRule() を使用する際に、この名前を他の組み込み規則と同じように使用できます。

2. addRule() で callback 型の規則を追加し、関数の名前を $format に渡します。こちらのほうがタイプ数が少なくなりますが、 検証用の関数に追加のデータを渡すことができなくなります。

/**
 * email アドレスを検証します
 *
 * @param string    $email         検証する Email アドレス
 * @param boolean   $domainCheck   ドメインの存在をチェックするかどうか
 */
function checkEmail($email, $domainCheck = false)
{
    if (preg_match('/^[a-zA-Z0-9\._-]+\@(\[?)[a-zA-Z0-9\-\.]+'.
                   '\.([a-zA-Z]{2,4}|[0-9]{1,3})(\]?)$/', $email)) {
        if ($domainCheck && function_exists('checkdnsrr')) {
            list (, $domain)  = explode('@', $email);
            if (checkdnsrr($domain, 'MX') || checkdnsrr($domain, 'A')) {
                return true;
            }
            return false;
        }
        return true;
    }
    return false;
}
$form->registerRule('checkmail', 'callback', 'checkEmail');
$form->addRule('email', 'Email が不正です', 'checkmail', true);

HTML_QuickForm::addRule() で、関数に渡す追加のパラメータを指定することができます。 ここでは、TRUE を渡すことで関数内での DNS チェックを有効にしています。

メソッドを使用する場合は、そのメソッドが存在するクラスを指定しなければなりません。 規則を登録する際に以下のような構文を使用します。

// checkEmail メソッドが Validate クラス内に存在します。 $form->registerRule('checkmail', 'callback', 'checkEmail', 'Validate');

グループの検証

要素グループについてもその他の要素と同じ方法で検証することができます。 あるいはより複雑な検証方法を使用することも可能です。グループ全体を検証するには、 単に HTML_QuickForm::addRule() を使用します。 グループの各要素の値が、配列として検証関数に渡されます。

HTML_QuickForm::addGroupRule() メソッドを使用すると、 より複雑な検証規則を適用することができます。これは、グループ内の要素ごとに検証を行うことができます。 また、グループ内の要素のうち何個が検証規則を満たせばそのグループを有効とみなすかを指定することもできます。

// グループ
$id[] = &HTML_QuickForm::createElement('text', 'username', 'ユーザ名');
$id[] = &HTML_QuickForm::createElement('text', 'code', 'コード');
$form->addGroup($id, 'id', 'あなたの ID:', '-');

// 要素ごとの検証規則

$rule['username'][] = array('ユーザ名は必須です', 'required');
$rule['username'][] = array('ユーザ名には文字のみが使用できます', 'lettersonly');
$rule['username'][] = array('ユーザ名の長さは 5 文字から 8 文字までです', 'rangelength', array(5, 8));

$rule['code'][] = array('コードは必須です', 'required');
$rule['code'][] = array('コードには数字のみが使用できます', 'regex', '/^\d+$/');
$rule['code'][] = array('コードの長さは 5 桁です', 'rangelength', array(5, 5));

$form->addGroupRule('id', $rule);

この例では、グループ内の要素についての検証規則を設定しています。 要素名を使用する代わりに、(作成された順番によって決まる) グループ内のインデックスを使用することもできます。 そのほうが検証の速度が速くなるでしょう。

次の例では、同じグループに対して 2 つの要素のうち少なくとも一方が入力されているかどうかのみを検証します。 これを実現するには、howmany パラメータを使用して、 そこに 1 を設定します。

$form->addGroupRule('id', '少なくとも 1 つの要素を入力してください', 'required', null, 1);

まとめ

これまで見てきたとおり、QuickForm を使用すると、要素やグループの検証がとても簡単になります。 毎度毎度同じようなコードで値が異なるだけという検証コードを書く必要がなくなるのです。 必須要素の確認もしてくれますし、javascript のコードも自動で生成してくれます。 また独自の関数や正規表現を使用して独自の検証を行えるという柔軟性もあります。 さあ、そろそろ試してみませんか ...?