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

beginChildrenメソッドは、再帰的なイテレータが子要素を持つ場合に、その子要素群の反復処理を開始する直前に呼び出されるメソッドです。このメソッドは、RecursiveIteratorIteratorの反復処理の過程で自動的に実行されるもので、開発者が直接呼び出すことは通常ありません。主な目的は、RecursiveIteratorIteratorを継承した独自のクラスを作成し、このメソッドをオーバーライド（再定義）することによって、子要素の処理が始まる際のカスタムロジックを実装することです。例えば、ファイルシステムのディレクトリ構造を再帰的に処理してHTMLのネストしたリストを生成する際に、サブディレクトリの内容をリスト表示する<ul>タグの出力をこのメソッド内で行うといった使い方が考えられます。このメソッドは、すべての子要素の処理が完了した後に呼び出されるendChildrenメソッドと対になっており、これらを組み合わせることで、再帰的な構造の各階層の開始と終了時に特定の処理を挟み込むことが可能になります。

Copy
1<?php
2
3class MyRecursiveIterator extends RecursiveIteratorIterator
4{
5    public function beginChildren(): void
6    {
7        // This method is called when the iterator starts iterating a new child iterator.
8        // It takes no arguments and has a void return type.
9        echo "--- Begin iterating children ---" . PHP_EOL;
10    }
11}
12
13$data = new RecursiveArrayIterator([
14    'Item 1',
15    'Item 2',
16    [
17        'Sub-item A',
18        'Sub-item B',
19    ],
20    'Item 3'
21]);
22
23$iterator = new MyRecursiveIterator($data);
24
25foreach ($iterator as $key => $value) {
26    echo "$key: $value" . PHP_EOL;
27}

引数なし

引数はありません

戻り値なし

戻り値はありません