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

Copy
1<?php
2
3/**
4 * FILTER_FLAG_ALLOW_FRACTION の使用例を示します。
5 * このフラグは、filter_var() 関数で数値をサニタイズ（無害化）する際に、
6 * 小数点以下の値（分数部）を許可するために使用されます。
7 */
8function demonstrateFilterFlagAllowFraction(): void
9{
10    // サニタイズ対象の文字列
11    $inputString = "ユーザー入力の価格: 123.45 ドル";
12
13    echo "--- 入力文字列: '{$inputString}' ---\n\n";
14
15    // 1. FILTER_FLAG_ALLOW_FRACTION を指定しない場合
16    // 小数点（.）が許可されないため、除去されます。
17    echo "小数点以下の値 ('FILTER_FLAG_ALLOW_FRACTION' なし) を許可しない場合:\n";
18    $sanitizedWithoutFraction = filter_var(
19        $inputString,
20        FILTER_SANITIZE_NUMBER_FLOAT // 数値以外の文字を除去するフィルタ
21    );
22    // 結果は "12345" となり、小数点とそれに続く数字が結合されます
23    echo "結果: " . var_export($sanitizedWithoutFraction, true) . "\n\n";
24
25    // 2. FILTER_FLAG_ALLOW_FRACTION を指定する場合
26    // 小数点（.）が許可され、維持されます。
27    echo "小数点以下の値 ('FILTER_FLAG_ALLOW_FRACTION' あり) を許可する場合:\n";
28    $sanitizedWithFraction = filter_var(
29        $inputString,
30        FILTER_SANITIZE_NUMBER_FLOAT, // 数値以外の文字を除去するフィルタ
31        FILTER_FLAG_ALLOW_FRACTION    // 小数点以下の値を許可するフラグ
32    );
33    // 結果は "123.45" となり、小数点とそれに続く数字が維持されます
34    echo "結果: " . var_export($sanitizedWithFraction, true) . "\n\n";
35
36    echo "この例から、FILTER_FLAG_ALLOW_FRACTION が\n";
37    echo "filter_var() による数値のサニタイズ時に小数点の扱いに\n";
38    echo "どのように影響するかが分かります。\n";
39}
40
41// 関数の実行
42demonstrateFilterFlagAllowFraction();
43
44?>

PHP 8で提供されるFILTER_FLAG_ALLOW_FRACTIONは、主にユーザーからの数値入力などを安全に処理（サニタイズ）する際に使用される定数です。この定数自体に引数や戻り値はなく、filter_var()関数などのフィルタリング関数にオプションとして渡すことで、特定の挙動を制御するために利用されます。

具体的には、filter_var()関数でFILTER_SANITIZE_NUMBER_FLOATフィルタを用いて文字列から浮動小数点数（小数を含む数値）を抽出する場合に、その動作を制御します。このフィルタのデフォルト設定では、小数点以下の値が除去され、例えば「123.45」という文字列からは「12345」のように小数点とそれに続く数字が結合されてしまいます。

そこで、FILTER_FLAG_ALLOW_FRACTIONをfilter_var()関数の第三引数として指定すると、小数点以下の値の除去を防ぎ、入力された文字列中の小数点とそれに続く数字を維持します。これにより、「123.45」は正確に「123.45」として抽出されるようになります。

このフラグは、ECサイトでの価格や計測データなど、小数点以下の正確な数値が重要なデータをユーザーから受け取る際に、意図しないデータ変換を防ぎ、データの一貫性を保つために非常に役立ちます。データの信頼性を高める上で重要な役割を果たす定数です。

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * 指定された文字列が有効なIPアドレスであるかを検証します。
7 *
8 * この関数は、PHPのfilter_var関数とFILTER_VALIDATE_IPフィルターを使用して、
9 * 入力された文字列が有効なIPv4またはIPv6アドレスの形式に準拠しているかを確認します。
10 * システムエンジニアを目指す初心者の方にも理解しやすいよう、簡潔な例を提供します。
11 *
12 * @param string $ipAddress 検証対象のIPアドレス文字列。
13 * @return bool 有効なIPアドレスであれば true、そうでなければ false を返します。
14 */
15function isValidIpAddress(string $ipAddress): bool
16{
17    // filter_var関数は、変数をフィルタリングまたは検証するために使用されます。
18    // 第一引数には検証する変数、第二引数には適用するフィルターを指定します。
19    // FILTER_VALIDATE_IPは、入力が有効なIPアドレス（IPv4またはIPv6）であるかを検証します。
20    // デフォルトでは、IPv4とIPv6の両方の形式を許可します。
21    // filter_varは、有効な場合はフィルターされたデータ（この場合はIPアドレス文字列）を返し、
22    // 無効な場合はfalseを返します。
23    // そのため、戻り値がfalseと厳密に等しくないかをチェックすることで、有効性を判断します。
24    return filter_var($ipAddress, FILTER_VALIDATE_IP) !== false;
25}
26
27// --- サンプル使用例 ---
28$testIpAddresses = [
29    "192.168.1.1",       // 有効なIPv4アドレスの例
30    "2001:0db8::1",      // 有効なIPv6アドレスの例
31    "127.0.0.1",         // ループバックIPv4アドレスの例
32    "::1",               // ループバックIPv6アドレスの例
33    "256.256.256.256",   // 無効なIPv4アドレス（オクテットが範囲外）
34    "192.168.1.1.2",     // 無効なIPv4アドレス（形式が不正）
35    "not.an.ip.address", // IPアドレスではない文字列
36    "10.0.0.1/24",       // CIDR表記（filter_varでは直接検証できない）
37];
38
39foreach ($testIpAddresses as $ip) {
40    if (isValidIpAddress($ip)) {
41        echo "IPアドレス \"{$ip}\" は有効です。" . PHP_EOL;
42    } else {
43        echo "IPアドレス \"{$ip}\" は無効です。" . PHP_EOL;
44    }
45}

このPHPサンプルコードは、入力された文字列が有効なIPアドレスであるかを検証する簡単な方法を示しています。Webアプリケーションなどでユーザーからの入力値が正しいIPアドレス形式であるかを確認する際に非常に役立ちます。

コードの中心であるisValidIpAddress関数は、PHPの組み込み関数filter_varと定数FILTER_VALIDATE_IPを組み合わせて利用します。filter_var関数は、変数をフィルタリングまたは検証するための汎用的な関数で、第一引数に検証したいデータ、第二引数に適用するフィルターを指定します。ここで使われるFILTER_VALIDATE_IPは、入力された文字列がIPv4またはIPv6のいずれかの有効なIPアドレス形式に合致するかどうかを厳密にチェックするフィルターです。

isValidIpAddress関数は、検証対象のIPアドレス文字列を引数として受け取ります。filter_var関数は、IPアドレスが有効な場合はそのIPアドレス文字列をそのまま返し、無効な場合は論理値のfalseを返します。この特性を利用し、filter_varの戻り値がfalseと厳密に等しくないかを判断することで、IPアドレスの有効性を判定します。最終的に、有効なIPアドレスであればtrueを、無効であればfalseを返します。この検証は、外部からの不正確な入力を防ぎ、システムのセキュリティと安定性を保つ上で重要な役割を果たします。