技術資料

フォームの入力値を取得する

CodeIgniter 4 では、フォームの入力値を取得するために request クラスを使用します。

// POSTメソッドの値を取得
$form = $this->request->getPost();

// GETメソッドの値を取得
$form = $this->request->getGet();

// input type="file" の値を取得
$form = $this->request->getFile('file_name');

シンプルなバリデーション処理

バリデーション処理は、以下のように行います。

// バリデーションルールを設定
$validateForm = [
    'user_name' => [
        'rules' => 'required|alpha_numeric|max_length[255]',
    ],
    'user_file' => [
        'rules' => 'uploaded[user_file]|ext_in[user_file,txt]',
    ],
];

// フォームの値を取得
$form = $this->request->getPost();

$validation = service('validation');
$validation->setRules($validateForm);

// バリデーションを実行し、エラーがあればフォームを再表示
if(!$validation->run($form)){
    return view('form');
}

上記のコードでは、フォームの入力値 user_name と user_file に対してバリデーションを行なっています。

バリデーションルールは、rules に指定した文字列を | で区切ったものです。

user_name

• required: 入力必須
• alpha_numeric: 英数字のみ
• max_length[255]: 最大255文字

user_file

• uploaded[user_file]: ファイルがアップロードされているか
• ext_in[user_file,txt]: 拡張子が .txt のみ

※バリデーションルールとして設定できる項目は、Validation — CodeIgniter 4.6.0 documentation を参照。

バリデーションエラー時の出力

バリデーションエラーの出力は、ビューファイルに以下のように記述することで行なえます。

<?= validation_list_errors(); ?>

上記の記述だけで「user_name は必須項目です。」のように、出力してくれます。

フォームラベルの日本語化

「user_name は必須項目です。」といった出力は「user_name」の部分は input 要素の name 属性をそのまま表示してくれるわけですが、できれば「ユーザー名は必須項目です。」のようにしたいところ。

バリデーションルールの定義を行なう際に、フォームラベルを指定することで実現できます。

$validateForm = [
    'user_name' => [
        'label' => 'ユーザー名',
        'rules' => 'required|alpha_numeric|max_length[255]',
    ],
    'user_file' => [
        'label' => 'テキストファイル',
        'rules' => 'uploaded[user_file]|ext_in[user_file,txt]',
    ],
];

これで、バリデーションエラー時に「ユーザー名は必須項目です。」のように出力してくれます。

フォームラベルのローカライズ

ラベルを直接記述するのではなく、言語設定ファイルを作成してローカライズをすることも可能です。

日本語用言語設定ファイルは、app/Language/ja/ ディレクトリに準備します。

例: app/Language/ja/Fields.php を作成し、以下のように記述。

<?php

return [
    'user_name' => 'ユーザー名',
    'user_file' => 'テキストファイル',
];

上記のように、app/Language/ja/Fields.php を作成したら、バリデーションルールの定義を以下のように修正します。

$validateForm = [
    'user_name' => [
        'label' => 'Fields.user_name',
        'rules' => 'required|alpha_numeric|max_length[255]',
    ],
    'user_file' => [
        'label' => 'Fields.user_file',
        'rules' => 'uploaded[user_file]|ext_in[user_file,txt]',
    ],
];

エラー出力フォーマットのカスタマイズ

validation_list_errors に引数としてテンプレート名を指定して、エラー出力フォーマットのカスタマイズすることができます。

<?= validation_list_errors('error_list'); ?>

ビューファイルに上記のように記述した上で、app/Config/Validation.php を以下のように修正。

public array $templates = [
    'list'   => 'CodeIgniter\Validation\Views\list',
    'single' => 'CodeIgniter\Validation\Views\single',
    'error_list' => 'error_list', // カスタマイズしたエラーメッセージのリスト表示用テンプレート
];

app/Config/Validation.php で指定したテンプレートを app/Views/error_list.php として作成。

<?php if(!empty($errors)): ?>
	<div class="error-list-class">
		<?php foreach($errors as $e): ?>
			<p class="error-class"><?= esc($e); ?></p>
		<?php endforeach; ?>
	</div>
<?php endif; ?>

エラー内容は $errors に配列として入っているので、上記のように foreach で出力できます。