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

Copy
1<?php
2
3/**
4 * FILTER_FLAG_EMPTY_STRING_NULL の動作を示すサンプル関数。
5 * 空文字列を null として扱うフィルタリングフラグの利用例です。
6 *
7 * このフラグは、filter_var() や filter_input() 関数などで使用し、
8 * 空の文字列 ('') を受け取った際に、結果を null に変換します。
9 * データベースへの保存などで、空文字列ではなく null を扱いたい場合に便利です。
10 */
11function demonstrateFilterEmptyStringNull(): void
12{
13    // テスト用の文字列データ
14    $emptyString = '';       // 空文字列
15    $normalString = 'PHP Programming'; // 通常の文字列
16    $whitespaceString = '   '; // スペースのみの文字列 (空文字列とは異なる)
17
18    echo "--- FILTER_FLAG_EMPTY_STRING_NULL の効果の比較 ---\n\n";
19
20    echo "元の値: \$emptyString = " . var_export($emptyString, true) . "\n";
21    echo "元の値: \$normalString = " . var_export($normalString, true) . "\n";
22    echo "元の値: \$whitespaceString = " . var_export($whitespaceString, true) . "\n\n";
23
24    // 1. FILTER_FLAG_EMPTY_STRING_NULL を使用しない場合
25    echo "--- FILTER_UNSAFE_RAW (フラグなし) --- (空文字列は空文字列のまま)\n";
26    $resultWithoutFlagEmpty = filter_var($emptyString, FILTER_UNSAFE_RAW);
27    echo "空文字列 ('') をフィルタリング: " . var_export($resultWithoutFlagEmpty, true) . "\n";
28    echo "結果が null か: " . var_export($resultWithoutFlagEmpty === null, true) . "\n\n";
29
30    // 2. FILTER_FLAG_EMPTY_STRING_NULL を使用する場合
31    echo "--- FILTER_UNSAFE_RAW (FILTER_FLAG_EMPTY_STRING_NULL フラグあり) --- (空文字列は null に変換)\n";
32    $resultWithFlagEmpty = filter_var($emptyString, FILTER_UNSAFE_RAW, FILTER_FLAG_EMPTY_STRING_NULL);
33    echo "空文字列 ('') をフィルタリング: " . var_export($resultWithFlagEmpty, true) . "\n";
34    echo "結果が null か: " . var_export($resultWithFlagEmpty === null, true) . "\n\n";
35
36    // 通常の文字列に対する効果 (変更されないことを示す)
37    echo "--- FILTER_UNSAFE_RAW (FILTER_FLAG_EMPTY_STRING_NULL フラグあり、通常の文字列) ---\n";
38    $resultWithFlagNormal = filter_var($normalString, FILTER_UNSAFE_RAW, FILTER_FLAG_EMPTY_STRING_NULL);
39    echo "通常の文字列 ('PHP Programming') をフィルタリング: " . var_export($resultWithFlagNormal, true) . "\n";
40    echo "結果が null か: " . var_export($resultWithFlagNormal === null, true) . "\n\n";
41
42    // スペースのみの文字列に対する効果 (空文字列ではないため、変更されない)
43    echo "--- FILTER_UNSAFE_RAW (FILTER_FLAG_EMPTY_STRING_NULL フラグあり、スペースのみの文字列) ---\n";
44    $resultWithFlagWhitespace = filter_var($whitespaceString, FILTER_UNSAFE_RAW, FILTER_FLAG_EMPTY_STRING_NULL);
45    echo "空白文字列 ('   ') をフィルタリング: " . var_export($resultWithFlagWhitespace, true) . "\n";
46    echo "結果が null か: " . var_export($resultWithFlagWhitespace === null, true) . "\n";
47}
48
49// 関数を実行して動作を確認
50demonstrateFilterEmptyStringNull();

FILTER_FLAG_EMPTY_STRING_NULLは、PHPのフィルタリング機能で使用される定数です。この定数を指定することで、空の文字列（''）をフィルタリングした際に、その結果をnullに変換する挙動を設定できます。引数はなく、内部的には整数値（int）を返します。主にfilter_var()やfilter_input()といった関数に、フィルタリングの「フラグ」として渡して利用します。

サンプルコードは、この定数の効果を具体的に示しています。まず、このフラグを指定しない場合、空文字列はフィルタリング後も空文字列のままです。しかし、FILTER_FLAG_EMPTY_STRING_NULLをfilter_var()関数のフラグとして追加すると、空文字列はnullに変換されます。これにより、データベースへの保存などで、空文字列ではなくnullとして扱いたい場合に便利です。また、通常の文字列や、スペースのみの文字列（空文字列とは異なる）は、このフラグの影響を受けずに元の文字列のまま処理されることも確認できます。

Copy
1<?php
2
3/**
4 * ユーザー入力から安全な整数値を抽出します。
5 *
6 * この関数は、入力文字列から数字以外の文字をすべて取り除き、整数値として返します。
7 * 入力値が空文字列である場合は、NULLを返します。
8 *
9 * @param string|null $input 処理する入力文字列。null も許容します。
10 * @return int|null サニタイズされた整数値、または入力が空文字列や無効な場合にNULL。
11 */
12function sanitizeIntegerInput(?string $input): ?int
13{
14    // filter_var関数を使用して入力値をサニタイズ（無害化）します。
15    // FILTER_SANITIZE_NUMBER_INT: 入力値から数字 ('+', '-', '0'-'9') 以外の文字をすべて除去します。
16    // FILTER_FLAG_EMPTY_STRING_NULL: サニタイズの結果が空文字列になった場合、NULLを返します。
17    // これにより、空文字列が '0' として扱われることを防ぎます。
18    $sanitizedValue = filter_var(
19        $input,
20        FILTER_SANITIZE_NUMBER_INT,
21        FILTER_FLAG_EMPTY_STRING_NULL
22    );
23
24    // filter_varは文字列またはNULLを返すため、結果がNULLでない場合は整数型にキャストします。
25    return ($sanitizedValue === null) ? null : (int) $sanitizedValue;
26}
27
28// --- サンプルコードの動作確認 ---
29
30echo "--- 整数値のサニタイズ例 ---" . PHP_EOL;
31
32// 1. 標準的な整数値を含む文字列
33$input1 = "12345";
34$result1 = sanitizeIntegerInput($input1);
35echo "入力: '" . $input1 . "' => 結果: " . var_export($result1, true) . PHP_EOL;
36
37// 2. 数字と文字が混在する文字列
38$input2 = "abc123def45";
39$result2 = sanitizeIntegerInput($input2);
40echo "入力: '" . $input2 . "' => 結果: " . var_export($result2, true) . PHP_EOL;
41
42// 3. 負の数を含む文字列
43$input3 = "-6789";
44$result3 = sanitizeIntegerInput($input3);
45echo "入力: '" . $input3 . "' => 結果: " . var_export($result3, true) . PHP_EOL;
46
47// 4. 空文字列
48$input4 = "";
49$result4 = sanitizeIntegerInput($input4);
50echo "入力: '" . $input4 . "' => 結果: " . var_export($result4, true) . PHP_EOL;
51
52// 5. NULL 入力
53$input5 = null;
54$result5 = sanitizeIntegerInput($input5);
55echo "入力: " . var_export($input5, true) . " => 結果: " . var_export($result5, true) . PHP_EOL;
56
57// 6. 数字以外の文字のみの文字列 (結果が空文字列になり、NULLに変換される)
58$input6 = "hello world";
59$result6 = sanitizeIntegerInput($input6);
60echo "入力: '" . $input6 . "' => 結果: " . var_export($result6, true) . PHP_EOL;
61
62// 7. 数字が含まれるが、スペースなどの余分な文字がある場合
63$input7 = "  123.45  "; // 小数点は除去され、整数部分のみが残る
64$result7 = sanitizeIntegerInput($input7);
65echo "入力: '" . $input7 . "' => 結果: " . var_export($result7, true) . PHP_EOL;

このコードは、ユーザーからの入力値を安全な整数（int）に変換するsanitizeIntegerInput関数を説明しています。ウェブアプリケーションなどでユーザーが入力したデータの中から、数字だけを正確に抽出し、安全に利用できるように「サニタイズ（無害化）」することが主な目的です。

関数内部では、PHPの組み込み関数であるfilter_varを使用しています。この関数にFILTER_SANITIZE_NUMBER_INTを指定することで、入力文字列から数字、プラス記号、マイナス記号以外の文字をすべて取り除きます。例えば、「abc123def」という入力は「123」になります。

特に重要なのは、オプションとしてFILTER_FLAG_EMPTY_STRING_NULLを指定している点です。これは、サニタイズ処理の結果が空文字列になった場合（例えば、「hello world」のような数字を全く含まない文字列が入力された場合）、その結果をNULLとして返すようにするフラグです。この設定により、空の入力や数字を含まない入力が意図せず0として扱われることを防ぎ、データの正確性を保つことができます。

sanitizeIntegerInput関数は、処理対象となるstringまたはnullを引数として受け取ります。戻り値は、サニタイズされた整数値（int）か、入力が空文字列や無効な場合にnullを返します。これにより、開発者は入力値の有無を明確に判断し、適切な処理を行うことが可能になります。