【PHP8.x】FILTER_FLAG_QUERY_REQUIRED定数の使い方

Copy
1<?php
2
3/**
4 * フォームデータ配列を検証し、フィルタリングを行う関数。
5 * 'filter_var_array' を使用して、指定されたフィルタとフラグを適用します。
6 * 'FILTER_FLAG_QUERY_REQUIRED' は、URLフィルタリングにおいてクエリパラメータが必須であることを示します。
7 *
8 * @param array $formData 検証するフォームデータ。
9 * @return array フィルタリングされたデータ、および検証エラーを含む配列。
10 */
11function validateFormDataWithFilters(array $formData): array
12{
13    // 各フィールドのフィルタリング定義
14    $filters = [
15        'username' => [
16            'filter' => FILTER_SANITIZE_STRING, // 文字列をサニタイズ
17            'options' => ['default' => '']      // デフォルト値として空文字列を設定
18        ],
19        'email' => [
20            'filter' => FILTER_VALIDATE_EMAIL,  // メールアドレス形式を検証
21            'flags' => FILTER_NULL_ON_FAILURE   // 検証失敗時にnullを返す
22        ],
23        'age' => [
24            'filter' => FILTER_VALIDATE_INT,    // 整数値を検証
25            'options' => [
26                'min_range' => 1,
27                'max_range' => 120,
28            ],
29            'flags' => FILTER_NULL_ON_FAILURE
30        ],
31        'website' => [
32            'filter' => FILTER_VALIDATE_URL,    // URL形式を検証
33            // FILTER_FLAG_QUERY_REQUIRED は、URLがクエリパラメータ (例: ?key=value) を
34            // 必須とする場合に用いられます。クエリ部分がないURLは無効と判断されます。
35            'flags' => FILTER_NULL_ON_FAILURE | FILTER_FLAG_QUERY_REQUIRED
36        ],
37    ];
38
39    // filter_var_array を使用して入力配列全体をフィルタリング
40    $filteredData = filter_var_array($formData, $filters);
41
42    $errors = [];
43
44    // 必須フィールドの検証ロジック
45    if (empty($filteredData['username'])) {
46        $errors['username'] = 'ユーザー名は必須です。';
47    }
48
49    if ($filteredData['email'] === null || $filteredData['email'] === '') {
50        $errors['email'] = '有効なメールアドレスは必須です。';
51    }
52
53    // 'age' は入力があれば有効な数値でなければならない（必須ではないが、あれば検証）
54    if (isset($formData['age']) && ($filteredData['age'] === null || $filteredData['age'] === false)) {
55        $errors['age'] = '年齢は有効な数値で入力してください。';
56    }
57
58    // 'website' は必須（FILTER_FLAG_QUERY_REQUIREDによりクエリも必須）
59    if ($filteredData['website'] === null || $filteredData['website'] === '') {
60        $errors['website'] = '有効なウェブサイトURLは必須です（クエリパラメータが必要です）。';
61    }
62
63    return [
64        'data' => $filteredData,
65        'errors' => $errors,
66        'isValid' => empty($errors) // エラーがなければ検証成功
67    ];
68}

このPHPサンプルコードは、filter_var_array関数を活用して、ウェブフォームなどから受け取った入力データを安全に検証・フィルタリングする方法を示しています。validateFormDataWithFilters関数は、引数として受け取る連想配列形式のフォームデータ（$formData）に対し、各フィールドに定められたルールを適用して内容を確認します。

具体的には、usernameフィールドは悪意のある文字を除去するサニタイズ処理を、emailフィールドは有効なメールアドレス形式であるかを、ageフィールドは指定された範囲内の整数値であるかを検証します。

特にwebsiteフィールドの検証では、FILTER_VALIDATE_URLフィルタと共にFILTER_FLAG_QUERY_REQUIREDというフラグが使われています。このフラグは、検証するURLにクエリパラメータ（例: https://example.com?id=123のように?以降の部分）が含まれていることを必須とします。そのため、クエリパラメータがないURLは無効と判断され、検証に失敗した場合はnullが返されます。

関数の戻り値は、フィルタリングが適用されたデータ（data）、検証中に発生したエラーメッセージの配列（errors）、そして全体としてデータが有効であったかを示す真偽値（isValid）を含む連想配列です。これにより、ユーザー入力の信頼性とセキュリティを向上させることができます。

Copy
1<?php
2
3/**
4 * 指定された文字列が有効なIPアドレスであるかを検証します。
5 *
6 * この関数は、PHPのfilter_var関数とFILTER_VALIDATE_IPフィルターを使用して、
7 * IPv4またはIPv6形式のIPアドレスの有効性をチェックします。
8 *
9 * @param string $ipAddress 検証するIPアドレス文字列
10 * @return bool 有効なIPアドレスであれば true、そうでなければ false
11 */
12function validateIpAddress(string $ipAddress): bool
13{
14    // filter_var関数とFILTER_VALIDATE_IPフィルターを使用してIPアドレスを検証します。
15    // 有効なIPアドレスであれば、フィルタリングされた文字列（元のIPアドレス）を返し、
16    // 無効なIPアドレスであれば、falseを返します。
17    // 厳密な比較 (=== false) を使用して、検証が失敗したことを確実に判定します。
18    if (filter_var($ipAddress, FILTER_VALIDATE_IP) === false) {
19        return false;
20    }
21    return true;
22}
23
24// --- サンプルコードの動作確認 ---
25
26echo "--- IPアドレス検証の例 ---\n";
27
28// 有効なIPv4アドレスの例
29$ipv4 = "192.168.1.100";
30if (validateIpAddress($ipv4)) {
31    echo "{$ipv4} は有効なIPアドレスです。\n";
32} else {
33    echo "{$ipv4} は無効なIPアドレスです。\n";
34}
35
36// 有効なIPv6アドレスの例
37$ipv6 = "2001:0db8:85a3:0000:0000:8a2e:0370:7334";
38if (validateIpAddress($ipv6)) {
39    echo "{$ipv6} は有効なIPアドレスです。\n";
40} else {
41    echo "{$ipv6} は無効なIPアドレスです。\n";
42}
43
44// 無効なIPアドレスの例 (範囲外の数値)
45$invalidV4 = "256.0.0.1";
46if (validateIpAddress($invalidV4)) {
47    echo "{$invalidV4} は有効なIPアドレスです。\n";
48} else {
49    echo "{$invalidV4} は無効なIPアドレスです。\n";
50}
51
52// 無効なIPアドレスの例 (不正な形式)
53$notAnIp = "hello world";
54if (validateIpAddress($notAnIp)) {
55    echo "{$notAnIp} は有効なIPアドレスです。\n";
56} else {
57    echo "{$notAnIp} は無効なIPアドレスです。\n";
58}
59
60// 無効なIPアドレスの例 (空文字列)
61$emptyString = "";
62if (validateIpAddress($emptyString)) {
63    echo "空文字列 は有効なIPアドレスです。\n";
64} else {
65    echo "空文字列 は無効なIPアドレスです。\n";
66}
67
68?>

このサンプルコードは、PHP 8で提供されるfilter_var関数とFILTER_VALIDATE_IP定数を用いて、与えられた文字列が有効なIPアドレス（IPv4またはIPv6）であるかを検証する方法を示しています。FILTER_VALIDATE_IPは、PHPのfilter拡張機能に分類される定数で、IPアドレス形式の妥当性をチェックする際に指定します。

提供されたリファレンス情報にあるFILTER_FLAG_QUERY_REQUIRED定数は、同じfilter拡張機能の定数ですが、主にFILTER_VALIDATE_URLなどでURLのクエリ文字列を必須とする場合に用いるフラグであり、本サンプルコードで扱われるIPアドレスの検証とは直接関係ありません。

サンプルコード内のvalidateIpAddress関数は、検証対象のIPアドレス文字列を引数として受け取ります。関数内部では、filter_var関数が第一引数にIPアドレス、第二引数にFILTER_VALIDATE_IP定数を受け取り、IPアドレスの有効性を評価します。filter_var関数は、入力が有効なIPアドレスであればその文字列自体を返し、無効な場合はブール値のfalseを返します。そのため、=== falseという厳密な比較を用いることで、検証の成否を正確に判断しています。

validateIpAddress関数は、検証結果が有効なIPアドレスであればtrueを、無効であればfalseを戻り値として返します。これにより、システム内でユーザー入力や設定値が正しいIPアドレス形式であるかを手軽に確認できるようになります。