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

Copy
1<?php
2
3/**
4 * 入力されたIDをサニタイズし、常に配列として処理するサンプル関数。
5 *
6 * FILTER_FORCE_ARRAY定数を使用して、単一の入力値でも強制的に配列として扱います。
7 * その後、foreachループで各要素を処理し、array_filterでさらにフィルタリングを行います。
8 *
9 * @param string|array $inputIds 処理対象のID（文字列または文字列の配列）
10 */
11function processUserIds(string|array $inputIds): void
12{
13    echo "--- 入力 '";
14    if (is_array($inputIds)) {
15        echo implode(", ", $inputIds); // 配列の場合は要素をカンマで結合して表示
16    } else {
17        echo $inputIds; // 文字列の場合はそのまま表示
18    }
19    echo "' の処理 ---" . PHP_EOL;
20
21    // ステップ1: filter_var 関数と FILTER_FORCE_ARRAY 定数を使用して、入力値をサニタイズします。
22    // FILTER_FORCE_ARRAY は、入力が単一の値であっても、結果を常に配列として返します。
23    // FILTER_SANITIZE_NUMBER_INT は、数値以外の文字をすべて除去し、残った数値を文字列として返します。
24    // 例: "abc123xyz" -> "123"
25    // 例: "hello" -> "" (空文字列)
26    $sanitizedIds = filter_var(
27        $inputIds,
28        FILTER_SANITIZE_NUMBER_INT,
29        FILTER_FORCE_ARRAY // この定数により、結果は常に配列になります。
30    );
31
32    echo "  filter_var と FILTER_FORCE_ARRAY 適用後のID: ";
33    print_r($sanitizedIds); // 配列の中身を表示
34
35    // ステップ2: foreach ループを使って、サニタイズされたIDを一つずつ処理します。
36    // FILTER_SANITIZE_NUMBER_INT は、数値がない場合に空文字列を返すことがあるため、
37    // ここではそれもそのまま含めて表示しています。
38    if (!empty($sanitizedIds)) {
39        echo "  各IDの個別の処理 (foreach):" . PHP_EOL;
40        foreach ($sanitizedIds as $index => $id) {
41            echo "    - ID[" . $index . "]: '" . $id . "'" . PHP_EOL;
42        }
43    } else {
44        echo "  有効なIDは見つかりませんでした。" . PHP_EOL;
45    }
46
47    // ステップ3: array_filter 関数を使用して、サニタイズされたIDの中から空ではない値のみを抽出します。
48    // filter_var(..., FILTER_SANITIZE_NUMBER_INT) は、数値が全くない入力に対しては空文字列を返します。
49    // このステップで、それらの空文字列を除去し、有効な数値IDだけを残します。
50    // fn($id) => $id !== '' は、PHP 8で導入された短縮クロージャ（アロー関数）です。
51    $filteredAndCleanedIds = array_filter(
52        $sanitizedIds,
53        fn($id) => $id !== '' // 空文字列ではない要素だけを残す
54    );
55
56    echo "  array_filter で空文字列を除去後のID: ";
57    print_r($filteredAndCleanedIds);
58
59    // ステップ4: 最終的に処理対象となるIDを再度 foreach で確認します。
60    if (!empty($filteredAndCleanedIds)) {
61        echo "  最終的に処理対象となるIDの確認 (foreach):" . PHP_EOL;
62        foreach ($filteredAndCleanedIds as $index => $id) {
63            echo "    - 最終ID[" . $index . "]: '" . $id . "'" . PHP_EOL;
64        }
65    } else {
66        echo "  最終的に処理できる有効なIDはありませんでした。" . PHP_EOL;
67    }
68
69    echo PHP_EOL;
70}
71
72// --- テストケース ---
73
74// 1. 単一の有効な文字列ID
75processUserIds("123");
76
77// 2. 複数の有効な文字列ID（配列形式）
78processUserIds(["456", "789"]);
79
80// 3. 無効な値と有効な値が混在する配列
81//   "abc" -> "" (空文字列)
82//   "101" -> "101"
83//   "xyz" -> "" (空文字列)
84//   "202" -> "202"
85processUserIds(["abc", "101", "xyz", "202"]);
86
87// 4. 全て無効な値（単一の文字列）
88//   "hello" -> "" (空文字列)
89processUserIds("hello");
90
91// 5. 空の配列
92processUserIds([]);
93
94// 6. 整数型でも試す (filter_varは型を問わずサニタイズし、結果を文字列で返す)
95processUserIds(321);
96
97// 7. 混合型（数値、文字列、無効な文字列）
98processUserIds([10, "test40", "50_final", "no_number"]);
99
100?>

このPHPサンプルコードは、ユーザーIDなどの様々な入力値を安全に処理し、常に配列として扱えるようにする方法を示しています。コードの中心となるのは、PHP 8で導入されたFILTER_FORCE_ARRAY定数です。この定数はfilter_var関数のオプションとして使用され、入力値が単一の文字列であっても、処理結果を強制的に配列として返します。これにより、どのような形式の入力であっても一貫して配列として処理できるため、コードの堅牢性が向上します。

filter_var関数は、指定されたフィルタを使って入力値をサニタイズ（無害化）します。このコードではFILTER_SANITIZE_NUMBER_INTが使われており、入力値から数値以外の文字をすべて除去し、残った数値を文字列として返します。もし数値が全く含まれない場合は空文字列が返されます。

サニタイズされた後、コードはforeachループを使って配列の各要素を一つずつ確認し、個別の処理が可能であることを示しています。さらに、array_filter関数を使用し、FILTER_SANITIZE_NUMBER_INTによって生成された空文字列のIDを配列から取り除きます。array_filterは、指定された条件（ここでは空文字列ではないこと）を満たす要素のみを抽出して新しい配列として返します。

このように、FILTER_FORCE_ARRAY、filter_var、foreach、array_filterを組み合わせることで、多様な入力形式のIDを安全かつ効率的に取得し、常にクリーンな数値IDの配列として扱うことが可能になります。これは、セキュリティとデータの一貫性を確保する上で非常に有効なアプローチです。

Copy
1<?php
2
3/**
4 * 入力を常に配列として扱い、空でない要素をフィルタリングして返す関数。
5 *
6 * この関数は、入力が単一の値であっても配列であっても、一貫して配列として処理することを目的としています。
7 * これは、`filter_var` などのフィルタリング関数で使用される `FILTER_FORCE_ARRAY` 定数
8 * （入力値を強制的に配列として扱うためのフラグで、戻り値は `int` 型の整数値）の概念に似ています。
9 *
10 * @param mixed $input 単一の値、または配列。
11 * @return array 空でない要素のみを含む、インデックスが振り直された配列。
12 */
13function processInputAsArray(mixed $input): array
14{
15    // STEP 1: 入力を常に配列として強制する
16    // `FILTER_FORCE_ARRAY` 定数の概念を模倣し、単一の値を配列でラップします。
17    // これにより、後続の配列操作が安定して行えます。
18    $data = is_array($input) ? $input : [$input];
19
20    // STEP 2: `array_filter` を使って、配列から空の要素や偽と評価される要素を除去する
21    // コールバック関数を省略した場合、`array_filter` は要素が `false` と評価されるもの
22    // （例: null, 0, "", false など）を除去します。
23    $filteredData = array_filter($data);
24
25    // STEP 3: `array_values` を使って、フィルタリングによって生じたキーのギャップを修正し、
26    // 連続した数値インデックスを持つ新しい配列を生成する
27    $finalArray = array_values($filteredData);
28
29    return $finalArray;
30}
31
32// --- 関数利用例 ---
33
34// 1. 単一の文字列が入力された場合
35echo "--- 単一の文字列入力 ---" . PHP_EOL;
36$singleStringInput = "PHP プログラミング言語";
37print_r(processInputAsArray($singleStringInput));
38
39// 2. 複数の要素を含む配列が入力された場合（有効な値と無効な値を含む）
40echo PHP_EOL . "--- 配列入力 (有効な値と無効な値) ---" . PHP_EOL;
41$arrayInput = ["apple", "", "banana", null, "orange", 0];
42print_r(processInputAsArray($arrayInput));
43
44// 3. 空の文字列や数値の0が入力された場合
45echo PHP_EOL . "--- 空の入力 ---" . PHP_EOL;
46$emptyString = "";
47print_r(processInputAsArray($emptyString));
48
49$zeroValue = 0;
50print_r(processInputAsArray($zeroValue));
51
52?>

PHP 8におけるFILTER_FORCE_ARRAY定数は、filter_varなどのフィルタリング関数で入力値を強制的に配列として扱うためのフラグであり、整数値を返します。このサンプルコードは、そのFILTER_FORCE_ARRAYの概念を模倣し、入力された値を常に配列として処理し、空でない有効な要素だけを抽出して返す関数processInputAsArrayを定義しています。

関数processInputAsArrayは、引数$inputとして単一の値または配列を受け取ります。関数内では、まずis_array関数で入力が配列かどうかを確認し、配列でない場合は単一の値を要素とする配列に変換することで、入力を常に配列として扱います。次に、array_filter関数を使用して、変換された配列からnull、空文字列、0、falseなど、偽と評価される要素を除去します。最後に、array_values関数を用いて、フィルタリングによって生じたキーの欠損を埋め、連続した数値インデックスを持つ新しい配列を生成して戻り値として返します。これにより、どのような入力に対しても、処理後の結果は整然とした配列として得られ、データの一貫した処理が必要な場面で役立ちます。