【PHP8.x】RecursiveRegexIterator::ALL_MATCHES定数の使い方

Copy
1<?php
2
3/**
4 * RecursiveRegexIterator::ALL_MATCHES フラグを使用して、
5 * 階層的なデータ構造から正規表現にマッチするすべての要素とキャプチャグループを抽出するサンプルコード。
6 *
7 * このフラグを設定すると、イテレータの current() メソッドは、
8 * preg_match_all() の PREG_SET_ORDER フラグを用いた場合と同様に、
9 * 現在のデータエントリ内におけるすべての正規表現マッチを、キャプチャグループを含む多次元配列として返します。
10 * これにより、個々のマッチの詳細（フルマッチ文字列、各キャプチャグループの値）にアクセスできます。
11 */
12function demonstrateRecursiveRegexIteratorAllMatches(): void
13{
14    // 検索対象となる階層的なデータ構造を準備します。
15    // RecursiveRegexIterator は RecursiveArrayIterator などのイテレータを基盤とします。
16    $data = [
17        'messages' => [
18            'greeting' => 'Hello, world! How are you today? world is beautiful.',
19            'farewell' => 'Goodbye, world of PHP.',
20        ],
21        'details' => [
22            'item1' => 'This is a test. Another test string.',
23            'item2' => 'No match here.', // この文字列にはマッチするパターンはありません
24            'sub_details' => [
25                'nested_item' => 'Yet another test for the test world.',
26            ],
27        ],
28        'single_string' => 'Test with multiple tests in one string.',
29    ];
30
31    // RecursiveArrayIterator を作成し、上記データをイテレータの基盤とします。
32    $arrayIterator = new RecursiveArrayIterator($data);
33
34    // 正規表現を定義します。
35    // ここでは 'world' または 'test' という単語（大文字小文字を区別しない）をキャプチャします。
36    // (world|test) の括弧は、これが1番目のキャプチャグループであることを示します。
37    $regex = '/(world|test)/i';
38
39    // RecursiveRegexIterator をインスタンス化し、ALL_MATCHES フラグを設定します。
40    // このフラグにより、イテレータは各要素に対して正規表現の全マッチを返します。
41    $regexIterator = new RecursiveRegexIterator(
42        $arrayIterator, // 基盤となるイテレータ
43        $regex,         // 使用する正規表現
44        RecursiveRegexIterator::ALL_MATCHES // ALL_MATCHES フラグを設定
45    );
46
47    echo "--- RecursiveRegexIterator::ALL_MATCHES のデモンストレーション ---\n";
48    echo "このサンプルは、階層的なデータ構造から正規表現の全マッチとそのキャプチャグループを抽出する方法を示します。\n\n";
49
50    // RecursiveIteratorIterator を使用して、RecursiveRegexIterator を再帰的に走査します。
51    // RecursiveIteratorIterator::LEAVES_ONLY は、ツリーの「葉」にあたる要素（ここでは文字列）のみを対象とします。
52    $iterator = new RecursiveIteratorIterator($regexIterator, RecursiveIteratorIterator::LEAVES_ONLY);
53
54    // イテレータをループして、マッチした結果を表示します。
55    foreach ($iterator as $key => $allMatchesForCurrentEntry) {
56        // 現在処理している元のデータのキーを表示
57        echo "元のデータのキー: '" . htmlspecialchars($key) . "'\n";
58        echo "このエントリで見つかったマッチ:\n";
59
60        // $allMatchesForCurrentEntry は、preg_match_all() の PREG_SET_ORDER フラグを
61        // 使用した結果と同様の多次元配列になります。
62        // 例: [ ['フルマッチ1', 'グループ1_1'], ['フルマッチ2', 'グループ1_2'] ]
63        if (is_array($allMatchesForCurrentEntry) && !empty($allMatchesForCurrentEntry)) {
64            foreach ($allMatchesForCurrentEntry as $matchDetails) {
65                // $matchDetails[0] は正規表現にマッチした文字列全体
66                // $matchDetails[1] は1番目のキャプチャグループ ([0]はworld|[1]はtest) の値
67                echo "  - フルマッチ: '" . htmlspecialchars($matchDetails[0] ?? 'N/A') . "'\n";
68                echo "    キャプチャされた単語: '" . htmlspecialchars($matchDetails[1] ?? 'N/A') . "'\n";
69            }
70        } else {
71            // マッチが見つからなかった、または無効なエントリタイプの場合
72            echo "  マッチが見つかりませんでした。\n";
73        }
74        echo "\n";
75    }
76}
77
78// 上記の関数を実行し、デモンストレーションを開始します。
79demonstrateRecursiveRegexIteratorAllMatches();

RecursiveRegexIterator::ALL_MATCHESは、PHPのRecursiveRegexIteratorクラスで使用される定数です。この定数を指定すると、階層的なデータ構造の中から、正規表現にマッチするすべての要素と、そのキャプチャグループを詳細に抽出できるようになります。この定数自体は引数を必要とせず、内部では整数値として扱われます。

サンプルコードでは、入れ子になった配列データから「world」または「test」という単語を検索する例を通じて、その働きを具体的に示しています。RecursiveRegexIteratorをインスタンス化する際にRecursiveRegexIterator::ALL_MATCHESフラグを設定すると、イテレータのcurrent()メソッドは、検索対象の各データエントリ内で見つかった正規表現のすべての一致を、キャプチャグループを含んだ多次元配列として返します。これは、preg_match_all()関数でPREG_SET_ORDERフラグを使用した場合と同様の形式です。

この設定により、イテレータをループして処理する際、マッチした文字列全体（フルマッチ）と、正規表現で定義された各キャプチャグループの値に、それぞれ個別にアクセスできるようになります。これにより、一つのデータエントリ内で同じパターンが複数回出現する場合でも、全てのマッチを漏れなく取得し、詳細を分析することが可能です。

Copy
1<?php
2
3/**
4 * 指定された文字列配列の各要素から、正規表現にマッチするすべての部分文字列を検出します。
5 *
6 * この関数は RecursiveRegexIterator クラスの ALL_MATCHES 定数を利用して、
7 * イテレータの各要素内で見つかった全てのマッチを効率的に取得します。
8 * RecursiveRegexIterator::ALL_MATCHES 定数を指定することで、
9 * getRegex() メソッドが preg_match_all のように各要素内の全てのマッチを返せるようになります。
10 *
11 * @param array<string> $data 検索対象となる文字列の配列。
12 * @param string $pattern 検索に使用する正規表現パターン。例: '/(apple|banana)/i'
13 * @return array<int, array<string>> 各要素で見つかった全ての完全マッチを含む配列。
14 *                                  例: [['apple', 'banana'], ['banana', 'berry'], ...]
15 *                                  マッチが見つからない場合は空の配列を返します。
16 */
17function findAllMatchesWithRecursiveRegexIterator(array $data, string $pattern): array
18{
19    // 1. 検索対象の配列を RecursiveArrayIterator でラップします。
20    //    これにより、配列を再帰的なイテレータとして扱うことができるようになります。
21    $arrayIterator = new RecursiveArrayIterator($data);
22
23    // 2. RecursiveRegexIterator を使用して正規表現によるフィルタリングとマッチングを行います。
24    //    - 第一引数: 内部イテレータ (RecursiveArrayIterator)
25    //    - 第二引数: 適用する正規表現パターン
26    //    - 第三引数: モード。RecursiveRegexIterator::ALL_MATCHES を指定することで、
27    //                getRegex() メソッドが各要素内の全てのマッチを返せるようになります。
28    $regexIterator = new RecursiveRegexIterator(
29        $arrayIterator,
30        $pattern,
31        RecursiveRegexIterator::ALL_MATCHES
32    );
33
34    $allFoundMatches = [];
35
36    // 3. イテレータをループして結果を取得します。
37    //    regexIterator は、パターンにマッチする要素のみを処理します。
38    foreach ($regexIterator as $key => $value) {
39        // RecursiveRegexIterator::ALL_MATCHES モードの場合、
40        // getRegex() メソッドを呼び出すことで、preg_match_all と同様に、
41        // 現在の要素内で見つかった全ての正規表現マッチ（サブパターンを含む）を取得できます。
42        // 結果は、[0 => [完全マッチ1, 完全マッチ2, ...], 1 => [キャプチャグループ1のマッチ1, ...], ...]
43        $matchesInCurrentElement = $regexIterator->getRegex();
44
45        // matchesInCurrentElement[0] には、パターン全体にマッチした全ての文字列が格納されています。
46        // これがキーワード「find all matches」の主要な結果となります。
47        if (!empty($matchesInCurrentElement[0])) {
48            $allFoundMatches[] = $matchesInCurrentElement[0];
49        }
50    }
51
52    return $allFoundMatches;
53}
54
55// --- 関数利用例 ---
56
57// 検索対象となる文字列の配列
58$sampleStrings = [
59    "apple banana orange",
60    "grape kiwi lemon",
61    "banana berry cherry",
62    "apple pie is tasty",
63    "no fruit here at all",
64];
65
66// 検索する正規表現パターン。
67// この例では、'apple' または 'banana' を大文字小文字を区別せず検索します。
68$searchPattern = '/(apple|banana)/i';
69
70echo "--- サンプルコード実行結果 ---\n\n";
71echo "検索対象の文字列配列:\n";
72foreach ($sampleStrings as $str) {
73    echo "- \"{$str}\"\n";
74}
75echo "\n検索パターン: \"{$searchPattern}\"\n\n";
76
77// 関数を呼び出して全てのマッチを検出
78$resultMatches = findAllMatchesWithRecursiveRegexIterator($sampleStrings, $searchPattern);
79
80if (!empty($resultMatches)) {
81    echo "検出された全てのマッチ:\n";
82    foreach ($resultMatches as $elementMatches) {
83        echo "  - [ " . implode(", ", $elementMatches) . " ]\n";
84    }
85} else {
86    echo "マッチする結果は見つかりませんでした。\n";
87}
88

PHP 8のRecursiveRegexIterator::ALL_MATCHES定数は、正規表現を使って複数の文字列の中から、特定のパターンに合致する部分を「全て」検出したい場合に利用するモード指定定数です。この定数自体は引数を取らず、整数値（int）を返します。

提供されたサンプルコードのfindAllMatchesWithRecursiveRegexIterator関数は、検索対象となる文字列の配列（$data）と、検索に使用する正規表現パターン（$pattern）を引数として受け取ります。そして、各要素で見つかった全ての完全マッチを含む配列を戻り値として返します。

関数内では、まず入力配列をRecursiveArrayIteratorでラップし、それをRecursiveRegexIteratorに渡して正規表現によるフィルタリングとマッチングを行います。この際、RecursiveRegexIteratorのコンストラクタの第三引数にRecursiveRegexIterator::ALL_MATCHESを指定することが重要です。この定数を指定することで、イテレータは配列内の各文字列に対して、最初に見つかるマッチだけでなく、正規表現パターンに合致するすべての部分文字列を検出するモードで動作するようになります。

イテレータをループ処理する中で、$regexIterator->getRegex()メソッドを呼び出すことで、現在の要素内で検出された全ての正規表現マッチを、PHPのpreg_match_all関数のように効率的に取得できます。この機能を利用することで、システムエンジニアの初心者が複数のテキストデータから、条件に合う全ての情報を漏れなく抽出するような処理を、簡潔かつ効率的に実装できるようになります。