フォームバリデーション(検証)¶

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

Page Contents

フォームバリデーション(検証)

概要 ¶

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

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

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

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

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

The validation system supports callbacks to your own validation methods. This permits you to extend the validation class to meet your needs. For example, if you need to run a database query to see if the user is choosing a unique username, you can create a callback method that does that. Let’s create an example of this.

In your controller, change the “username” rule to this:

$this->form_validation->set_rules('username', 'Username', 'callback_username_check');

Then add a new method called username_check() to your controller. Here’s how your controller should now look:

<?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', 'Username', 'callback_username_check');
                $this->form_validation->set_rules('password', 'Password', 'required');
                $this->form_validation->set_rules('passconf', 'Password Confirmation', 'required');
                $this->form_validation->set_rules('email', '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', 'The {field} field can not be the word "test"');
                        return FALSE;
                }
                else
                {
                        return TRUE;
                }
        }

}

Reload your form and submit it with the word “test” as the username. You can see that the form field data was passed to your callback method for you to process.

To invoke a callback just put the method name in a rule, with “callback_” as the rule prefix. If you need to receive an extra parameter in your callback method, just add it normally after the method name between square brackets, as in: “callback_foo**[bar]**”, then it will be passed as the second argument of your callback method.

Note

You can also process the form data that is passed to your callback and return it. If your callback returns anything other than a boolean TRUE/FALSE it is assumed that the data is your newly processed form data.

Callable: Use anything as a rule ¶

If callback rules aren’t good enough for you (for example, because they are limited to your controller), don’t get disappointed, there’s one more way to create custom rules: anything that is_callable() would return TRUE for.

Consider the following example:

$this->form_validation->set_rules(
        'username', 'Username',
        array(
                'required',
                array($this->users_model, 'valid_username')
        )
);

The above code would use the valid_username() method from your Users_model object.

This is just an example of course, and callbacks aren’t limited to models. You can use any object/method that accepts the field value as its’ first parameter. Or if you’re running PHP 5.3+, you can also use an anonymous function:

$this->form_validation->set_rules(
        'username', 'Username',
        array(
                'required',
                function($value)
                {
                        // Check $value
                }
        )
);

Of course, since a Callable rule by itself is not a string, it isn’t a rule name either. That is a problem when you want to set error messages for them. In order to get around that problem, you can put such rules as the second element of an array, with the first one being the rule name:

$this->form_validation->set_rules(
        'username', 'Username',
        array(
                'required',
                array('username_callable', array($this->users_model, 'valid_username'))
        )
);

Anonymous function (PHP 5.3+) version:

$this->form_validation->set_rules(
        'username', 'Username',
        array(
                'required',
                array(
                        'username_callable',
                        function($str)
                        {
                                // Check validity of $str and return TRUE or 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 文字必要です。”

Note

%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'] = '名前';

Note

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" />

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

Important

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

<?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 データまたは設定した別の配列をバリデーションしているかどうかにかかわらず、同じように動作します。

Important

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

Important

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]
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を返します。

Note

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

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

Note

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:

名前	Parameter	説明
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.

Note

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 = '']])¶

パラメータ string $field:
	Field name
パラメータ string $label:
	Field label
パラメータ mixed $rules:
	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 = ''])¶

パラメータ string $group:
	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 = ''])¶

パラメータ string $lang:
	The rule the message is for
パラメータ string $val:
	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>']])¶

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

Sets the default prefix and suffix for error messages.

set_data($data)¶

パラメータ array $data:
	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 = '']])¶

パラメータ string $prefix:
	Error message prefix
パラメータ string $suffix:
	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 = '']])¶

パラメータ string $field:
	Field name
パラメータ string $prefix:
	Optional prefix
パラメータ string $suffix:
	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)¶

パラメータ string $field:
	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.

フォームバリデーション(検証)¶

概要 ¶

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

入力フォーム ¶

成功ページ ¶

コントローラ ¶

動かしてみよう!¶

解説 ¶

検証ルールを設定する ¶

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

ルールの連結 (カスケード)¶

データの整形 ¶

フォームの再表示 (データの引き継ぎ)¶

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

Callable: Use anything as a rule ¶

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

フィールド名の翻訳 ¶

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

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

配列 ($_POST以外) のバリデーション ¶

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

ルールの保存方法 ¶

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

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

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

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

ルールリファレンス ¶

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

クラスリファレンス ¶

ヘルパーリファレンス ¶