【PHP8.x】RecursiveRegexIterator::getChildren()メソッドの使い方

Copy
1<?php
2
3/**
4 * RecursiveRegexIterator::getChildren() の使用例を示します。
5 *
6 * この例では、ネストされた配列から正規表現に一致する要素を再帰的に検索し、
7 * その結果を表示します。RecursiveIteratorIterator は、内部で
8 * RecursiveRegexIterator の hasChildren() と getChildren() メソッドを呼び出し、
9 * 配列の階層構造を再帰的にトラバースします。
10 */
11
12// サンプルデータとして、ネストされた配列を用意します。
13$data = [
14    'fruits' => [
15        'apple',
16        'banana',
17        'orange_juice' => [
18            'fresh_orange',
19            'grapefruit_juice',
20        ],
21    ],
22    'vegetables' => [
23        'carrot',
24        'potato_fries',
25        'tomato_soup',
26    ],
27    'other' => 'water_bottle',
28];
29
30// 1. RecursiveArrayIterator を使用して、配列をイテレータとして扱えるようにします。
31//    これにより、PHPのイテレータインターフェースを介して配列の要素にアクセスできます。
32$arrayIterator = new RecursiveArrayIterator($data);
33
34// 2. RecursiveRegexIterator を使用して、正規表現で要素をフィルタリングします。
35//    ここでは、「juicy」または「juice」という単語を含む要素を検索します（大文字小文字を区別しない）。
36//    GET_MATCH フラグは、マッチした文字列全体を返すように指定します。
37$regexIterator = new RecursiveRegexIterator(
38    $arrayIterator,
39    '/(juicy|juice)/i', // 正規表現: 'juicy' または 'juice' にマッチ
40    RecursiveRegexIterator::GET_MATCH
41);
42
43// 3. RecursiveIteratorIterator を使用して、RecursiveRegexIterator を再帰的にトラバースします。
44//    SELF_FIRST は、親要素を先に、その後で子要素を処理する順序を指定します。
45echo "正規表現に一致する要素（RecursiveRegexIterator を使用）:\n";
46$recursiveIterator = new RecursiveIteratorIterator($regexIterator, RecursiveIteratorIterator::SELF_FIRST);
47
48// イテレータをループして、フィルタリングされた要素と階層を表示します。
49foreach ($recursiveIterator as $key => $value) {
50    // getDepth() は現在の要素の深さを返します。これをインデントに使用して階層構造を視覚化します。
51    // RecursiveRegexIterator::getChildren() は、RecursiveIteratorIterator が
52    // 各階層の子要素を取得するために内部的に呼び出しているため、
53    // 通常の利用では明示的に呼び出す必要はありません。
54    echo str_repeat('  ', $recursiveIterator->getDepth()) . "- " . $value . "\n";
55}
56

RecursiveRegexIterator::getChildren()は、PHPのRecursiveRegexIteratorクラスに属するメソッドで、現在のイテレータが指す要素の子イテレータを取得するために使用されます。このメソッドは引数を受け取らず、現在のクラスであるRecursiveRegexIteratorのインスタンスを戻り値として返します。

RecursiveRegexIteratorは、元のイテレータ（例えば配列を扱うRecursiveArrayIteratorなど）の要素を正規表現でフィルタリングしながら、その階層構造を維持する再帰イテレータです。getChildren()メソッドは、主にRecursiveIteratorIteratorのような上位の再帰イテレータが、内部で要素の階層をトラバースする際に呼び出します。つまり、開発者が直接このメソッドを呼び出すことはほとんどありません。

提供されたサンプルコードでは、ネストされた配列をRecursiveArrayIteratorでイテレータ化し、それをRecursiveRegexIteratorでラップして「juice」や「juicy」を含む要素を正規表現でフィルタリングしています。さらに、RecursiveIteratorIteratorを用いてこのフィルタリングされたイテレータを再帰的に巡回しています。このRecursiveIteratorIteratorが、内部的にRecursiveRegexIteratorのhasChildren()で子要素の有無を確認し、getChildren()で実際に子イテレータを取得することで、ネストされた配列の全階層から正規表現に一致する要素が効率的に抽出され、深さを示すインデントと共に表示される仕組みです。

Copy
1<?php
2
3// このサンプルコードは、RecursiveRegexIterator クラスの getChildren() メソッドの動作を示します。
4// getChildren() メソッドは、引数なしで呼び出され、RecursiveRegexIterator オブジェクトを返します。
5// このメソッドは通常、RecursiveIteratorIterator の内部で再帰的に次の階層を探索するために使用されます。
6
7// 1. 基となる再帰イテレータを準備します。
8// RecursiveDirectoryIterator は、指定されたディレクトリとそのサブディレクトリを再帰的に走査します。
9// FilesystemIterator::SKIP_DOTS は、'.' と '..' の特殊なディレクトリを除外します。
10$directoryIterator = new RecursiveDirectoryIterator(
11    __DIR__, // 現在のスクリプトがあるディレクトリを対象とします。
12    FilesystemIterator::SKIP_DOTS
13);
14
15// 2. RecursiveRegexIterator を作成し、正規表現パターンを適用します。
16// このイテレータは、$directoryIterator の要素の中から、
17// ファイル名が '.php' で終わるもの (大文字小文字を区別しない) のみにマッチさせます。
18$regexIterator = new RecursiveRegexIterator(
19    $directoryIterator,
20    '/^.+\.php$/i', // '.php' で終わるファイル名にマッチする正規表現
21    RecursiveRegexIterator::GET_MATCH
22);
23
24// 3. RecursiveIteratorIterator を使用して、再帰的に要素を走査します。
25// RecursiveIteratorIterator は、getChildren() を内部的に利用してディレクトリ構造を深く探索します。
26// RecursiveIteratorIterator::SELF_FIRST は、親要素を先に処理してから子要素を処理するモードです。
27$iterator = new RecursiveIteratorIterator($regexIterator, RecursiveIteratorIterator::SELF_FIRST);
28
29echo "現在のディレクトリ以下の .php ファイルと関連ディレクトリ:\n";
30echo "---------------------------------------------------\n";
31
32// イテレータをループし、各要素とその階層情報を表示します。
33foreach ($iterator as $path => $object) {
34    // getCurrentDepth() で現在の階層レベルを取得し、インデントを調整します。
35    $indent = str_repeat("  ", $iterator->getCurrentDepth());
36
37    // RecursiveRegexIterator::hasChildren() は、現在の要素が子要素を持つかどうかを判断します。
38    // 例えば、現在の要素がディレクトリであり、その中に正規表現にマッチするファイルやサブディレクトリが
39    // 存在しうる場合に true を返します。
40    if ($iterator->hasChildren()) {
41        // getChildren() メソッドを呼び出します。
42        // このメソッドは、現在の要素の子要素に対する新しい RecursiveRegexIterator を返します。
43        // 通常、このメソッドは RecursiveIteratorIterator によって内部的に利用されるため、
44        // ユーザーコードで直接呼び出すことは稀です。
45        $childrenIterator = $iterator->getChildren();
46
47        echo $indent . "[D] " . basename($path) . " (子要素を持つ)\n";
48        // $childrenIterator は、現在のディレクトリの子要素のみを対象とした
49        // 新しい RecursiveRegexIterator インスタンスです。
50        // ここでは、その型を示すために変数に格納しています。
51    } else {
52        // 子要素を持たない場合 (通常はファイル)
53        echo $indent . "[F] " . basename($path) . "\n";
54    }
55}
56
57// 補足: RecursiveIteratorIterator を使用する場合、getChildren() を明示的に呼び出す必要はほとんどありません。
58// RecursiveIteratorIterator が再帰の処理を自動的に行い、内部で getChildren() を利用して
59// イテレータの階層構造を探索しています。このサンプルは getChildren() の戻り値の型と役割を示すものです。
60
61?>

RecursiveRegexIterator::getChildren()メソッドは、現在のイテレータ要素が持つ子要素を探索するためのRecursiveRegexIteratorオブジェクトを返します。このメソッドに引数は一切必要ありません。

このメソッドは、主にRecursiveIteratorIteratorという別のイテレータによって内部的に利用されます。RecursiveIteratorIteratorは、ディレクトリ構造のような階層データを再帰的に走査する際に、getChildren()を呼び出して次の階層へ進みます。

サンプルコードでは、まずRecursiveDirectoryIteratorで現在のディレクトリを再帰的に走査し、次にRecursiveRegexIteratorを使ってファイル名が.phpで終わるものだけを正規表現でフィルタリングしています。その後、RecursiveIteratorIteratorを使ってフィルタリングされた要素を順番に処理します。このプロセスの中で、RecursiveIteratorIteratorが自動的にgetChildren()を利用し、深い階層にある子要素（サブディレクトリやファイル）を効率的に探索しています。

そのため、getChildren()メソッドはユーザーが直接呼び出すことは稀ですが、PHPの再帰的なイテレータがどのように機能し、複雑な階層構造を効率的に走査しているかを理解する上で重要な役割を担っています。