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

Copy
1<?php
2
3/**
4 * RecursiveCachingIterator::getChildren() サンプルコード
5 *
6 * このコードは、RecursiveCachingIterator を使用して階層的なデータ構造を走査し、
7 * 現在の要素が子要素を持つかどうかを確認し、持っている場合にその子要素の
8 * イテレータ (RecursiveCachingIterator) を取得する方法を示します。
9 *
10 * RecursiveCachingIterator は、RecursiveIterator インターフェースを実装する
11 * イテレータのラッパーとして機能し、子イテレータをキャッシュします。
12 * getChildren() メソッドは、現在の要素の子要素に対する RecursiveCachingIterator を返します。
13 * 子要素がない場合は null を返します。
14 */
15
16// 階層的なサンプルデータ構造を準備します。
17$data = [
18    'ファイルA.txt' => 'コンテンツA',
19    'フォルダX' => [
20        'ファイルX1.txt' => 'コンテンツX1',
21        'サブフォルダY' => [
22            'ファイルY1.txt' => 'コンテンツY1',
23        ],
24    ],
25    'ファイルB.txt' => 'コンテンツB',
26];
27
28// 1. RecursiveArrayIterator を使用して、上記のデータからベースとなる再帰イテレータを作成します。
29$baseIterator = new RecursiveArrayIterator($data);
30
31// 2. RecursiveCachingIterator でベースイテレータをラップします。
32//    これにより、getChildren() メソッドが利用可能になります。
33$cachingIterator = new RecursiveCachingIterator($baseIterator);
34
35echo "--- RecursiveCachingIterator を使用した項目走査 ---\n\n";
36
37// RecursiveCachingIterator の現在のレベルを反復処理します。
38// getChildren() を直接呼び出すことで、RecursiveIteratorIterator を使わずに
39// 手動で子要素を探索する方法を示します。
40foreach ($cachingIterator as $key => $value) {
41    echo "現在の項目: {$key}\n";
42
43    // 現在の項目が子要素を持つかどうかを確認します。
44    if ($cachingIterator->hasChildren()) {
45        echo "  - 子要素があります: はい\n";
46
47        // getChildren() メソッドを呼び出して、現在の項目に対する子イテレータを取得します。
48        // このメソッドは RecursiveCachingIterator のインスタンス、または子要素がない場合は null を返します。
49        $childrenIterator = $cachingIterator->getChildren();
50
51        if ($childrenIterator instanceof RecursiveCachingIterator) {
52            echo "  - 子イテレータの型: RecursiveCachingIterator。子要素をリストアップ:\n";
53            // 取得した子イテレータを反復処理して、その子要素を表示します。
54            foreach ($childrenIterator as $childKey => $childValue) {
55                echo "    - 子項目: {$childKey}\n";
56                // ここでさらに $childrenIterator->hasChildren() と $childrenIterator->getChildren() を
57                // 再帰的に呼び出すことで、さらに深い階層を探索できます。
58            }
59        } else {
60            // hasChildren() が true の場合、このブロックに到達することはありませんが、
61            // 戻り値の型が RecursiveCachingIterator であることを確認する例として残しています。
62            echo "  - 予期せぬ子イテレータの型: " . get_class($childrenIterator) . "\n";
63        }
64    } else {
65        echo "  - 子要素がありません (葉ノード)\n";
66    }
67    echo "\n";
68}
69
70?>

PHPのRecursiveCachingIterator::getChildren()メソッドは、階層的なデータ構造を効率的に扱うためのイテレータ機能を提供します。RecursiveCachingIteratorは、再帰的なイテレータをラップし、子要素のイテレータをキャッシュすることで、パフォーマンスの向上と使いやすさを両立させるクラスです。

このgetChildren()メソッドは引数を取りません。現在のイテレータが指し示す要素に子要素が存在する場合、その子要素群を走査するための新しいRecursiveCachingIteratorインスタンスを返します。もし現在の要素に子要素がない、つまり「葉ノード」である場合は、nullを返します。

通常、このメソッドはまずRecursiveCachingIterator::hasChildren()メソッドで子要素の有無を確認した後に呼び出されます。hasChildren()がtrueを返した場合にgetChildren()を呼び出すことで、子要素を安全に取得し、さらにその子階層を深く探索することが可能になります。サンプルコードでは、フォルダ構造のような階層データを走査する際に、現在の項目がサブフォルダ（子要素）を持つかどうかを判断し、持っていればその中のファイルをリストアップする具体的な手順を示しています。これにより、複雑な階層データでも段階的に構造をたどることができます。

Copy
1<?php
2
3/**
4 * 階層構造を持つ配列をイテレートするためのシンプルな RecursiveIterator 実装。
5 * RecursiveCachingIterator はこの型のオブジェクトをラップして使用されます。
6 */
7class SimpleRecursiveArrayIterator extends ArrayIterator implements RecursiveIterator
8{
9    /**
10     * 現在の要素が子要素を持つかどうかを判断します。
11     *
12     * @return bool 現在の要素が配列であり、かつ空でなければtrue
13     */
14    public function hasChildren(): bool
15    {
16        return is_array($this->current()) && !empty($this->current());
17    }
18
19    /**
20     * 現在の要素の子イテレータを返します。
21     *
22     * @return RecursiveIterator 現在の要素（配列）を元にした新しいイテレータ
23     */
24    public function getChildren(): RecursiveIterator
25    {
26        // 現在の要素が配列の場合、その配列を新しい SimpleRecursiveArrayIterator として返します。
27        // これが RecursiveCachingIterator によってラップされ、子イテレータとなります。
28        return new self($this->current());
29    }
30}
31
32// 階層構造を持つサンプルデータ（ファイルシステムのような構造を模倣）
33$data = [
34    'document.txt',
35    'folder_a' => [
36        'file_a1.txt',
37        'file_a2.doc',
38        'subfolder_a1' => [
39            'file_a1-1.log',
40            'file_a1-2.cfg',
41        ],
42    ],
43    'image.jpg',
44    'folder_b' => [
45        'file_b1.pdf',
46    ],
47];
48
49// 1. 基本となる RecursiveIterator のインスタンスを作成
50$baseIterator = new SimpleRecursiveArrayIterator($data);
51
52// 2. RecursiveCachingIterator でラップ
53// RecursiveCachingIterator は内部的に子イテレータをキャッシュし、パフォーマンスを向上させます。
54$cachingIterator = new RecursiveCachingIterator($baseIterator);
55
56echo "--- ルートレベルの要素と、その子要素の確認 ---\n";
57
58// ルートレベルをイテレートし、各要素の子要素の有無と内容を確認します。
59foreach ($cachingIterator as $key => $value) {
60    echo "現在の要素: '{$key}'";
61
62    // RecursiveCachingIterator::hasChildren() で子要素の有無をチェックします。
63    if ($cachingIterator->hasChildren()) {
64        echo " は子要素を持ちます。\n";
65
66        // RecursiveCachingIterator::getChildren() で子要素のイテレータを取得します。
67        // 戻り値は RecursiveCachingIterator のインスタンス、または子が存在しない場合は null です。
68        $children = $cachingIterator->getChildren();
69
70        if ($children !== null) {
71            echo "  子要素一覧:\n";
72            // 取得した子イテレータをループして、子要素を表示します。
73            foreach ($children as $childKey => $childValue) {
74                // 子がさらにフォルダ（配列）の場合も考慮して表示します。
75                $childType = is_array($childValue) ? '[フォルダ]' : '[ファイル]';
76                echo "    - '{$childKey}': {$childType}\n";
77            }
78        }
79    } else {
80        echo " は子要素を持ちません。\n";
81    }
82}
83
84echo "\n--- 特定の深さにある子要素の確認 (例: 'subfolder_a1'の中身) ---\n";
85
86// イテレータをリセットして、特定のパス（'folder_a' -> 'subfolder_a1'）を辿ります。
87$cachingIterator->rewind();
88
89// まず 'folder_a' を見つけます。
90while ($cachingIterator->valid() && $cachingIterator->key() !== 'folder_a') {
91    $cachingIterator->next();
92}
93
94if ($cachingIterator->valid() && $cachingIterator->key() === 'folder_a') {
95    echo "現在のパス: /{$cachingIterator->key()}\n";
96    // 'folder_a' の子イテレータを取得します。
97    $folderAChildren = $cachingIterator->getChildren();
98
99    if ($folderAChildren !== null) {
100        // 'subfolder_a1' を見つけます（'folder_a' の子イテレータの中から）。
101        $folderAChildren->rewind(); // 子イテレータをリセット
102        while ($folderAChildren->valid() && $folderAChildren->key() !== 'subfolder_a1') {
103            $folderAChildren->next();
104        }
105
106        if ($folderAChildren->valid() && $folderAChildren->key() === 'subfolder_a1') {
107            echo "現在のパス: /{$cachingIterator->key()}/{$folderAChildren->key()}\n";
108            // 'subfolder_a1' の子イテレータを取得します。
109            $subfolderA1Children = $folderAChildren->getChildren();
110
111            if ($subfolderA1Children !== null) {
112                echo "  'subfolder_a1' の子要素一覧:\n";
113                // 'subfolder_a1' の子要素を表示します。
114                foreach ($subfolderA1Children as $childKey => $childValue) {
115                    echo "    - '{$childKey}': {$childValue}\n";
116                }
117            } else {
118                echo "  'subfolder_a1' は子要素を持ちません。\n";
119            }
120        } else {
121            echo "  'subfolder_a1' が 'folder_a' の中に見つかりませんでした。\n";
122        }
123    }
124} else {
125    echo "'folder_a' がルートレベルに見つかりませんでした。\n";
126}

RecursiveCachingIterator::getChildren()メソッドは、階層構造を持つデータを効率的に扱う際に使用されます。このメソッドは、現在イテレータが指している要素が子要素（例えば、フォルダの中身やネストされた配列）を持つ場合に、その子要素を反復処理するための新しいイテレータを返します。引数はなく、子要素が存在すればRecursiveCachingIteratorのインスタンスを、子要素がない場合はnullを戻り値として返します。

サンプルコードでは、ファイルシステムのような階層的な配列データをRecursiveCachingIteratorでラップし、getChildren()を活用してその階層を深く辿る様子を示しています。まず、ルートレベルの各要素をループし、hasChildren()で子要素の有無を確認した後、getChildren()を使って子イテレータを取得しています。これにより、例えばフォルダの中身を一覧表示する処理を実現しています。また、特定のパス（例：folder_a内のsubfolder_a1）までイテレータを進め、再度getChildren()を呼び出すことで、その深さにある子要素も正確に取得・表示しています。RecursiveCachingIteratorは子イテレータをキャッシュする仕組みを持つため、繰り返し子要素にアクセスする場合のパフォーマンス向上にも寄与します。