フォームバリデーション（検証）¶

CodeIgniter では包括的なフォーム検証とデータ準備のクラスを提供します。あなたが書くつもりのコード量を最小限に抑えることができるでしょう。

Page Contents

フォームバリデーション（検証）

概要 ¶

CodeIgniter のデータ検証に対するアプローチを説明する前に、理想的なシナリオを説明してみましょう:

フォームが表示されます。
それを記入し、送信します。
無効なものを送信したなら、つまりもしかしたら必須項目を逃した場合は、問題を説明するエラーメッセージとともにフォームはあなたのデータを再表示します。
有効なフォームを送信するまで、このプロセスが継続します。

受信側では、スクリプトは次のことを満たす必要があります:

必須データを確認します。
データが正しい型であり、正しく基準を満たしていることを確認します。例えばユーザ名が送信された場合、許可された文字だけを含むように検証する必要があります。これは最小長より大きく、最大長を超えてはなりません。ユーザ名は他の誰かの既存ユーザ名は使えず、またはおそらく予約語も使えません。など。
セキュリティのためにデータをサニタイズします。
必要に応じてデータをプリフォーマットします（データはトリミングを必要とする？　HTML のエンコードは？　など）。
データベースに挿入するためのデータを準備します。

上記のプロセスはひどく複雑なものではありませんが、通常はかなりの量コードを必要とします。エラーメッセージを表示するためには通常、様々な制御構造がフォームの HTML 内に配置されます。フォームバリデーションは作成は簡単ながら、一般的には非常に面倒で退屈な実装作業になります。

フォームバリデーションチュートリアル ¶

以下は CodeIgniter のフォームバリデーションを実装するための「ハンズオン」チュートリアルです。

フォームバリデーションを実装するためには次の 3 つが必要になります:

フォームを持つ ビュー ファイル。
送信成功の時に表示される「成功」メッセージを含むビューファイル。
送信されたデータを受信および処理する コントローラ メソッド。

それではサンプルとしてメンバー登録フォームを使い、これらの 3 つを作成してみましょう。

入力フォーム ¶

テキストエディタを使用して、 myform.php というフォームを作成します。それには application/views/ フォルダにこのコードを配置して保存します:

<html>
<head>
<title>私のフォーム</title>
</head>
<body>

<?php echo validation_errors(); ?>

<?php echo form_open('form'); ?>

<h5>ユーザ名</h5>
<input type="text" name="username" value="" size="50" />

<h5>パスワード</h5>
<input type="text" name="password" value="" size="50" />

<h5>パスワード確認</h5>
<input type="text" name="passconf" value="" size="50" />

<h5>メールアドレス</h5>
<input type="text" name="email" value="" size="50" />

<div><input type="submit" value="Submit" /></div>

</form>

</body>
</html>

成功ページ ¶

テキストエディタを使用して、 formsuccess.php というフォームを作成します。それには application/views/ フォルダにこのコードを配置して保存します:

<html>
<head>
<title>私のフォーム</title>
</head>
<body>

<h3>あなたのフォームは送信成功しました！</h3>

<p><?php echo anchor('form', 'もういっかい！'); ?></p>

</body>
</html>

コントローラ ¶

テキストエディタを使用して、 Form.php というコントローラを作成します。それには application/controllers フォルダにこのコードを配置して保存します:

<?php

class Form extends CI_Controller {

        public function index()
        {
                $this->load->helper(array('form', 'url'));

                $this->load->library('form_validation');

                if ($this->form_validation->run() == FALSE)
                {
                        $this->load->view('myform');
                }
                else
                {
                        $this->load->view('formsuccess');
                }
        }
}

動かしてみよう！¶

フォームを試すには次のようなURLを使ってサイトを開いてください:

example.com/index.php/form/

フォームを送信すると、単にフォームがリロードされるはずです。それはまだ検証ルールを設定していないためです。

フォームバリデーションクラスに何の検証も指示していないので、デフォルトの FALSE（ブール偽）を返します。 ``run()`` メソッドはあなたのルールを適用でき、 1 つも失敗しなかった場合にのみ TRUE を返します。

解説 ¶

上記のページについて、いくつかのことに気付いたことでしょう。:

このフォーム（myform.php）は標準的な Web フォームですが、 2 つの例外があります:

フォームの開きタグを作成するために、フォームヘルパーを使用しています。技術的には、これは必須ではありません。標準の HTML を使用してフォームを作成することもできます。しかしながらヘルパーを使用する利点として、 config ファイル内の URL に基づいてアクション URL を生成することができます。これはあなたのURLを変更する際に、アプリケーションをよりポータブルにしてくれます。
フォームの一番上のところで、次の関数呼び出しに気付くでしょう:
```
<?php echo validation_errors(); ?>
```
この関数は、バリデータによって戻されたすべてのエラーメッセージを返します。メッセージがない場合、空の文字列を返します。

コントローラ（Form.php）には 1 つのメソッドがあります: index() です。このメソッドはバリデーションクラスを初期化し、ビューファイルで使用されるフォームヘルパーと URL ヘルパーをロードします。また、バリデーションルーチンを実行します。検証が成功したかどうかに基づいて、フォームと成功ページのどちらかを表示します。

検証ルールを設定する ¶

CodeIgniter は、与えられたフィールドに必要なだけの多くの検証ルールを設定することができ、その順序でカスケード処理し、さらには同時にフィールドデータの準備と前処理をすることができます。検証ルールを設定するには set_rules() メソッドを使用します:

$this->form_validation->set_rules();

上のメソッドは、入力として 3 つ のパラメータを取ります:

フィールド名 - フォームフィールドを与えた正確な名前。
このフィールドの「人間向け」の名前。エラーメッセージに挿入されます。たとえば、フィールドに「user」と名付けた場合、人間向けの名前として「ユーザ名」と名付けるかもしれません。
このフォームフィールドの検証ルール。
（オプション）このフィールドに指定された任意のルールにカスタムエラーメッセージを設定します。指定されない場合、デフォルトのエラーメッセージを使用します。

注釈

言語ファイルに格納されているフィールド名をご希望の場合、 フィールド名の翻訳 を参照してください。

ここで一例を示しましょう。コントローラ（Form.php）で、バリデーション初期化メソッドの直下にこのコードを追加します:

$this->form_validation->set_rules('username', 'ユーザ名', 'required');
$this->form_validation->set_rules('password', 'パスワード', 'required');
$this->form_validation->set_rules('passconf', 'パスワード確認', 'required');
$this->form_validation->set_rules('email', 'メールアドレス', 'required');

コントローラは次のようになります:

<?php

class Form extends CI_Controller {

        public function index()
        {
                $this->load->helper(array('form', 'url'));

                $this->load->library('form_validation');

                $this->form_validation->set_rules('username', 'ユーザ名', 'required');
                $this->form_validation->set_rules('password', 'パスワード', 'required',
                        array('required' => '%s は必須です。')
                );
                $this->form_validation->set_rules('passconf', 'パスワード確認', 'required');
                $this->form_validation->set_rules('email', 'メールアドレス', 'required');

                if ($this->form_validation->run() == FALSE)
                {
                        $this->load->view('myform');
                }
                else
                {
                        $this->load->view('formsuccess');
                }
        }
}

いま、フィールドが空欄のままフォームを送信すると、エラーメッセージが表示されるはずです。すべてのフィールドを埋めてフォームを送信すると、成功ページが表示されるでしょう。

注釈

エラーが存在するとき、フォームフィールドはまだ入力データで埋めなおされず空欄のままです。すぐあとで説明します。

配列を使った検証ルールの指定 ¶

先に進む前に、次のことに注意すべきです。単一の操作ですべてのルールを設定したい場合は、配列を渡すことができます。この方法を使う場合、つぎに示されているように、配列のキーに名前を付ける必要があります:

$config = array(
        array(
                'field' => 'username',
                'label' => 'ユーザ名',
                'rules' => 'required'
        ),
        array(
                'field' => 'password',
                'label' => 'パスワード',
                'rules' => 'required',
                'errors' => array(
                        'required' => '%s は必須です。',
                ),
        ),
        array(
                'field' => 'passconf',
                'label' => 'パスワード確認',
                'rules' => 'required'
        ),
        array(
                'field' => 'email',
                'label' => 'メールアドレス',
                'rules' => 'required'
        )
);

$this->form_validation->set_rules($config);

ルールの連結（カスケード）¶

CodeIgniter では複数のルールをパイプで一緒につなげることができます。試してみましょう。ルール設定メソッドの第 3 パラメータに指定するルールを変更します。このように:

$this->form_validation->set_rules(
        'username', 'ユーザ名',
        'required|min_length[5]|max_length[12]|is_unique[users.username]',
        array(
                'required'      => '%s を入力していません。',
                'is_unique'     => '%s はすでに存在します。'
        )
);
$this->form_validation->set_rules('password', 'パスワード', 'required');
$this->form_validation->set_rules('passconf', 'パスワード確認', 'required|matches[password]');
$this->form_validation->set_rules('email', 'メールアドレス', 'required|valid_email|is_unique[users.email]');

上のコードは次のルールを設定します:

ユーザ名フィールドは 5 文字未満または 12 文字を超えることはありません。
パスワードフィールドは、パスワード確認フィールドと一致する必要があります。
メールアドレスフィールドは有効なメールアドレスを含める必要があります。

試してみましょう！　まちがったデータでフォームを送信すると、新しいルールに対応する新しいエラーメッセージが表示されます。利用可能なルールは多数あり、バリデーションリファレンスでそれらについて読むことができます。

注釈

文字列のかわりに配列で set_rules() にルールを渡すことができます。例:

$this->form_validation->set_rules('username', 'ユーザ名', array('required', 'min_length[5]'));

データの整形 ¶

上記で使用しているようなバリデーションメソッドに加え、様々な方法でデータを整形することもできます。たとえば、次のようなルールを設定することができます:

$this->form_validation->set_rules('username', 'ユーザ名', 'trim|required|min_length[5]|max_length[12]');
$this->form_validation->set_rules('password', 'パスワード', 'trim|required|min_length[8]');
$this->form_validation->set_rules('passconf', 'パスワード確認', 'trim|required|matches[password]');
$this->form_validation->set_rules('email', 'メールアドレス', 'trim|required|valid_email');

上の例では、フィールドを「トリミング」し、必要なところでは文字列長をチェックし、パスワードフィールドの両方が一致することを確認しています。

あらゆる PHP ネイティブ関数のうちパラメータを 1 つ受けとるものは、ルールとして使用することができます。 ``htmlspecialchars()`` 、 ``trim()`` などです。

注釈

一般的には、バリデーションルールの後でデータ整形機能を使用したいことでしょう。エラーがある場合にオリジナルのデータをフォームに表示させるためです。

フォームの再表示（データの引き継ぎ）¶

ここまではエラーのみを取り扱ってきました。ここからは送信されたデータでフォームフィールドを埋めなおしていきましょう。CodeIgniter ではそうするためのヘルパー関数をいくつか提供しています。最も一般的に使用されるのは、次のものです:

set_value('field name')

myform.php ビューファイルを開き、 set_value() 関数を使用して各フィールドの value を変えていきましょう:

:PHP:FUNC:`set_value()` 関数呼び出しに各フィールド名を含めることを忘れないでください！

<html>
<head>
<title>私のフォーム</title>
</head>
<body>

<?php echo validation_errors(); ?>

<?php echo form_open('form'); ?>

<h5>ユーザ名</h5>
<input type="text" name="username" value="<?php echo set_value('username'); ?>" size="50" />

<h5>パスワード</h5>
<input type="text" name="password" value="<?php echo set_value('password'); ?>" size="50" />

<h5>パスワード確認</h5>
<input type="text" name="passconf" value="<?php echo set_value('passconf'); ?>" size="50" />

<h5>メールアドレス</h5>
<input type="text" name="email" value="<?php echo set_value('email'); ?>" size="50" />

<div><input type="submit" value="送信" /></div>

</form>

</body>
</html>

さて、ページをリロードしてエラーを起こすようにフォームを送信します。フォームフィールドはいま、埋めなおされたことでしょう。

注釈

下記の クラスリファレンス セクションには <select>メニュー、ラジオボタン、およびチェックボックスを埋めなおすメソッドがあります。

重要

フォームフィールドの name に配列を使用する場合は、関数に配列としてそれを指定する必要があります。例:

<input type="text" name="colors[]" value="<?php echo set_value('colors[]'); ?>" size="50" />

詳細については下記の フィールド名の指定に配列を使う セクションを参照してください。

コールバック: ユーザ定義の検証メソッド ¶

ユーザ定義の検証メソッドへのコールバックがシステムでサポートされています。これを使えば、それぞれのニーズに合わせるため検証クラスを拡張することができます。たとえば、選択したユーザが固有の名前かどうかを調べるためデータベースクエリを実行する必要があるとき、それを行うコールバックメソッドを作成できます。次に示す例のように作ってみましょう。

コントローラで、”username” ルールを次のように変更します:

$this->form_validation->set_rules('username', 'ユーザ名', 'callback_username_check');

次に username_check() という名前のメソッドをコントローラに追加します。コントローラは以下のようになっているはずです:

<?php

class Form extends CI_Controller {

        public function index()
        {
                $this->load->helper(array('form', 'url'));

                $this->load->library('form_validation');

                $this->form_validation->set_rules('username', 'ユーザ名', 'callback_username_check');
                $this->form_validation->set_rules('password', 'パスワード', 'required');
                $this->form_validation->set_rules('passconf', 'パスワードの確認', 'required');
                $this->form_validation->set_rules('email', 'メールアドレス', 'required|is_unique[users.email]');

                if ($this->form_validation->run() == FALSE)
                {
                        $this->load->view('myform');
                }
                else
                {
                        $this->load->view('formsuccess');
                }
        }

        public function username_check($str)
        {
                if ($str == 'test')
                {
                        $this->form_validation->set_message('username_check', '{field} 欄に "test" は使えません');
                        return FALSE;
                }
                else
                {
                        return TRUE;
                }
        }

}

フォームを再読み込みして、ユーザ名に “test” と入力して送信します。フォームフィールドのデータがコールバックメソッドに渡され処理されたのがわかります。

コールバックを呼び出すには、あるルールに従ってメソッド名を指定します。そのルールとは、”callback_” という プリフィックス をメソッド名に付け加えるというものです。もし、コールバックメソッドが追加のパラメータを受け取る必要がある場合、 callback_foo[bar] のようにメソッド名の後の角カッコの間にパラメータを追加してください。そうすれば、第 2 引数としてコールバックメソッドに渡されます。

注釈

また、コールバックに渡されたフォームデータを処理し、結果を返すことができます。コールバックが論理型の TRUE/FALSE 以外の値を返す場合、そのデータは新たに処理されたフォームデータであるとみなされます。

コーラブル: 何でもルールとして使う ¶

もしコールバックルールが十分でないない場合（例えば、コールバックはコントローラ内に制限されます）、がっかりしないでください。もう 1 つ独自ルールを作成する方法があります。is_callable() が TRUE を返すものをルールとする方法です。

次の例を検討してみましょう:

$this->form_validation->set_rules(
        'username', 'ユーザ名',
        array(
                'required',
                array($this->users_model, 'valid_username')
        )
);

上のコードは Users_model オブジェクトの valid_username() メソッドを使っています。

もちろんこれは 1 つの例であり、コールバック関数はモデルに限定されません。第 1 引数にフィールドの値を受け取るあらゆるオブジェクト/メソッドを使うことができます。匿名関数を使うこともできます:

$this->form_validation->set_rules(
        'username', 'ユーザ名',
        array(
                'required',
                function($value)
                {
                        // $value をチェックする
                }
        )
);

もちろん、コーラブルルールは文字列ではなく、ルール名でもありません。これは、エラーメッセージを設定したい場合、問題になります。そのため、それらのルールの配列の第 1 要素にルール名、第 2 要素にルールを記述できます:

$this->form_validation->set_rules(
        'username', 'ユーザ名',
        array(
                'required',
                array('username_callable', array($this->users_model, 'valid_username'))
        )
);

匿名関数版:

$this->form_validation->set_rules(
        'username', 'ユーザ名',
        array(
                'required',
                array(
                        'username_callable',
                        function($str)
                        {
                                // $str を検証し TRUE または FALSE を返す
                        }
                )
        )
);

エラーメッセージの設定 ¶

標準のエラーメッセージはすべて、次の言語ファイルの中にあります: system/language/english/form_validation_lang.php

あなた独自のグローバルなカスタムメッセージをルールに設定するには、 application/language/english/form_validation_lang.php で言語ファイル上書き/拡張するか（これについては 言語クラス のドキュメントを読んでください）、または次のメソッドを使用します:

$this->form_validation->set_message('rule', 'エラーメッセージ');

もし特定のルールかつ特定のフィールド用のカスタムエラーメッセージを設定する必要がある場合は、 set_rules() メソッドを使用します:

$this->form_validation->set_rules('field_name', 'フィールド名', 'rule1|rule2|rule3',
        array('rule2' => 'この field_name の rule2 に使用するエラーメッセージ')
);

ルールのところはエラーを表示したい特定のルール名に対応し、エラーメッセージのところは表示したいテキストです。

フィールドの「人間向け」の名前、またはいくつかのルールが許可しているオプションパラメータ（max_length など）を含めたい場合は、 {field} タグと {param} タグをメッセージに追加することができます:

$this->form_validation->set_message('min_length', '{field} は少なくとも {param} 文字必要です。');

人間向けの名前「ユーザ名」と min_length[5] のルールのフィールドでは、次のエラーが表示されます: “ユーザ名は少なくとも 5 文字必要です。”

注釈

%s をエラーメッセージ内に使用する古い sprintf() の方法はまだ動作しますが、しかしそれは上記のタグを上書きします。どちらか一方だけを使用すべきです。

上記のコールバックルール例では、エラーメッセージはメソッドの名前を渡すことによって設定されます（「callback_」プレフィックスは不要です）:

$this->form_validation->set_message('username_check')

フィールド名の翻訳 ¶

set_rules() メソッドに渡される「人間向け」の名前を言語ファイルに保持したい場合、つまり名前を翻訳できるようにしたい場合、方法は次のとおりです:

まず、「人間向け」の名前をにプレフィックス lang: をつけます。この例のように:

$this->form_validation->set_rules(‘first_name’, ‘lang:first_name’, ‘required’);

次に、言語ファイルの配列に名前を格納します（プレフィックスなし）:

$lang['first_name'] = '名前';

注釈

CI によって自動的にロードされない言語ファイルで配列の項目を追加する場合は、コントローラでロードすることを忘れないでください:

$this->lang->load('file_name');

言語ファイルに関する詳細情報については 言語クラス のページを見てください。

エラーメッセージを囲む文字の変更 ¶

デフォルトでは、フォームバリデーションクラスは表示する各エラーメッセージの周囲に段落タグ（<p>）を追加します。これらの区切り文字はグローバルに、あるいは個別に、はたまた設定ファイルでデフォルトを変更することができます。

グローバルに区切り文字を変更 エラーの区切り文字をグローバルに変更するには、コントローラメソッドでフォームバリデーションクラスをロードしたすぐあと、これを追加します:
```
$this->form_validation->set_error_delimiters('<div class="error">', '</div>');
```
この例では div タグを使用するように切り替えました。
個別に区切り文字を変更 このチュートリアルで示している 2 つのエラー文生成機能のそれぞれで、次のように独自の区切り文字を指定することができます:
```
<?php echo form_error('field name', '<div class="error">', '</div>'); ?>
```
または:
```
<?php echo validation_errors('<div class="error">', '</div>'); ?>
```
configファイルで区切り文字を設定 application/config/form_validation.php で次のようにエラー区切り文字を設定することができます:
```
$config['error_prefix'] = '<div class="error_prefix">';
$config['error_suffix'] = '</div>';
```

個別にエラーを表示する ¶

エラーメッセージをリストとしてではなく、各フォームフィールドの横に表示したい場合は、form_error() 関数を使用することができます。

やってみましょう！　次のようにフォームを変更します:

<h5>ユーザ名</h5>
<?php echo form_error('username'); ?>
<input type="text" name="username" value="<?php echo set_value('username'); ?>" size="50" />

<h5>パスワード</h5>
<?php echo form_error('password'); ?>
<input type="text" name="password" value="<?php echo set_value('password'); ?>" size="50" />

<h5>パスワード確認</h5>
<?php echo form_error('passconf'); ?>
<input type="text" name="passconf" value="<?php echo set_value('passconf'); ?>" size="50" />

<h5>メールアドレス</h5>
<?php echo form_error('email'); ?>
<input type="text" name="email" value="<?php echo set_value('email'); ?>" size="50" />

エラーがない場合は何も表示されません。エラーがある場合、メッセージが表示されます。

重要

フォームフィールドの名前として配列を使用する場合は、関数に配列としてそれを指定する必要があります。例:

<?php echo form_error('options[size]'); ?>
<input type="text" name="options[size]" value="<?php echo set_value("options[size]"); ?>" size="50" />

詳細については下記の フィールド名の指定に配列を使う セクションを参照してください。

配列（$_POST以外）のバリデーション ¶

時には $_POST データではない配列をバリデーションしたいことでしょう。

その場合、バリデーションする配列を指定することができます:

$data = array(
        'username' => '山田太郎',
        'password' => 'mypassword',
        'passconf' => 'mypassword'
);

$this->form_validation->set_data($data);

バリデーションルールを作成し、バリデーションを実行し、エラーメッセージを取得する一連の動作は $_POST データまたは設定した別の配列をバリデーションしているかどうかにかかわらず、同じように動作します。

重要

あらゆるバリデーションルールを定義する前に set_data() メソッドを呼び出す必要があります。

重要

1 回のプログラム実行内で複数の配列を検証したい場合は、ルールを設定して新しい配列をバリデーションする前に reset_validation() メソッドを呼び出す必要があります。

詳細については下記の クラスリファレンス セクションを参照してください。

検証ルールを設定ファイルに保存 ¶

フォームバリデーションクラスの素晴らしい機能として、アプリケーション全体のために、すべての検証ルールを設定ファイル内に保存することができます。「グループ」にこれらのルールを整理することができます。コントローラ/メソッドが一致するものを自動的にロードするか、または必要に応じて手動で呼び出すことでそれらのグループを読み込むことができます。

ルールの保存方法 ¶

検証ルールを保存するには、単に application/config/ フォルダに form_validation.php という名前のファイルを作成します。このファイルでは、 $config という名前の配列を配置し、バリデーションルールを書きます。先に示したように、バリデーションの配列は次のプロトタイプを持っています:

$config = array(
        array(
                'field' => 'username',
                'label' => 'ユーザ名',
                'rules' => 'required'
        ),
        array(
                'field' => 'password',
                'label' => 'パスワード',
                'rules' => 'required'
        ),
        array(
                'field' => 'passconf',
                'label' => 'パスワード確認',
                'rules' => 'required'
        ),
        array(
                'field' => 'email',
                'label' => 'メールアドレス',
                'rules' => 'required'
        )
);

バリデーションルールファイルは自動的に読み込まれ、 run() メソッドを呼び出すときに使用されます。

$config 配列という名前を　つ　け　な　け　れ　ば　な　ら　な　い　のでご注意ください。

検証ルールのセットを作る ¶

バリデーションルールを「セット」に整理するためには、「サブ配列」にそれらを置くことが必要です。次の例を考えてみましょう、ルールを 2 セット作ります。「signup」と「email」の 2 つのルールとします。この名称は任意につけられます:

$config = array(
        'signup' => array(
                array(
                        'field' => 'username',
                        'label' => 'ユーザ名',
                        'rules' => 'required'
                ),
                array(
                        'field' => 'password',
                        'label' => 'パスワード',
                        'rules' => 'required'
                ),
                array(
                        'field' => 'passconf',
                        'label' => 'パスワード確認',
                        'rules' => 'required'
                ),
                array(
                        'field' => 'email',
                        'label' => 'メールアドレス',
                        'rules' => 'required'
                )
        ),
        'email' => array(
                array(
                        'field' => 'emailaddress',
                        'label' => 'eメールアドレス',
                        'rules' => 'required|valid_email'
                ),
                array(
                        'field' => 'name',
                        'label' => '名前',
                        'rules' => 'required|alpha'
                ),
                array(
                        'field' => 'title',
                        'label' => 'タイトル',
                        'rules' => 'required'
                ),
                array(
                        'field' => 'message',
                        'label' => 'メッセージ本文',
                        'rules' => 'required'
                )
        )
);

特定のルールグループを呼び出す ¶

特定のグループを呼び出すには、 run() メソッドにその名前を渡します。たとえば、 signup ルールを呼び出すにはこうします:

if ($this->form_validation->run('signup') == FALSE)
{
        $this->load->view('myform');
}
else
{
        $this->load->view('formsuccess');
}

コントローラーのメソッドにルールグループを関連づける ¶

ルールグループを呼び出す（より自動的な）別の方法として、バリデーションルールを使いたいコントローラのクラス/メソッドに応じた名前を付けることです。例えば、 Member コントローラと signup メソッドがあるとしましょう。次のようなクラスです:

<?php

class Member extends CI_Controller {

        public function signup()
        {
                $this->load->library('form_validation');

                if ($this->form_validation->run() == FALSE)
                {
                        $this->load->view('myform');
                }
                else
                {
                        $this->load->view('formsuccess');
                }
        }
}

バリデーション設定ファイルでは、ルールグループに member/signup という名前をつけます:

$config = array(
        'member/signup' => array(
                array(
                        'field' => 'username',
                        'label' => 'ユーザ名',
                        'rules' => 'required'
                ),
                array(
                        'field' => 'password',
                        'label' => 'パスワード',
                        'rules' => 'required'
                ),
                array(
                        'field' => 'passconf',
                        'label' => 'パスワード確認',
                        'rules' => 'required'
                ),
                array(
                        'field' => 'email',
                        'label' => 'メールアドレス',
                        'rules' => 'required'
                )
        )
);

ルールグループにコントローラのクラス/メソッドと同じ名前がつけられている場合、 run() メソッドはそのクラス/メソッドから呼び出されたときに自動的にそれを使用します。

フィールド名の指定に配列を使う ¶

The Form Validation class supports the use of arrays as field names. Consider this example:

<input type="text" name="options[]" value="" size="50" />

If you do use an array as a field name, you must use the EXACT array name in the Helper Functions that require the field name, and as your Validation Rule field name.

For example, to set a rule for the above field you would use:

$this->form_validation->set_rules('options[]', 'Options', 'required');

Or, to show an error for the above field you would use:

<?php echo form_error('options[]'); ?>

Or to re-populate the field you would use:

<input type="text" name="options[]" value="<?php echo set_value('options[]'); ?>" size="50" />

You can use multidimensional arrays as field names as well. For example:

<input type="text" name="options[size]" value="" size="50" />

Or even:

<input type="text" name="sports[nba][basketball]" value="" size="50" />

As with our first example, you must use the exact array name in the helper functions:

<?php echo form_error('sports[nba][basketball]'); ?>

If you are using checkboxes (or other fields) that have multiple options, don’t forget to leave an empty bracket after each option, so that all selections will be added to the POST array:

<input type="checkbox" name="options[]" value="red" />
<input type="checkbox" name="options[]" value="blue" />
<input type="checkbox" name="options[]" value="green" />

Or if you use a multidimensional array:

<input type="checkbox" name="options[color][]" value="red" />
<input type="checkbox" name="options[color][]" value="blue" />
<input type="checkbox" name="options[color][]" value="green" />

When you use a helper function you’ll include the bracket as well:

<?php echo form_error('options[color][]'); ?>

ルールリファレンス ¶

The following is a list of all the native rules that are available to use:

ルール	Parameter	説明	例
required	No	空き要素の場合はFALSEを返す
matches	Yes	formの要素が一致しない時はFALSEを返す	matches[form_item]
regex_match	Yes	Returns FALSE if the form element does not match the regular expression.	regex_match[/regex/]
differs	Yes	Returns FALSE if the form element does not differ from the one in the parameter.	differs[form_item]
is_unique	Yes	Returns FALSE if the form element is not unique to the table and field name in the parameter. Note: This rule requires Query Builder to be enabled in order to work.	is_unique[table.field]
min_length	Yes	指定する文字数より少ない場合はFALSEを返します。	min_length[3]
max_length	Yes	指定する文字数を超えた場合はFALSEを返します。	max_length[12]
exact_length	Yes	指定する文字数と一致しない場合はFALSEを返します。	exact_length[8]
greater_than	Yes	指定した値よりも（数字的に）等しいもしくは小さいか、数字でない時にFALSEを返します。	greater_than[8]
greater_than_equal_to	Yes	指定した値よりも（数字的に）小さいか、数字でない時にFALSEを返します。	greater_than_equal_to[8]
less_than	Yes	指定した値よりも（数字的に）等しいもしくは大きいか、数字でない時にFALSEを返します。	less_than[8]
less_than_equal_to	Yes	指定した値よりも（数字的に）大きいか、数字でない時にFALSEを返します。	less_than_equal_to[8]
in_list	Yes	Returns FALSE if the form element is not within a predetermined list.	in_list[red,blue,green]
alpha	No	アルファベット以外の文字を含む場合、FALSEを返します。
alpha_numeric	No	アルファベット・数字以外の文字を含む場合、FALSEを返します。
alpha_numeric_spaces	No	Returns FALSE if the form element contains anything other than alpha-numeric characters or spaces. Should be used after trim to avoid spaces at the beginning or end.
alpha_dash	No	アルファベット、下線、dashesの以外の時にFALSEを返します。数字を含む場合はFALSEを返します。
numeric	No	数字以外の文字を含む場合FALSEを返します。
integer	No	整数以外の数字・文字列の場合はFALSEを返します。
decimal	No	小数点を含む数字以外の場合は、FALSEを返します。
is_natural	No	自然数以外の場合は、FALSEを返します。 0, 1, 2, 3, etc.
is_natural_no_zero	No	0を除く自然数の場合以外の場合は、FALSEを返します。 number, but not zero: 1, 2, 3, etc.
valid_url	No	URL以外の値の場合は、FALSEを返します。
valid_email	No	email以外の値の場合は、FALSEを返します。
valid_emails	No	コンマを挟んだ複数のemail以外の値の場合は、FALSEを返します。
valid_ip	No	IPアドレス以外の場合は、FALSEを返します。 ‘ipv4’ or ‘ipv6’ の形式をサポートしています。
valid_base64	No	Base64の形式以外の場合は、FALSEを返します。

注釈

These rules can also be called as discrete methods. For example:

$this->form_validation->required($string);

注釈

You can also use any native PHP functions that permit up to two parameters, where at least one is required (to pass the field data).

整形処理のリファレンス ¶

The following is a list of all the prepping methods that are available to use:

名前	パラメータ	説明
prep_for_form	No	Converts special characters so that HTML data can be shown in a form field without breaking it.
prep_url	No	Adds “http://” to URLs if missing.
strip_image_tags	No	Strips the HTML from image tags leaving the raw URL.
encode_php_tags	No	Converts PHP tags to entities.

注釈

You can also use any native PHP functions that permits one parameter, like trim(), htmlspecialchars(), urldecode(), etc.

クラスリファレンス ¶

class CI_Form_validation¶

set_rules($field[, $label = ''[, $rules = '']])¶

パラメータ:	$field (string) – Field name $label (string) – Field label $rules (mixed) – Validation rules, as a string list separated by a pipe “\|”, or as an array or rules
返り値:	CI_Form_validation instance (method chaining)
返り値の型:	CI_Form_validation

Permits you to set validation rules, as described in the tutorial sections above:

検証ルールを設定する
検証ルールを設定ファイルに保存

run([$group = ''])¶

パラメータ:	$group (string) – The name of the validation group to run
返り値:	TRUE on success, FALSE if validation failed
返り値の型:	bool

Runs the validation routines. Returns boolean TRUE on success and FALSE on failure. You can optionally pass the name of the validation group via the method, as described in: 検証ルールを設定ファイルに保存

set_message($lang[, $val = ''])¶

パラメータ:	$lang (string) – The rule the message is for $val (string) – The message
返り値:	CI_Form_validation instance (method chaining)
返り値の型:	CI_Form_validation

Permits you to set custom error messages. See エラーメッセージの設定

set_error_delimiters([$prefix = '<p>'[, $suffix = '</p>']])¶

パラメータ:	$prefix (string) – Error message prefix $suffix (string) – Error message suffix
返り値:	CI_Form_validation instance (method chaining)
返り値の型:	CI_Form_validation

Sets the default prefix and suffix for error messages.

set_data($data)¶

パラメータ:	$data (array) – Array of data validate
返り値:	CI_Form_validation instance (method chaining)
返り値の型:	CI_Form_validation

Permits you to set an array for validation, instead of using the default $_POST array.

reset_validation()¶

返り値:	CI_Form_validation instance (method chaining)
返り値の型:	CI_Form_validation

Permits you to reset the validation when you validate more than one array. This method should be called before validating each new array.

error_array()¶

返り値:	Array of error messages
返り値の型:	array

Returns the error messages as an array.

error_string([$prefix = ''[, $suffix = '']])¶

パラメータ:	$prefix (string) – Error message prefix $suffix (string) – Error message suffix
返り値:	Error messages as a string
返り値の型:	string

Returns all error messages (as returned from error_array()) formatted as a string and separated by a newline character.

error($field[, $prefix = ''[, $suffix = '']])¶

パラメータ:	$field (string) – Field name $prefix (string) – Optional prefix $suffix (string) – Optional suffix
返り値:	Error message string
返り値の型:	string

Returns the error message for a specific field, optionally adding a prefix and/or suffix to it (usually HTML tags).

has_rule($field)¶

パラメータ:	$field (string) – Field name
返り値:	TRUE if the field has rules set, FALSE if not
返り値の型:	bool

Checks to see if there is a rule set for the specified field.

ヘルパーリファレンス ¶

Please refer to the Form Helper manual for the following functions:

Note that these are procedural functions, so they do not require you to prepend them with $this->form_validation.