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

Copy
1<?php
2
3// このサンプルコードは、PHPのRecursiveTreeIteratorクラスとそのgetInnerIterator()メソッドの使い方を示します。
4// RecursiveTreeIteratorは、階層的なデータ（ツリー構造）をイテレート（順に処理）するための特別なイテレータです。
5// getInnerIterator()メソッドは、RecursiveTreeIteratorが内部でラップしている元のイテレータ（RecursiveIterator）を返します。
6
7// 1. ツリー構造を表す多次元配列を作成します。
8//    これは、ファイルシステムのような階層的なデータを模倣しています。
9$treeData = [
10    'Folder A' => [
11        'File A1.txt',
12        'SubFolder A1' => [
13            'File A1-1.log',
14            'File A1-2.csv',
15        ],
16        'File A2.txt',
17    ],
18    'Folder B' => [
19        'File B1.txt',
20        'File B2.jpg',
21    ],
22    'Standalone File.txt',
23];
24
25// 2. RecursiveArrayIterator を使用して、この配列を再帰的に走査できるイテレータにします。
26//    RecursiveArrayIteratorは、多次元配列をイテレータとして扱うための標準的なクラスです。
27$recursiveArrayIterator = new RecursiveArrayIterator($treeData);
28
29// 3. RecursiveTreeIterator を使用して、RecursiveArrayIterator をツリー構造として扱えるようにラップします。
30//    これにより、階層的なデータをツリーのように表示したり走査したりできます。
31//    RecursiveTreeIterator::BYPASS_CURRENT は、現在のノードがイテレータ自体である場合に、そのノード自身の表示を省略するフラグです。
32$recursiveTreeIterator = new RecursiveTreeIterator(
33    $recursiveArrayIterator,
34    RecursiveTreeIterator::BYPASS_CURRENT
35);
36
37// 4. RecursiveTreeIterator::getInnerIterator() メソッドを呼び出します。
38//    このメソッドは、RecursiveTreeIterator が内部でラップしている元の RecursiveIterator 
39//    （この場合は RecursiveArrayIterator のインスタンス）を返します。
40$innerIterator = $recursiveTreeIterator->getInnerIterator();
41
42echo "--- RecursiveTreeIterator::getInnerIterator() の使用例 ---" . PHP_EOL;
43
44// getInnerIterator() が返したオブジェクトのクラス名を表示します。
45echo "getInnerIterator() が返したオブジェクトのクラス名: " . get_class($innerIterator) . PHP_EOL;
46
47// getInnerIterator() が返したオブジェクトが、元の RecursiveArrayIterator と同じインスタンスであるかを確認します。
48// (=== 演算子でオブジェクトの同一性、つまり同じメモリ上のオブジェクトであるかをチェックします)
49echo "getInnerIterator() が元の RecursiveArrayIterator と同じインスタンスか: " . ($innerIterator === $recursiveArrayIterator ? 'はい' : 'いいえ') . PHP_EOL;
50
51echo PHP_EOL;
52
53// 参考: RecursiveTreeIterator を使用してツリー構造を走査し、表示する例
54//      この部分は getInnerIterator() の機能とは直接関係ありませんが、
55//      RecursiveTreeIterator がどのように階層データを扱うかを示します。
56echo "--- RecursiveTreeIterator でツリー構造を走査する例 ---" . PHP_EOL;
57foreach ($recursiveTreeIterator as $key => $value) {
58    // getDepth() は現在の要素の深さを返します。それに応じてインデントを付けます。
59    echo str_repeat('  ', $recursiveTreeIterator->getDepth()) . $value . PHP_EOL;
60}
61
62?>

このサンプルコードは、PHPのRecursiveTreeIteratorクラスと、そのgetInnerIterator()メソッドの働きを説明します。RecursiveTreeIteratorは、ファイルシステムのような階層的なデータ（ツリー構造）を順に処理し、整形して表示するための特別なイテレータです。

まず、多次元配列でツリー構造のデータを用意し、これをRecursiveArrayIteratorクラスで再帰的に走査できるイテレータに変換します。次に、このRecursiveArrayIteratorをRecursiveTreeIteratorでラップすることで、階層的なデータをツリーのように扱えるようにします。

RecursiveTreeIterator::getInnerIterator()メソッドは、引数なしで呼び出され、RecursiveTreeIteratorが内部でラップしている元のイテレータ（この場合はRecursiveArrayIteratorのインスタンス）をRecursiveIterator型として返します。サンプルコードでは、このメソッドが返したオブジェクトのクラス名を表示し、それが元のRecursiveArrayIteratorと全く同じインスタンスであるかを検証しています。これにより、RecursiveTreeIteratorはツリー構造の表示や走査方法を制御しつつ、その内部に保持している元のデータイテレータへ直接アクセスできることがわかります。このメソッドは、ツリーの表現方法とデータ自体のロジックを分離しながらも、必要に応じて元のデータに触れたい場合に利用されます。

Copy
1<?php
2
3/**
4 * RecursiveTreeIterator と getInnerIterator の使用例、
5 * および PHP のイテレータとジェネレータの概念を示します。
6 *
7 * RecursiveTreeIterator は、ツリー構造のデータを視覚的に理解しやすい形式で
8 * 繰り返し処理（イテレーション）するためのPHP組み込みのイテレータです。
9 * getInnerIterator() メソッドは、現在のイテレーションの深さで
10 * 実際に処理されている元の RecursiveIterator インスタンスを取得するために使用されます。
11 */
12function demonstrateIteratorsAndGenerators(): void
13{
14    // ------------------------------------------------------------------------
15    // 1. ツリー構造のサンプルデータを用意
16    //    ファイルシステムのような階層的なデータを連想配列で表現します。
17    // ------------------------------------------------------------------------
18    $data = [
19        'documents' => [ // ディレクトリ 'documents'
20            'report.docx',
21            'presentations' => [ // ディレクトリ 'presentations'
22                'intro.pptx',
23                'summary.pptx',
24            ],
25            'notes.txt',
26        ],
27        'images' => [ // ディレクトリ 'images'
28            'photo1.jpg',
29            'thumbnails' => [ // ディレクトリ 'thumbnails'
30                'thumb1.jpg',
31            ],
32        ],
33        'README.md', // ファイル
34    ];
35
36    // ------------------------------------------------------------------------
37    // 2. RecursiveArrayIterator で配列を RecursiveIterator に変換
38    //    RecursiveArrayIterator は、通常のPHP配列を再帰的に処理可能な
39    //    RecursiveIterator インターフェースを実装したオブジェクトに変換します。
40    // ------------------------------------------------------------------------
41    $recursiveArrayIterator = new RecursiveArrayIterator($data);
42
43    // ------------------------------------------------------------------------
44    // 3. RecursiveTreeIterator を使用してツリー構造を整形して表示
45    //    このイテレータは、内部の RecursiveIterator からデータを取得し、
46    //    ツリーの階層に応じたインデントや接続線を追加して出力します。
47    // ------------------------------------------------------------------------
48    $treeIterator = new RecursiveTreeIterator(
49        $recursiveArrayIterator,
50        RecursiveTreeIterator::BYPASS_CURRENT_KEY, // PHP 8.0以降推奨: キーをスキップし、値のみを表示
51        RecursiveTreeIterator::BYPASS_CURRENT_ROW, // ツリー表示の行情報を調整
52        RecursiveTreeIterator::SELF_FIRST          // 親要素から子要素へ順に処理（深さ優先）
53    );
54
55    echo "--- RecursiveTreeIterator によるツリー構造の表示 ---\n";
56    foreach ($treeIterator as $value) {
57        // getPrefix() は現在の要素のインデントや接続線（例: `|-- `）を返します。
58        echo $treeIterator->getPrefix() . $value . "\n";
59    }
60
61    echo "\n--- getInnerIterator() の使用例 ---\n";
62    // getInnerIterator() メソッドは、現在の RecursiveTreeIterator の深さで
63    // 処理されている元の RecursiveIterator インスタンスを返します。
64    // 例えば、ツリーのルートレベル（深さ0）であれば、
65    // コンストラクタに渡した $recursiveArrayIterator と同じものが返されます。
66
67    $treeIterator->rewind(); // イテレータを最初の位置に戻します。
68                             // これにより、深さ0（ルート）のイテレータを取得できます。
69
70    $innerIteratorAtRoot = $treeIterator->getInnerIterator();
71
72    if ($innerIteratorAtRoot instanceof RecursiveIterator) {
73        echo "getInnerIterator() は RecursiveIterator インスタンスを返しました。\n";
74        echo "返されたイテレータのクラス名: " . get_class($innerIteratorAtRoot) . "\n";
75        echo "この内部イテレータから直接アクセスできるルート要素:\n";
76        // 取得した内部イテレータをループして、ルートレベルの要素を確認します。
77        foreach ($innerIteratorAtRoot as $key => $val) {
78            $type = is_array($val) ? "(ディレクトリ)" : "(ファイル)";
79            echo "  - " . $key . " " . $type . "\n";
80        }
81    } else {
82        echo "getInnerIterator() は期待する RecursiveIterator のインスタンスを返しませんでした。\n";
83    }
84
85    // ------------------------------------------------------------------------
86    // 4. PHP ジェネレータの簡単な例
87    //    ジェネレータは、PHPでイテレータ（Iteratorインターフェース）を
88    //    簡潔に実装するための特別な関数です。
89    //    `yield` キーワードを使って、必要に応じて値を一つずつ生成し、
90    //    特に大きなデータセットを扱う場合にメモリ効率の良い処理を可能にします。
91    //    RecursiveIterator とは異なり直接的な再帰機能は持ちませんが、
92    //    「イテレータ」という大きなカテゴリの一部であり、非常に有用な機能です。
93    // ------------------------------------------------------------------------
94    echo "\n--- ジェネレータの例 ---\n";
95
96    // ジェネレータ関数を定義
97    function numberSequenceGenerator(int $start, int $end): Generator
98    {
99        for ($i = $start; $i <= $end; $i++) {
100            yield "数値: " . $i; // 各イテレーションで値を生成
101        }
102    }
103
104    // ジェネレータを使用して値を反復処理
105    foreach (numberSequenceGenerator(1, 3) as $item) {
106        echo $item . "\n";
107    }
108}
109
110// サンプルコードを実行
111demonstrateIteratorsAndGenerators();

このサンプルコードは、PHPにおけるイテレータ、特にRecursiveTreeIteratorとgetInnerIteratorメソッド、そしてジェネレータの概念を初心者向けに解説しています。

RecursiveTreeIteratorは、配列などの階層的なデータをツリー構造として整形し、繰り返し処理を行うためのPHP組み込みのイテレータです。これにより、複雑なデータ構造も視覚的に分かりやすく反復処理できます。サンプルコードでは、ファイルシステムのような階層を持つ連想配列をRecursiveArrayIteratorで準備し、それをRecursiveTreeIteratorで整形して表示しています。

getInnerIteratorメソッドは、RecursiveTreeIteratorクラスに所属し、引数なしで現在のイテレーションの深さで実際に処理されている元のRecursiveIteratorインスタンスを返します。この機能を使うことで、ツリー構造の特定の階層にあるイテレータに直接アクセスし、その時点の要素を操作したり確認したりすることが可能になります。例えば、ルートレベルでこのメソッドを呼び出すと、RecursiveTreeIteratorの構築時に渡した元のRecursiveArrayIteratorインスタンスが返されます。

また、PHPのジェネレータは、yieldキーワードを使ってイテレータを簡単に実装するための特別な関数です。これは、特に大きなデータセットを扱う際に、必要に応じて値を一つずつ生成することでメモリ効率の良い処理を実現します。このコードは、これらの機能がPHPで階層的なデータを効率的に扱い、反復処理を行うための強力なツールであることを示しています。