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

Copy
1<?php
2
3/**
4 * 階層構造を持つデータ例。
5 * ディレクトリ構造やネストされたメニューなどを模倣しています。
6 */
7$treeData = [
8    'root' => [
9        'branch_A' => [
10            'leaf_A1.txt',
11            'leaf_A2.txt',
12        ],
13        'branch_B' => [
14            'leaf_B1.txt',
15        ],
16        'leaf_C.txt',
17    ],
18    'standalone_item.txt',
19];
20
21/**
22 * RecursiveTreeIterator を継承し、endChildren() メソッドをオーバーライドするカスタムイテレータです。
23 * RecursiveTreeIterator は、再帰イテレータ（例: RecursiveArrayIterator）をツリー形式で表示するためのものです。
24 */
25class CustomRecursiveTreeIterator extends RecursiveTreeIterator
26{
27    /**
28     * 子ノードの反復処理が終了したときに呼び出されるメソッドです。
29     * 親ノードの全ての子要素を処理し終えた直後に、このメソッドが実行されます。
30     * RecursiveTreeIterator のデフォルトの実装では何も行いませんが、
31     * ここをオーバーライドすることで、子ノード処理の「終了」時にカスタムな動作を定義できます。
32     *
33     * @return void
34     */
35    public function endChildren(): void
36    {
37        // 子ノードの処理が終了した親ノードのキーを出力します。
38        // $this->current() は、子ノードの処理が完了した親ノードを指します。
39        $indent = str_repeat(' ', $this->getDepth() * 4); // 現在の深さに応じてインデントを調整
40        echo $indent . '--- 子ノードの処理が終了しました: ' . $this->current()->key() . " ---\n";
41    }
42}
43
44// 階層構造データを RecursiveArrayIterator でラップし、再帰的な反復を可能にします。
45$recursiveArrayIterator = new RecursiveArrayIterator($treeData);
46
47// CustomRecursiveTreeIterator を使用してツリー構造を反復処理します。
48// これにより、endChildren() メソッドが適切なタイミングで呼び出されるようになります。
49$customTreeIterator = new CustomRecursiveTreeIterator($recursiveArrayIterator);
50
51/**
52 * RecursiveIteratorIterator を使用して、ツリー全体を深さ優先で走査します。
53 * CustomRecursiveTreeIterator の endChildren() メソッドは、
54 * この RecursiveIteratorIterator による反復処理の内部で自動的に呼び出されます。
55 *
56 * RecursiveIteratorIterator::SELF_FIRST は、親要素がその子要素より先に処理されることを意味します。
57 */
58foreach (new RecursiveIteratorIterator($customTreeIterator, RecursiveIteratorIterator::SELF_FIRST) as $key => $value) {
59    $indent = str_repeat(' ', $customTreeIterator->getDepth() * 4); // 現在の深さに応じてインデントを調整
60
61    // 現在の要素が子を持つ（ディレクトリのようなノードである）か確認します
62    if ($customTreeIterator->hasChildren()) {
63        echo $indent . 'ノード: ' . $key . "\n";
64    } else {
65        // 現在の要素が葉ノード（ファイルのようなデータ）である場合
66        echo $indent . 'アイテム: ' . $value . "\n";
67    }
68}
69
70?>

PHPのRecursiveTreeIteratorクラスが提供するendChildren()メソッドは、階層構造を持つデータをイテレータで走査する際に、ある親ノードの全ての子ノードの処理が完了した直後に呼び出される特別なフックメソッドです。このメソッドは引数を取らず、戻り値もありません（void）。通常、RecursiveTreeIteratorのデフォルト実装では何も処理を行いませんが、これを継承したカスタムクラスでオーバーライドすることで、子ノード処理の終了時に独自の動作を定義できるようになります。

提供されたサンプルコードでは、CustomRecursiveTreeIteratorクラスがendChildren()メソッドをオーバーライドし、子ノードの処理が完了した親ノードのキーを出力しています。これにより、ツリー構造を深くたどり、各階層の子要素の走査が全て終わったタイミングで、その親要素に対して何らかの事後処理を行う、といった制御フローを実現できます。RecursiveIteratorIteratorのようなイテレータと組み合わせて階層データを走査する際に、このendChildren()は自動的に適切なタイミングで呼び出され、複雑なツリー処理をより細かく制御することが可能になります。

Copy
1<?php
2
3/**
4 * RecursiveTreeIteratorを継承し、endChildren()メソッドをオーバーライドするカスタムイテレータ。
5 * このクラスは、ツリー構造の子要素の処理が終了したときに特定のメッセージを出力する機能を追加します。
6 */
7class MyRecursiveTreeIterator extends RecursiveTreeIterator
8{
9    /**
10     * 子要素の処理が終了したときに呼び出されます。
11     *
12     * RecursiveTreeIteratorのデフォルトのendChildren()メソッドは何も行いませんが、
13     * このメソッドをオーバーライドすることで、子要素の終わりにカスタムなロジックを挿入できます。
14     * この例では、子要素の終わりを示すメッセージを、ツリーの深さに応じたインデントで出力します。
15     *
16     * @return void
17     */
18    public function endChildren(): void
19    {
20        // getInnerIterator() を使用して、現在の階層の元のイテレータ（RecursiveArrayIteratorなど）を取得します。
21        // これにより、現在処理を終えた親要素の情報を参照できます。
22        // RecursiveArrayIteratorの場合、key()で親要素のキー（例えばフォルダ名）を取得できます。
23        $innerIterator = $this->getInnerIterator();
24        $parentKey = $innerIterator->key(); // 親要素のキーを取得
25
26        // 現在のツリーの深さを取得します。深さ0がルートの直下です。
27        $depth = $this->getDepth();
28
29        // 子要素の処理が完了したことを示すメッセージを出力します。
30        // メッセージのインデントは、ツリーの深さに合わせて調整し、視覚的に分かりやすくします。
31        // '└── ' の記号は、ツリー構造の終端を示すのに適しています。
32        echo str_repeat(' ', $depth * 4) . "└── [End of children for '{$parentKey}' (depth: {$depth})]\n";
33    }
34
35    /**
36     * current() メソッドは、RecursiveTreeIteratorによって整形された現在の要素の文字列を返します。
37     *
38     * 通常、このメソッドをオーバーライドする必要はありませんが、
39     * 出力される文字列の内容をより詳細にカスタマイズしたい場合に利用できます。
40     * このサンプルでは、親クラスの挙動をそのまま利用し、RecursiveTreeIteratorが提供する
41     * デフォルトの整形済み文字列を返します。
42     *
43     * @return string 整形された現在の要素の文字列
44     */
45    public function current(): string
46    {
47        return parent::current();
48    }
49}
50
51/**
52 * RecursiveTreeIterator::endChildren() メソッドの動作を示すサンプル関数。
53 *
54 * この関数は、システムエンジニアを目指す初心者が、RecursiveTreeIteratorの機能、
55 * 特に endChildren() メソッドをオーバーライドしてツリーの走査にカスタムロジックを
56 * 追加する方法を理解できるように設計されています。
57 * 階層的なデータ構造（例えばファイルシステムのようなもの）をイテレートし、
58 * 各子要素のリストが終了するタイミングで特別なメッセージを出力します。
59 */
60function demonstrateRecursiveTreeIteratorEndChildren(): void
61{
62    // 処理対象となるツリー構造のサンプルデータを定義します。
63    // 多次元配列を使用して、ファイルシステムのような階層構造を模倣しています。
64    $data = [
65        'Folder 1' => [
66            'File A.txt',
67            'File B.txt'
68        ],
69        'Folder 2' => [
70            'SubFolder 1' => [
71                'File C.txt',
72                'File D.txt'
73            ],
74            'File E.txt'
75        ],
76        'File F.txt'
77    ];
78
79    echo "--- デフォルトの RecursiveTreeIterator の出力 ---\n";
80    // まず、MyRecursiveTreeIterator を使用しない場合のデフォルトの出力を確認します。
81    // RecursiveArrayIteratorでPHPの配列を再帰的にイテレート可能にします。
82    $arrayIterator = new RecursiveArrayIterator($data);
83    // RecursiveTreeIteratorは、RecursiveIteratorを整形されたツリー構造として表示します。
84    // BYPASS_KEY | BYPASS_CURRENT フラグは、RecursiveTreeIteratorが自身のキーと値を生成し、
85    // 整形された文字列を返すようにするために重要です。
86    $defaultTreeIterator = new RecursiveTreeIterator(
87        $arrayIterator,
88        RecursiveTreeIterator::BYPASS_KEY | RecursiveTreeIterator::BYPASS_CURRENT
89    );
90
91    // デフォルトのRecursiveTreeIteratorをイテレートし、結果を出力します。
92    foreach ($defaultTreeIterator as $value) {
93        echo $value;
94    }
95    echo "\n"; // 出力の区切り
96
97    echo "--- カスタム RecursiveTreeIterator (endChildren() 付き) の出力 ---\n";
98    // 次に、endChildren() メソッドをオーバーライドしたMyRecursiveTreeIteratorを使用します。
99    $customArrayIterator = new RecursiveArrayIterator($data);
100    $customTreeIterator = new MyRecursiveTreeIterator(
101        $customArrayIterator,
102        RecursiveTreeIterator::BYPASS_KEY | RecursiveTreeIterator::BYPASS_CURRENT
103    );
104
105    // カスタムRecursiveTreeIteratorをイテレートし、結果を出力します。
106    // 各子要素のリストが終了するたびに、MyRecursiveTreeIterator::endChildren() で定義された
107    // カスタムメッセージが表示されることを確認してください。
108    foreach ($customTreeIterator as $value) {
109        echo $value;
110    }
111}
112
113// サンプル関数の実行
114demonstrateRecursiveTreeIteratorEndChildren();

PHPのRecursiveTreeIteratorクラスは、多次元配列のような階層的なデータ構造をツリー形式で出力する際に使用されるクラスです。このクラスのendChildren()メソッドは、現在処理している親要素のすべての子要素の処理が完了した直後に自動的に呼び出される特別なメソッドです。このメソッドは引数を一切取らず、戻り値もありません（void）。

通常、RecursiveTreeIteratorのデフォルトのendChildren()メソッドは何も処理を行いません。しかし、このメソッドを継承して独自にオーバーライドすることで、子要素のリストが終了するタイミングで、開発者が定義した特定のカスタム処理を実行できるようになります。

提供されたサンプルコードでは、MyRecursiveTreeIteratorというカスタムクラスを作成し、endChildren()メソッドをオーバーライドしています。これにより、各「Folder」内の「File」や「SubFolder」の処理がすべて終わった段階で、「[End of children for '親要素名']」というメッセージがツリーの深さに応じたインデントで出力されるようになります。これは、ファイルシステムを模倣した階層データを走査する際に、特定のディレクトリ内のファイルやサブディレクトリの処理が完了したことを視覚的に示すのに役立ちます。このように、endChildren()メソッドをカスタマイズすることで、ツリー構造の走査における特定の節目に独自のロジックを組み込むことが可能になります。