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

Copy
1<?php
2
3/**
4 * PHPの FILTER_FLAG_GLOBAL_RANGE 定数を使用して、数値の範囲検証を行います。
5 * このフラグは、`filter_var()` 関数の `min_range` および `max_range` オプションが、
6 * ロケール設定に依存しないグローバルな数値形式で解釈されることを保証します。
7 * システムエンジニアを目指す初心者の方にも分かりやすいように、
8 * 入力値が指定された整数範囲内にあるかを確認する例を示します。
9 *
10 * @param string $input 検証する入力文字列。
11 * @return string 検証結果のメッセージ。
12 */
13function validateNumberWithGlobalRangeFlag(string $input): string
14{
15    // 検証する数値の範囲を定義します。
16    // ここでは1から100までの整数を有効とします。
17    $minRange = 1;
18    $maxRange = 100;
19
20    // filter_var 関数で使用するオプション配列を設定します。
21    $options = [
22        'options' => [
23            'min_range' => $minRange,
24            'max_range' => $maxRange,
25        ],
26        // FILTER_FLAG_GLOBAL_RANGE フラグを追加します。
27        // このフラグは、上記の `min_range` と `max_range` の値が、
28        // システムのロケール設定（例: ドイツ語ロケールでの小数点のコンマ）に影響されず、
29        // 常に標準的なドット区切りの数値として解釈されることを保証します。
30        // これにより、範囲の定義が予期せぬロケールの影響を受けなくなります。
31        'flags' => FILTER_FLAG_GLOBAL_RANGE,
32    ];
33
34    // FILTER_VALIDATE_INT フィルターを使って、入力が整数であり、かつ定義された範囲内にあるか検証します。
35    $filteredValue = filter_var($input, FILTER_VALIDATE_INT, $options);
36
37    // 検証結果をチェックします。
38    // filter_var は検証に失敗した場合、false を返します。
39    if ($filteredValue === false) {
40        return "入力 '" . $input . "' は無効です。{$minRange}から{$maxRange}の範囲の整数を入力してください。";
41    } else {
42        return "入力 '" . $input . "' は有効です: " . $filteredValue;
43    }
44}
45
46// --- サンプルコードの実行例 ---
47echo "--- FILTER_FLAG_GLOBAL_RANGE を使用した数値検証 ---" . PHP_EOL;
48
49// 有効な入力の例
50echo validateNumberWithGlobalRangeFlag("42") . PHP_EOL;   // 範囲内の整数
51echo validateNumberWithGlobalRangeFlag("1") . PHP_EOL;    // 最小値
52echo validateNumberWithGlobalRangeFlag("100") . PHP_EOL;  // 最大値
53
54echo PHP_EOL;
55
56// 無効な入力の例
57echo validateNumberWithGlobalRangeFlag("0") . PHP_EOL;    // 範囲外 (最小値より小さい)
58echo validateNumberWithGlobalRangeFlag("101") . PHP_EOL;  // 範囲外 (最大値より大きい)
59echo validateNumberWithGlobalRangeFlag("abc") . PHP_EOL;  // 数値ではない文字列
60echo validateNumberWithGlobalRangeFlag("10.5") . PHP_EOL; // 整数ではない (FILTER_VALIDATE_INT のため)
61echo validateNumberWithGlobalRangeFlag("４２") . PHP_EOL; // 全角数字 (数値として認識されない)

FILTER_FLAG_GLOBAL_RANGEは、PHPで入力データを検証する際に使用される特別な定数です。主にfilter_var()関数と組み合わせて使われ、数値の範囲検証（min_rangeやmax_rangeオプション）が、システムのロケール設定に影響されず、グローバルで標準的な数値形式で解釈されることを保証します。

例えば、多くの国では小数点をドット（.）で表しますが、一部の国ではコンマ（,）を使用します。この定数を指定しない場合、min_rangeやmax_rangeに設定した値がロケールの影響を受けてしまい、意図しない範囲で検証が行われる可能性があります。FILTER_FLAG_GLOBAL_RANGEを用いることで、これらの範囲値は常にドット区切りの標準的な数値として扱われるため、予期せぬ挙動を防ぎ、どの環境でも一貫した検証結果を得られます。

提供されたサンプルコードでは、validateNumberWithGlobalRangeFlag関数が文字列である引数$inputを受け取り、その値が1から100の範囲の整数であるかを検証しています。この関数は、検証結果を示すメッセージを文字列として戻り値で返します。filter_var()関数にFILTER_FLAG_GLOBAL_RANGEを渡すことで、指定した1から100という範囲が、ロケールに左右されずに正しく適用されることを具体的に示しています。これにより、堅牢な数値入力検証を実装できるようになります。

Copy
1<?php
2
3/**
4 * 指定されたIPアドレスがプライベートレンジに属さず、かつ有効であるかを検証します。
5 *
6 * FILTER_FLAG_NO_PRIV_RANGE フラグは、RFC 1918 で定義されたプライベートIPアドレスの範囲
7 * (例: 10.0.0.0/8, 172.16.0.0/12, 192.168.0.0/16) に属するIPアドレスを無効と判断します。
8 * これにより、外部ネットワークからアクセス可能なグローバルIPアドレスのみを許可する
9 * 検証に利用できます。
10 *
11 * @param string $ipAddress 検証するIPアドレス文字列
12 * @return bool IPアドレスがグローバルIPアドレスとして有効な場合に true、
13 *              プライベートIPアドレスであるか、または無効な形式の場合は false を返します。
14 */
15function isValidGlobalIp(string $ipAddress): bool
16{
17    // filter_var関数を使用してIPアドレスを検証します。
18    // FILTER_VALIDATE_IP: IPアドレスの基本的な書式を検証します。
19    // FILTER_FLAG_NO_PRIV_RANGE: プライベートIPアドレスを無効と判断するフラグです。
20    //                            ループバックアドレス (127.0.0.1) も通常は有効と見なされます。
21    $result = filter_var(
22        $ipAddress,
23        FILTER_VALIDATE_IP,
24        FILTER_FLAG_NO_PRIV_RANGE
25    );
26
27    // filter_varは成功した場合にフィルタリングされた値（ここでは元のIPアドレス）、
28    // 失敗した場合は false を返します。
29    return $result !== false;
30}
31
32// --- サンプルコードの実行例 ---
33echo "--- IPアドレスのグローバルIP検証 ---" . PHP_EOL;
34
35$testIps = [
36    "8.8.8.8" => "グローバルIP (有効)",
37    "203.0.113.10" => "グローバルIP (有効)",
38    "192.168.1.1" => "プライベートIP (無効)",
39    "10.0.0.5" => "プライベートIP (無効)",
40    "172.16.0.1" => "プライベートIP (無効)",
41    "127.0.0.1" => "ループバックアドレス (通常は有効)", // FILTER_FLAG_NO_PRIV_RANGE はループバックをプライベートと見なしません
42    "invalid-ip-format" => "無効な形式 (無効)",
43    "256.0.0.1" => "不正なIPアドレス (無効)",
44];
45
46foreach ($testIps as $ip => $description) {
47    if (isValidGlobalIp($ip)) {
48        echo "✅ '{$ip}' ({$description}): グローバルIPとして有効です。" . PHP_EOL;
49    } else {
50        echo "❌ '{$ip}' ({$description}): グローバルIPとして無効です（プライベートIPか不正な形式）。" . PHP_EOL;
51    }
52}

このサンプルコードは、PHPのfilter_var関数とFILTER_FLAG_NO_PRIV_RANGEフラグを使い、与えられたIPアドレスがグローバルIPアドレスとして有効であるかを検証する方法を示しています。FILTER_FLAG_NO_PRIV_RANGEは、RFC 1918で定義されている10.0.0.0/8、172.16.0.0/12、192.168.0.0/16などのプライベートIPアドレス範囲を無効と判断するためのフラグです。これにより、インターネット経由でアクセスできるIPアドレスのみを許可したい場合に利用できます。

isValidGlobalIp関数は、検証したいIPアドレスの文字列を$ipAddressとして受け取ります。内部ではfilter_var関数を呼び出し、基本的なIPアドレスの書式を検証するFILTER_VALIDATE_IPと、プライベートIPアドレスを拒否するFILTER_FLAG_NO_PRIV_RANGEを組み合わせて使用しています。このフラグはループバックアドレス（例: 127.0.0.1）をプライベートIPアドレスとは見なしません。filter_var関数は検証に成功した場合、フィルタリングされた値（この場合は元のIPアドレス）を返し、失敗した場合はfalseを返します。したがって、isValidGlobalIp関数は、IPアドレスがグローバルIPとして有効であればtrueを、プライベートIPアドレスであるか、または不正な形式の場合はfalseを戻り値として返します。