ユーザー「入力値」の妥当性を、システム側で「検証」し、適切に処理すること。
バリデーションとは【validation】(バリデート) - IT用語辞典
別名 :validate
検証(する)、実証(する)、認可(する)、妥当性確認、などの意味を持つ英単語。
ITの分野では、対象がその仕様や文法などに照らして適切に記述・構築されているか否かを検証すること、という意味で使われる。
CodeIgniterで用意されているバリデーションクラスを利用して、ユーザーの入力値をチェックします。
データを受け取るページで、入力値のチェック処理を行います。
次の3つのファイルを用意します。
ファイル | 内容 |
入力ページのビュー | 入力フォームを設置したビューファイル |
結果ページのビュー | 送信が成功したときに、「成功」"メッセージを表示するビューファイル |
コントローラー | 送信されたデータを受け取り、処理できるようにしたコントローラ内のメソッド |
入力フォームのビューファイルを用意する。
applications/views/myform.php
#code(html){{
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>
}}
バリデーションの結果を表示するビューファイルを用意する。
applications/views/formsuccess.php
#code(html){{
html>
<head> <title>マイフォーム</title> </head> <body> <h3>フォームは正しく送信されました!</h3> <p><?php echo anchor('form', 'もう一度!'); ?></p> </body>/html>
}}
入力ページを制御するコントローラーファイルを用意する。
applications/controllers/form.php
#code(php){{
?php
class Form extends CI_Controller {
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'); $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'); } }
}
?>
}}
バリデーションクラスのset_rules()メソッドを使って検証ルールを設定します。
$this->form_validation->set_rules();
set_rules()メソッドに、3つの引数を指定します。
引数 | 引数の順番 | 内容 |
フォーム名 | 1番目 | フォームの name 属性に指定した値 |
フォームの表示名 | 2番目 | 「user」という入力フィールドの表示名として「名前」等 |
フォームに設定する検証ルール | 3番目 | 'required', 'max_length[12]'等、CodeIgniterで用意されている値 |
コントローラ (form.php) の中で、バリデーションクラスを初期化(ロード)した後、set_rules()メソッドを使います。
#code(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');
}}
一回で全ての検証ルールを設定したい場合、set_rules()メソッドの引数を配列にします。
引数の配列は、検証ルール設定メソッドを通る配列の形式で記述しなければいけません。
#code(php){{
$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);
}}
set_rules()メソッドの、3番目の引数である「検証ルール」は、複数のルールを指定できます。
各ルールは「|」でつなげて記述します。
#code(php){{
$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');
}}
上記の例では、
バリデーションの機能は、データの整形をすることもできます。
たとえば、以下のように、ルールを追加することができます。
#code(php){{
$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');
}}
上記の例では、
Formヘルパーのvalidation_errors()関数を使います。(Formヘルパーをロードしておかないと使えません!)
validation_errors()
この関数は、バリデーションクラスのバリデータが返すエラーメッセージを取得して、出力します。
メッセージがなければ、何も出力しません。
入力ページで、エラーメッセージを表示させる場所に、以下のように記述します。
#code(php){{
?php echo validation_errors(); ?>
}}