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

Copy
1<?php
2
3/**
4 * RecursiveIteratorIterator::endChildren() の使用例を示します。
5 *
6 * このメソッドは、現在のイテレータが指す要素の子のイテレーションを終了させ、
7 * 親イテレータの次の要素へと進むために使用されます。
8 * 特定のサブツリーの探索を途中で切り上げたい場合に役立ちます。
9 */
10
11// 探索する階層的なデータ構造を定義します。
12// ディレクトリとファイルのような構造を模倣しています。
13$fileSystemData = [
14    'root_dir' => [
15        'file1.txt',
16        'sub_dir_a' => [
17            'file_a1.txt',
18            'file_a2.txt',
19        ],
20        'sub_dir_b' => [ // このディレクトリを見つけたら、その中身の探索を終了します
21            'file_b1.txt',
22            'file_b2.txt',
23            'deep_sub_dir' => [
24                'file_deep.txt',
25            ],
26        ],
27        'file2.txt', // sub_dir_b の後に処理されるはずですが、endChildren() の影響でスキップされます
28    ],
29    'another_root_dir' => [
30        'file3.txt',
31    ],
32];
33
34echo "--- RecursiveIteratorIterator::endChildren() の動作デモンストレーション --- \n\n";
35
36// RecursiveArrayIterator を使って配列を再帰的に反復処理可能なイテレータにします。
37$arrayIterator = new RecursiveArrayIterator($fileSystemData);
38
39// RecursiveIteratorIterator を使って、深い階層まで反復処理できるようにします。
40// RecursiveIteratorIterator::SELF_FIRST は、親要素自体を最初に処理し、その後子要素を処理することを意味します。
41$iterator = new RecursiveIteratorIterator($arrayIterator, RecursiveIteratorIterator::SELF_FIRST);
42
43// イテレーションを開始します。
44foreach ($iterator as $key => $value) {
45    // 現在の深さに応じてインデントを調整し、階層構造を視覚化します。
46    $indent = str_repeat('  ', $iterator->getDepth());
47
48    // 現在の要素のキーと値を表示します。
49    // 値が配列の場合は「Directory」、それ以外はファイル名として表示します。
50    echo $indent . "- " . $key . ": " . (is_array($value) ? "Directory" : $value) . "\n";
51
52    // 特定の条件（ここでは 'sub_dir_b' というキーのディレクトリが見つかった場合）で
53    // endChildren() メソッドを呼び出します。
54    if (is_string($key) && $key === 'sub_dir_b' && is_array($value)) {
55        echo $indent . "  [!] 'sub_dir_b' を検出しました。endChildren() を呼び出し、このディレクトリの子要素の探索をスキップします。\n";
56        $iterator->endChildren();
57        // ここで endChildren() が呼び出されると、'sub_dir_b' の子要素（file_b1.txt, file_b2.txt, deep_sub_dir など）は
58        // 処理されずにスキップされます。
59        // さらに、'sub_dir_b' の親である 'root_dir' の残りの要素（file2.txt）もスキップされ、
60        // 'another_root_dir' へと処理が移ります。
61    }
62}
63
64echo "\n--- 処理完了 --- \n";
65echo "上記の結果から、'sub_dir_b' 以下の子要素、および 'sub_dir_b' が属する階層の残りの要素 ('file2.txt') がスキップされていることが分かります。\n";
66
67?>

RecursiveIteratorIterator::endChildren()は、階層構造を再帰的に走査する際に、現在イテレータが指している要素の子要素の探索を強制的に終了させるメソッドです。このメソッドには引数がなく、何も返しません（void）。

具体的な動作として、endChildren()が呼び出されると、現在の要素のすべての子要素はスキップされ、親イテレータが指す次の要素へと処理が移ります。さらに、親イテレータの残りの要素もスキップし、現在の階層のイテレーションを終了します。

サンプルコードでは、データ構造のsub_dir_bディレクトリを検出した際にendChildren()を呼び出しています。これにより、sub_dir_b内のファイルやサブディレクトリはもちろん、sub_dir_bと同じ階層にあるfile2.txtもスキップされます。そして、次の最上位ディレクトリであるanother_root_dirの処理へと進みます。

このメソッドは、特定の条件を満たしたサブツリーの探索を途中で切り上げ、全体の処理を効率化したい場合に非常に有用です。

Copy
1<?php
2
3/**
4 * カスタムRecursiveIteratorIteratorクラス。
5 * RecursiveIteratorIterator::endChildren() メソッドの動作と、
6 * PHPの代替構文キーワード (endswitch) の使用例を示します。
7 */
8class MyRecursiveIterator extends RecursiveIteratorIterator
9{
10    /**
11     * 子要素の処理が完了したときに呼ばれます。
12     *
13     * このメソッドをオーバーライドすることで、ある階層の全ての子要素のイテレーション終了時に、
14     * 特定のクリーンアップや集計処理などを実行できます。
15     *
16     * @return void
17     */
18    public function endChildren(): void
19    {
20        // endChildren()が呼ばれる時点での深さは、
21        // 処理を終えた子要素の親の深さを示します。
22        // 例: 深さ1の要素の子（深さ2）の処理が完了した場合、このメソッド内でのgetDepth()は1を返します。
23        $depth = $this->getDepth();
24        $indent = str_repeat("  ", $depth);
25
26        echo $indent . "--- endChildren() called for children at depth " . ($depth + 1) . " (parent at depth: " . $depth . ") ---\n";
27
28        // PHPの代替構文キーワード 'endswitch' の使用例です。
29        // endChildrenメソッド内で、現在の深さに応じた異なるアクションを実行する場面を想定しています。
30        // これはRecursiveIteratorIterator::endChildren()の直接の機能ではありませんが、
31        // メソッド内で一般的なPHPの制御構造を使用できることを示します。
32        switch ($depth):
33            case 0:
34                echo $indent . "  [Info] 最上位カテゴリの子要素の処理が完了しました。\n";
35                break;
36            case 1:
37                echo $indent . "  [Info] サブカテゴリの子要素の処理が完了しました。\n";
38                break;
39            default:
40                echo $indent . "  [Info] その他の階層の子要素の処理が完了しました。\n";
41                break;
42        endswitch;
43    }
44
45    /**
46     * 各要素を訪問したときに呼ばれます。
47     * デモンストレーションのために要素のキー、値、深さを表示します。
48     *
49     * @return mixed 現在の要素の値
50     */
51    public function current(): mixed
52    {
53        $depth = $this->getDepth();
54        $key = $this->key();
55        $value = parent::current(); // 親クラスのcurrent()で実際の値を取得
56
57        $indent = str_repeat("  ", $depth);
58        $output = $indent . "- " . $key . ": ";
59
60        if (is_array($value)) {
61            $output .= "Array (Depth: " . $depth . ")";
62        } else {
63            $output .= $value . " (Depth: " . $depth . ")";
64        }
65        echo $output . "\n";
66        
67        return $value;
68    }
69}
70
71// ネストされたデータ構造の例
72$data = [
73    'Category A' => [
74        'Item A1',
75        'Item A2',
76    ],
77    'Category B' => [
78        'SubCategory B1' => [
79            'Product B1a',
80            'Product B1b',
81        ],
82        'SubCategory B2' => [
83            'Product B2a',
84        ],
85    ],
86    'Category C' => 'Simple Item C',
87];
88
89echo "--- イテレーション開始 ---\n";
90
91// RecursiveArrayIteratorを使って配列を再帰的にイテレート可能にする
92$arrayIterator = new RecursiveArrayIterator($data);
93
94// MyRecursiveIteratorを使って、endChildren()の動作を確認
95// RecursiveIteratorIterator::SELF_FIRST モードで、親要素から先に訪問し、その後子要素を訪問します。
96$iterator = new MyRecursiveIterator($arrayIterator, RecursiveIteratorIterator::SELF_FIRST);
97
98// イテレータをループして処理を実行
99foreach ($iterator as $key => $value) {
100    // current() メソッドで出力されるため、ここでは特別な処理は不要です。
101}
102
103echo "--- イテレーション終了 ---\n";

RecursiveIteratorIteratorは、多層構造を持つデータを効率的に順番に処理するためのPHPの拡張機能です。その中でendChildren()メソッドは、引数を取らず、何も返さない（void）特別なメソッドです。このメソッドは、イテレータが「ある階層の全ての子要素の処理を完了した直後」に自動的に呼び出されます。プログラマーは、このメソッドを独自のクラスでオーバーライドすることで、特定の階層の子要素の処理が終わったタイミングで、データ集計や後処理といった独自のロジックを実行できます。

サンプルコードでは、MyRecursiveIteratorというクラスがRecursiveIteratorIteratorを継承し、endChildren()をオーバーライドしています。これにより、子要素の処理が完了した際に、現在の深さに応じたメッセージを出力する動作を確認できます。endChildren()内でgetDepth()を呼び出すと、処理を終えた子要素の親要素の深さが取得されます。また、コード中にendswitchというキーワードが見られますが、これはPHPのswitch文を記述する際の代替構文（switch ... endswitch;）の一例です。endChildren()メソッド自体の機能とは直接関係ありませんが、メソッド内でPHPの一般的な制御構造を自由に使えることを示しています。