フォーム・バリデーション(検証)
CodeIgniterは、最小限のコードで総合的なフォームバリデーションとデータの準備をするクラスを提供します。
注記: CodeIgniter 1.7.0では、このフォームバリデーションクラスが古いバリデーションクラスに置き換わり、古いバリデーションクラスは非推奨となります。 古いクラスがライブラリに残っていても、現在使用中のアプリケーションが動作しなくなってしまう事はありませんが、この新しいバージョンに移行することが奨励されます。
概観
CodeIgniterのデータ検証アプローチの説明をする前に、想定するシナリオについて述べておきます:
- フォームが表示されます。
- 入力して送信します。
- 間違ったデータが送信された場合、あるいは、必要項目が入力されていない場合、それらの問題についてのエラーメッセージを、入力したデータと一緒にフォームで再表示します。
- 送信データが正しい形式になるまで、上記の処理を繰り返します。
最後にデータを受け取るところで、そのスクリプトでは次のようなことが必要になります:
- 必須入力のデータをチェックする。
- データが正しいデータ型か、また、データが条件に合致するかをチェックする。たとえば、ユーザ名が送信された場合、許可した文字だけになっているかを検証する必要があります。 また、最小文字数以上で、最大文字数以下になっているかの検証もします。 ユーザ名は、既に存在しているユーザ名と同じでなく、予約語と同じであってはならない。など
- セキュリティのためにデータをサニタイズする。
- 必要であれば、前もってデータをフォーマットします (前後のスペースをとる? HTMLにするか? など)
- データベースに追加するため、データを準備します。
上で挙げたプロセスには何ら複雑なものはありませんが、たいてい大量のコードが必要になり、 エラーメッセージを表示させるために、フォームHTMLの中に、さまざまな制御構造が書かれることになります。 フォームの検証は、難しくなくつくれますが、実装するのはいつも面倒で退屈です。
フォーム・バリデーション(検証)チュートリアル
以下はCodeIgniterのフォームバリデーションを実装する"ハンズオン"チュートリアルです。
フォームバリデーション(検証)を実装するには、次の3つが必要になります:
- フォームを設置したビューファイルを用意します。
- 送信が成功したときに、"成功" メッセージを表示する ビューファイルを用意します。
- コントローラ内のメソッドをデータを受け取れるようにし、送信されたデータを処理できるようにします。
例としてメンバー登録フォームを使って、これら3つを作成してみましょう。
入力フォーム
テキストエディタを使って、 myform.php という名前のフォームを作ってください。 その中に、次のコードを書いて applications/views/ フォルダの中に保存します。:
成功ページ
テキストエディタを使って、 formsuccess.php という名前のフォームを作ってください。 その中に、次のコードを書いて applications/views/ フォルダの中に保存します。:
コントローラ
テキストエディタを使って、 form.php という名前のコントローラを作ってください。 その中に、次のコードを書いて applications/controllers/ フォルダの中に保存します。:
動かしてみよう !
作ったフォームを動かすため、次のうようなURLでサイトを訪問してください:
example.com/index.php/form/
フォームに送信すると、単にフォームが更新されるだけに見えます。 これは、まだ検証ルールを一つも設定していないからです。
ここでは、まだバリデーションクラスになにも検証しないように設定しています。バリデーションクラスは、デフォルトでは、"false" (ブール値のFLASE)を返します。 run()メソッドは、一つも失敗せずにユーザが指定したルールに適合する場合にのみ "true" を返します。
解説
上の例のページについていくつか気づいたことがあると思います:
フォーム (myform.php) は、次の2つの例外を除いて、スタンダードなwebフォームだといえます:
- fromタグを開始するのに Formヘルパ を使っています。 技術的には、これは必ずしも必要ではありません。通常のHTMLを使ってformを作成することもできます。しかし、このヘルパを使うと、 formタグのaction属性に指定するURLを設定ファイルのURLにもとづいて生成してくれるという利点があります。 これにより、URLを変更した時のアプリケーションの移植性と柔軟性が高まります。
- フォームの先頭に、次のような変数があるのに気がついたと思います:
<?php echo validation_errors(); ?>
この変数はバリデータが返すエラーメッセージを表示します。メッセージがなければ、何も表示しません。
コントローラ (form.php) には index() というメソッドがあります。 このメソッドは、バリデーションクラスを初期化しビューファイルで使えるように Formヘルパ と URLヘルパ をロードします。 また、検証処理も実行します。 検証が成功したかどうかにより、フォームのページか成功ページかどちらかを表示します。
検証ルールを設定する
CodeIgniter では、指定したフィールドにどれだけ多くのルールを適用してもかまいません。ルールは順番に続けて適用することができ、同時にデータを整形したり前処理を行ったりすることもできます。 set_rules()メソッドを使って検証ルールを設定してみましょう。:
$this->form_validation->set_rules();
上記のメソッドには3つの入力パラメータを指定します。:
- フォーム名 - フォームのname属性に指定した値です
- このフォームの表示名。これはエラーメッセージに挿入されます。 例えば、フォームに「user」という名前を付けた場合、表示名としては「名前」とするでしょう。 Note: フィールド名を言語ファイルに設定して使いたい場合はフィールド名の翻訳を見てください。
- このフォームに設定する検証ルール
例を示します。 コントローラ (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');
コントローラは次のようになっているはずです:
ここでフォームを空欄にしフォームを送信すると、エラーメッセージが表示されます。 すべてのフィールドを埋めて送信すると、成功ページが表示されます。
Note: フォームのフィールドは、エラーの時に入力したデータが復元されません。 あともうちょっと必要です。
配列を使った検証ルールの指定
一回で全ての検証ルールを設定したい場合は、検証ルール設定メソッドを通る配列の形式で記述しなければいけません。 このアプローチを使う場合、配列のキーをここに示した通りの名前にしなければいけません。:
$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'
)
);
$this->form_validation->set_rules($config);
ルールの連結(カスケード)
CodeIgniter では、複数のルールを互いにパイプすることができます。ではやってみましょう。ルール設定メソッドの第3パラメーターを次のように変更してみてください。:
$this->form_validation->set_rules('username', 'ユーザ名', 'required|min_length[5]|max_length[12]');
$this->form_validation->set_rules('password', 'パスワード', 'required|matches[passconf]');
$this->form_validation->set_rules('passconf', 'パスワードの確認', 'required');
$this->form_validation->set_rules('email', 'メールアドレス', 'required|valid_email');
上のコードでは次のことが要求されます:
- username フィールドは、5 文字より小さくてはだめで、12文字を超えてはいけません。
- password フィールドは、パスワード確認フィールドと入力が一致しなければなりません。
- email フィールドは、正しいメールアドレスの形式でなければなりません。
データを入力して、やってみてください! 新しく設定したルールに対応するエラーメッセージを見てみましょう。 ルールリファレンスにあるように、多くの検証ルールがあります。
データの整形
バリデーションの機能は、上で使ったようなものに加え、様々な方法で、データの整形をすることもできます。 たとえば、以下のように、ルールをセットすることができます。:
$this->form_validation->set_rules('username', 'ユーザ名', 'trim|required|min_length[5]|max_length[12]|xss_clean');
$this->form_validation->set_rules('password', 'パスワード', 'trim|required|matches[passconf]|md5');
$this->form_validation->set_rules('passconf', 'パスワードの確認', 'trim|required');
$this->form_validation->set_rules('email', 'メールアドレス', 'trim|required|valid_email');
上の例では、フィールドを "トリミング" し、パスワードをMD5に変換し、 悪意のあるデータを取り除く "xss_clean" 機能を通します。
htmlspecialchars、trim、MD5 などのような引数を一つだけとるPHPの組み込み関数は どれでもルールとして使用することができます。
Note: もしエラーがあった場合、もとのデータをフォームに表示させるため、 検証ルールの後に整形機能を使いたいのが通常のケースだと思います。
フォームの再表示
これまでのところ、エラーに対処してきただけでしたが、送信されたデータをフォームで再表示する時がやってきました。CodeIgniterではこれを補うヘルパー関数が用意されています。 よく使われるものとしては次の様なコードです:
set_value('field name')
ビューファイルmyform.phpを開き、それぞれのフォームのvalueにset_value()関数を入れてください:
set_value()のパラメータには、それぞれのフォームのnameを入れる事を忘れないでください。
ここで、フォームを再読み込みし、エラーになるようなデータを送信します。 フォームには値が再設定されます。
Note: 関数リファレンスセクションでは <select>メニュー、ラジオボタン、チェックボックスに値を再設定する関数の記載があります。
重要: フォームの名前に配列を使う場合、パラメーターには配列の形で指定します。例:
<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 という名前の新しいメソッドをコントローラに追加します。 コントローラは以下のようになっているはずです:
フォームを再読み込みして、ユーザ名に "test" と入力して送信します。 フォームフィールドのデータがコールバックメソッドに渡され処理されたのがわかります。
コールバックを呼び出すには、あるルールに従ってメソッド名を指定します。そのルールとは、"callback_" というプリフィックスをメソッド名に付け加えるというものです。
また、コールバックに渡されたフォームデータを処理し、結果を返すことができます。 コールバックがbool型のTRUE / FALSE以外の値を返す場合、そのデータはフォームデータが処理された新しいものである事が想定されます。
エラーメッセージを設定する
もともとのエラーメッセージは、次の言語ファイルの中にあります:language/english/form_validation_lang.php
ユーザ定義のメッセージを表示するには、このファイルを編集するか、または、次のメソッドを利用します:
$this->form_validation->set_message('ルール名', 'エラーメッセージ');
ここでの rule は特定のルール名になり、Error Message は表示したいテキストになります。
エラーメッセージに %s を含めると、ルールに指定した項目を使って、表示用の項目名に置き換えられます。
上記のコールバックの例では、エラーメッセージはメソッド名で指定したルールを通る様に設定されています:
$this->form_validation->set_message('username_check')
また、言語ファイル内にエラーメッセージが見つかれば上書きすることができます。たとえば、"required" ルールのメッセージを変更するには、次のようにします:
$this->form_validation->set_message('required', 'ここにカスタムメッセージ');
フィールド名の変換
言語ファイル内において、set_rules()メソッドに渡す"表示名"を格納したければ、ここに示す様にすれば、フィールド名が変換される様にすることができます:
まず、以下の例の様に表示名にプレフィックスとして lang: を付けます:
$this->form_validation->set_rules('first_name', 'lang:first_name', 'required');
次に言語ファイル内に配列を一つ格納します。(添字にはプレフィックスは付けません):
$lang['first_name'] = '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>'); ?>
個別にエラーを表示する
エラーメッセージを一覧として表示するのではなく、各フォームの下に表示したい場合は、 form_error() メソッドを使います。
動かしてみよう ! この様にフォームを変更してください:
エラーがない場合は、何も表示されません。エラーがある場合に、メッセージが表示されます。
重要: フォームの名前に配列を使う場合、パラメーターには配列の形で指定します。例:
<?php echo form_error('options[size]'); ?>
<input type="text" name="options[size]" value="<?php echo set_value("options[size]"); ?>" size="50" />
詳しくはフィールド名の指定に配列を使うを見てください。
検証ルールを設定ファイルに保存
フォーム検証クラスの素晴らしい特徴は、アプリケーション全体に適用する検証ルールを全て設定ファイル内に格納する事が出来る点です。 ルールは”グループ"毎に整理することができます。 この"グループ"は一致するコントローラーやメソッドが呼び出された時に自動的にロードさせる事も出来るし、必要な時に手動で呼び出す事も出来ます。
ルールの保存方法
検証ルールを保存するには、単純に、 form_validation.php というファイルを application/config/ フォルダ内に作成します。 このファイル内では、検証ルールは $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つのルールセットをお見せしますので、例として考えてみましょう。2つのルールとして、任意に"signup"と"email"と呼ぶことにします。付けたい名前を付ける事ができます:
$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' => 'メールアドレス',
'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 Controller {
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()メソッドが呼び出された時に自動的に使用されます。
フィールド名の指定に配列を使う
フォーム検証クラスはフィールド名として配列の形式を使う事も出来ます。この例をよく見てください:
<input type="text" name="options[]" value="" size="50" />
フィールド名に配列を使う場合、 ヘルパー の中ではフォームのフィールド名やバリデーションルールのフィールド名には 正確な名前を使う様にしてください。
例えば、上記のフィールド用のルールを設定するにはこの様にしてください:
$this->form_validation->set_rules('options[]', 'オプション', 'required');
または、エラーを表示させるにはこのようにしてください:
<?php echo form_error('options[]'); ?>
フォームの再表示の時はこうです:
<input type="text" name="options[]" value="<?php echo set_value('options[]'); ?>" size="50" />
フィールド名として多次元配列を使う事も出来ます:例:
<input type="text" name="options[size]" value="" size="50" />
またはこの様にもできます:
<input type="text" name="sports[nba][basketball]" value="" size="50" />
最初の例と同様に、ヘルパー関数には正確な名前を用いてください:
<?php echo form_error('sports[nba][basketball]'); ?>
複数の選択肢を持つチェックボックス(もしくは他のフォーム)を使う場合は、それぞれの名前には空白のカッコを付ける事を忘れないでください。 そうしないとPOST時の配列に全ての選択が渡りません:
<input type="checkbox" name="options[]" value="red" />
<input type="checkbox" name="options[]" value="blue" />
<input type="checkbox" name="options[]" value="green" />
または多次元配列を使う場合はこうなります:
<input type="checkbox" name="options[color][]" value="red" />
<input type="checkbox" name="options[color][]" value="blue" />
<input type="checkbox" name="options[color][]" value="green" />
ヘルパー関数を使う時は以下の様にカッコを付けてください:
<?php echo form_error('options[color][]'); ?>
ルールリファレンス
次のリストは、使用可能なすべての組み込みのルールです:
ルール | パラメータ | 説明 | 例 |
---|---|---|---|
required | なし | フォームのデータが空のときに FALSE を返します。 | |
matches | あり | フォームのデータが他のフィールドの入力データと一致しないときに FALSE を返します。 | matches[form_item] |
min_length | あり | フォームのデータが指定したサイズよりも文字数が短いときに FALSE を返します。 | min_length[6] |
max_length | あり | フォームのデータが指定したサイズよりも文字数が長いときに FALSE を返します。 | max_length[12] |
exact_length | あり | フォームのデータが特定の長さでないときに FALSE を返します。 | exact_length[8] |
alpha | なし | フォームのデータがアルファベットでない文字を含むときに FALSE を返します。 | |
alpha_numeric | なし | フォームのデータが英数字でない文字を含むときに FALSE を返します。 | |
alpha_dash | なし | フォームのデータが英数字、アンダースコア("_")、ダッシュ("-") のいずれでないものを含むときに FALSE を返します。 | |
numeric | なし | フォームのデータが数字でないときに FALSE を返します。 | |
integer | なし | フォームのデータが整数以外の場合 FALSE を返します。 | |
is_natural | なし | フォームのデータが0,1,2,3,等の自然数以外の場合 FALSE を返します。 | |
is_natural_no_zero | なし | フォームのデータが0を除く1,2,3,等の自然数以外の場合 FALSE を返します。 | |
valid_email | なし | フォームのデータがemailアドレスとして正しくないとき FALSE を返します。 | |
valid_emails | なし | コンマで区切られたリストのひとつでもメールアドレスとして正しくないとき FALSE を返します。 | |
valid_ip | なし | 渡されたIPが正しい形式でないときに FALSE を返します。 | |
valid_base64 | なし | 渡された文字列が正しい Base64 形式でないとき FALSE を返します。 |
Note: また、これらのルールは、ふつうのメソッドとしても呼び出すことができます。 例:
$this->form_validation->required($string);
Note: 引数を一つだけとるPHPの組み込み関数も使用できます。
整形処理のリファレンス
次のリストは、使用可能な整形メソッドのリストです:
名前 | パラメータ | 説明 |
---|---|---|
xss_clean | なし | XSS フィルタリングメソッドを通過させます。XSSフィルタリングメソッドについては、入力クラスのページをご覧ください。 |
prep_for_form | なし | HTMLデータをフォームフィールドで崩れずに表示させるよう、HTML特殊文字を変換します。 |
prep_url | なし | もし、ない場合は、"http://" をURLに追加します。 |
strip_image_tags | なし | イメージへのURLをそのままにして、イメージタグからHTMLを取り除きます。 |
encode_php_tags | なし | PHP タグをHTMLエンティティに変換します。 |
Note: また、 trim、htmlspecialchars、urldecode などの 引数を一つだけとるPHPの組み込み関数をどれでも使用することができます。
関数リファレンス
以下の関数はコントローラーのメソッド内で使われる事を意図しています。
$this->form_validation->set_rule();
上記のチュートリアルの説明の様に、検証ルールを設定することができます。
$this->form_validation->run();
検証処理を実行する。成功時はTRUEを返し、失敗時はFALSEを返す。 このメソッドには 設定ファイルに検証ルールのグループを保存する に書いてある様に、検証ルールグループの名前を渡せます。
$this->form_validation->set_message();
エラーメッセージをカスタマイズして指定できます。エラーメッセージを設定するをご覧ください。
ヘルパー関数リファレンス
次のヘルパー関数はフォームを含むビューファイルの中で使うことができます。 これは単独の関数なので、直前に $this->form_validation をいれる必要はありません。
form_error()
メソッドに渡すフィールド名に関連づけられた、個々のエラーメッセージを表示する。例:
<?php echo form_error('username'); ?>
エラー区切り文字は自由に指定できます。前述の エラーメッセージを囲む文字の変更 セクションをご覧ください。
validation_errors()
文字列として全てのエラーメッセージを表示する:例:
<?php echo validation_errors(); ?>
エラー区切り文字は自由に指定できます。前述の エラーメッセージを囲む文字の変更 セクションをご覧ください。
set_value()
inputフォームやtextareaのvalueに値を入れることができます。メソッドの第1パラメータにフィールド名を指定します。 第2パラメーター(オプション)はフォームのデフォルト値を指定します。例:
<input type="text" name="quantity" value="<?php echo set_value('quantity', '0'); ?>" size="50" />
上記のフォームは最初に読み込まれた時に"0"が入ります。
set_select()
<select> メニューを使うとき、この関数は選択されたメニュー項目を表示できます。 第1パラーメーターはSELECTフォームの名前を指定します。 第2パラメーター(オプション)にはデフォルト値(TRUE/FALSEのブール値)を指定します。
例:
<select name="myselect">
<option value="one" <?php echo set_select('myselect', 'one', TRUE); ?> >1</option>
<option value="two" <?php echo set_select('myselect', 'two'); ?> >2</option>
<option value="three" <?php echo set_select('myselect', 'three'); ?> >3</option>
</select>
set_checkbox()
送信されたチェックボックスの状態を表示できます。 第1パラメーターにはチェックボックスの名前を指定します。第2パラメーターにはvalueに設定した値を指定します。第3パラメーター(オプション)にはデフォルト値(TRUE/FALSEのブール値)を指定します。例:
<input type="checkbox" name="mycheck[]" value="1" <?php echo set_checkbox('mycheck[]', '1'); ?> />
<input type="checkbox" name="mycheck[]" value="2" <?php echo set_checkbox('mycheck[]', '2'); ?> />
set_radio()
送信されたラジオボタンの状態を表示できますこの関数は前述の set_checkbox() 関数と同じです。
<input type="radio" name="myradio" value="1" <?php echo set_radio('myradio', '1', TRUE); ?> />
<input type="radio" name="myradio" value="2" <?php echo set_radio('myradio', '2'); ?> />