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

Copy
1<?php
2
3// このサンプルコードは、PHPの ParentIterator クラスの getChildren() メソッドの利用方法を示します。
4// ParentIterator は、RecursiveIterator (例えば RecursiveDirectoryIterator) をラップし、
5// 子要素を持つ「親」の要素のみをイテレートするために使用されます。
6// getChildren() メソッドは、現在イテレート中の親要素の「直接の子要素」を取得する際に役立ちます。
7
8// -----------------------------------------------------------
9// 1. サンプルデータとして、一時的なディレクトリ構造を準備します
10// -----------------------------------------------------------
11$tempDir = sys_get_temp_dir() . DIRECTORY_SEPARATOR . 'parent_iterator_example_' . uniqid();
12// 一時ディレクトリとそのサブディレクトリ、ファイルを作成します
13mkdir($tempDir);
14mkdir($tempDir . DIRECTORY_SEPARATOR . 'subdir_a');
15file_put_contents($tempDir . DIRECTORY_SEPARATOR . 'subdir_a' . DIRECTORY_SEPARATOR . 'file_x.txt', 'Content X');
16mkdir($tempDir . DIRECTORY_SEPARATOR . 'subdir_b');
17file_put_contents($tempDir . DIRECTORY_SEPARATOR . 'subdir_b' . DIRECTORY_SEPARATOR . 'file_y.txt', 'Content Y');
18file_put_contents($tempDir . DIRECTORY_SEPARATOR . 'root_level_file.txt', 'Root Content'); // このファイルは子を持たないため、ParentIteratorは直接イテレートしません
19
20echo "--- サンプルとして作成されたディレクトリ構造 ---\n";
21echo "{$tempDir}\n";
22echo "├── subdir_a/\n";
23echo "│   └── file_x.txt\n";
24echo "├── subdir_b/\n";
25echo "│   └── file_y.txt\n";
26echo "└── root_level_file.txt\n";
27echo "-----------------------------------------------\n\n";
28
29try {
30    // -----------------------------------------------------------
31    // 2. ParentIterator を使用してディレクトリを走査し、getChildren() を呼び出します
32    // -----------------------------------------------------------
33
34    // RecursiveDirectoryIterator を作成し、指定されたディレクトリを再帰的に走査します。
35    // RecursiveDirectoryIterator::SKIP_DOTS フラグで '.' と '..' ディレクトリを無視します。
36    $recursiveDirectoryIterator = new RecursiveDirectoryIterator($tempDir, RecursiveDirectoryIterator::SKIP_DOTS);
37
38    // ParentIterator は RecursiveIterator を受け取ります (RecursiveDirectoryIterator は RecursiveIterator を実装しています)。
39    // ParentIterator は、ラップされたイテレータが返す要素のうち、
40    // 子要素を持つ「ディレクトリ」のみを「親要素」としてイテレートします。
41    // (ファイルのように子要素を持たないものは ParentIterator によってスキップされます。)
42    $parentIterator = new ParentIterator($recursiveDirectoryIterator);
43
44    echo "--- ParentIterator による親要素（子を持つディレクトリ）の走査とgetChildren()の利用 ---\n";
45    foreach ($parentIterator as $parentPath => $fileInfo) {
46        // ParentIterator が返す $fileInfo は、子要素を持つディレクトリの SplFileInfo オブジェクトです。
47        echo "親ディレクトリ: " . $fileInfo->getFilename() . " (パス: " . $fileInfo->getPathname() . ")\n";
48
49        // ParentIterator::hasChildren() メソッドで、現在の親要素に子があるか確認します。
50        // ParentIterator は通常、子を持つ要素のみを返すため、この条件はほぼ常に true になります。
51        if ($parentIterator->hasChildren()) {
52            echo "  この親ディレクトリは子要素を持っています。\n";
53
54            // ParentIterator::getChildren() メソッドは、
55            // 現在の親ディレクトリの「直接の子要素」をイテレートする RecursiveIterator を返します。
56            // 戻り値の型は ?RecursiveIterator なので、null の可能性もありますが、
57            // hasChildren() が true の場合は通常 null ではありません。
58            $childrenIterator = $parentIterator->getChildren();
59
60            // 返された $childrenIterator を使って、子要素をループで表示します。
61            foreach ($childrenIterator as $childPath => $childFileInfo) {
62                // 子要素がファイルの場合のみその名前を表示します（この例では、ディレクトリの子であるファイルを表示することを意図しています）。
63                if ($childFileInfo->isFile()) {
64                    echo "    子ファイル: " . $childFileInfo->getFilename() . "\n";
65                }
66            }
67        }
68    }
69    echo "----------------------------------------------------------------------------\n\n";
70
71} finally {
72    // -----------------------------------------------------------
73    // 3. テスト用のディレクトリとファイルをクリーンアップします
74    // -----------------------------------------------------------
75    // 一時ディレクトリを再帰的に削除するヘルパー関数
76    function deleteDir($dir) {
77        if (!file_exists($dir)) return; // ディレクトリが存在しない場合は何もしない
78        // RecursiveDirectoryIterator でディレクトリ内のすべてのファイルとサブディレクトリを取得
79        $it = new RecursiveDirectoryIterator($dir, RecursiveDirectoryIterator::SKIP_DOTS);
80        // RecursiveIteratorIterator で再帰的にイテレートし、子要素から先に処理
81        $files = new RecursiveIteratorIterator($it, RecursiveIteratorIterator::CHILD_FIRST);
82        foreach ($files as $file) {
83            if ($file->isDir()) {
84                rmdir($file->getRealPath()); // ディレクトリを削除
85            } else {
86                unlink($file->getRealPath()); // ファイルを削除
87            }
88        }
89        rmdir($dir); // 親ディレクトリを削除
90    }
91    deleteDir($tempDir);
92    echo "一時ディレクトリ '{$tempDir}' をクリーンアップしました。\n";
93}

PHPのParentIterator::getChildren()メソッドは、ディレクトリ構造のように、中にさらに要素が含まれるようなデータを扱う際に便利なメソッドです。まず、ParentIterator自体は、RecursiveIterator（例えばRecursiveDirectoryIterator）を元に、子要素を持つ「親」の要素、具体的にはファイルやサブディレクトリを持つディレクトリだけを効率的に見つけ出して走査するために使用されます。

getChildren()メソッドは、現在ParentIteratorが指し示している親要素（見つかったディレクトリ）の「直接の子要素」だけを順番に処理するための新しいイテレータを返します。このメソッドは引数を取りません。戻り値の型は?RecursiveIteratorで、子要素を一つずつ処理するためのイテレータを返します。ParentIteratorは子を持つ親要素のみを扱うため、通常は有効なイテレータが返されます。これにより、現在処理中の親要素に属する子要素のみに注目して、その内容を簡単に調べることができます。サンプルコードでは、ディレクトリから親ディレクトリとその直下にある子ファイルを効果的に取得し、表示する例が示されています。

Copy
1<?php
2
3// ディレクトリ構造を準備するヘルパー関数
4// サンプルコードが単体で動作するために、一時的なディレクトリとファイルを作成します。
5function prepareDirectoryForParentIteratorExample(string $baseDir): void
6{
7    // 既存のディレクトリがあれば、再実行時に備えて一度削除します。
8    if (is_dir($baseDir)) {
9        $it = new RecursiveDirectoryIterator($baseDir, RecursiveDirectoryIterator::SKIP_DOTS);
10        $files = new RecursiveIteratorIterator($it, RecursiveIteratorIterator::CHILD_FIRST);
11        foreach ($files as $file) {
12            if ($file->isDir()) {
13                @rmdir($file->getPathname()); // @でエラーを抑制
14            } else {
15                @unlink($file->getPathname()); // @でエラーを抑制
16            }
17        }
18        @rmdir($baseDir); // @でエラーを抑制
19    }
20
21    // テスト用のディレクトリとファイルを作成します。
22    mkdir($baseDir, 0777, true);
23    mkdir($baseDir . '/docs', 0777);
24    file_put_contents($baseDir . '/docs/intro.txt', 'イントロダクション');
25    file_put_contents($baseDir . '/docs/guide.md', 'ガイド');
26    mkdir($baseDir . '/src', 0777);
27    file_put_contents($baseDir . '/src/main.php', 'メインスクリプト');
28    mkdir($baseDir . '/src/lib', 0777);
29    file_put_contents($baseDir . '/src/lib/helper.php', 'ヘルパー関数');
30    file_put_contents($baseDir . '/README.md', 'プロジェクトの概要');
31}
32
33// ディレクトリ構造をクリーンアップするヘルパー関数
34// サンプルコードの実行後に作成したディレクトリとファイルを削除します。
35function cleanupDirectoryForParentIteratorExample(string $baseDir): void
36{
37    if (!is_dir($baseDir)) {
38        return;
39    }
40    $it = new RecursiveDirectoryIterator($baseDir, RecursiveDirectoryIterator::SKIP_DOTS);
41    $files = new RecursiveIteratorIterator($it, RecursiveIteratorIterator::CHILD_FIRST);
42    foreach ($files as $file) {
43        if ($file->isDir()) {
44            @rmdir($file->getPathname()); // @でエラーを抑制
45        } else {
46            @unlink($file->getPathname()); // @でエラーを抑制
47        }
48    }
49    @rmdir($baseDir); // @でエラーを抑制
50}
51
52
53// --- ParentIterator::getChildren() の使用例 ---
54
55// 一時的なディレクトリを現在のスクリプトと同じ場所に設定します。
56$testDir = __DIR__ . '/example_parent_iterator';
57
58// サンプルコード実行前に一時ディレクトリ構造を準備します。
59prepareDirectoryForParentIteratorExample($testDir);
60
61try {
62    echo "ParentIterator::getChildren() の使用例:\n\n";
63
64    // 1. RecursiveDirectoryIterator を使用して、指定されたディレクトリを走査します。
65    //    RecursiveDirectoryIterator::SKIP_DOTS フラグは、特殊なディレクトリである '.' と '..' を無視します。
66    $directoryIterator = new RecursiveDirectoryIterator(
67        $testDir,
68        RecursiveDirectoryIterator::SKIP_DOTS
69    );
70
71    // 2. ParentIterator で RecursiveDirectoryIterator をラップします。
72    //    ParentIterator は、基となる RecursiveIterator の「親」要素をイテレートします。
73    //    そして、各親要素の子要素を取得するための getChildren() メソッドを提供します。
74    $parentIterator = new ParentIterator($directoryIterator);
75
76    // 3. ParentIterator をループします。
77    //    各 $item は、現在の「親」要素（SplFileInfo オブジェクト）です。
78    //    これはディレクトリの場合もあれば、ファイルの場合もあります。
79    foreach ($parentIterator as $item) {
80        // 親要素がディレクトリである場合のみ、その子要素を表示します。
81        // ファイルは子要素を持たないため、この条件でフィルタリングします。
82        if ($item->isDir()) {
83            echo "親ディレクトリ: " . $item->getFilename() . " (パス: " . $item->getPathname() . ")\n";
84
85            // 4. getChildren() メソッドを呼び出し、現在の親要素の子要素を RecursiveIterator として取得します。
86            //    子要素がない場合（例：空のディレクトリ）、null を返します。
87            $children = $parentIterator->getChildren();
88
89            // 5. 子要素が存在し、かつ実際に子がある場合、それらをループして表示します。
90            if ($children !== null && $children->hasChildren()) {
91                echo "  子要素:\n";
92                foreach ($children as $child) {
93                    echo "    - " . $child->getFilename() . " (" . ($child->isDir() ? 'ディレクトリ' : 'ファイル') . ")\n";
94                }
95            } else {
96                echo "  子要素はありません。\n";
97            }
98            echo "\n";
99        } elseif ($item->isFile()) {
100            // ディレクトリ構造のルート直下にあるファイルの場合
101            echo "ファイル: " . $item->getFilename() . " (パス: " . $item->getPathname() . ")\n";
102            echo "  このファイルは子要素を持ちません。\n\n";
103        }
104    }
105
106} catch (Exception $e) {
107    // 例外が発生した場合、エラーメッセージを表示します。
108    echo "エラーが発生しました: " . $e->getMessage() . "\n";
109} finally {
110    // 処理の終了後、作成した一時ディレクトリをクリーンアップします。
111    cleanupDirectoryForParentIteratorExample($testDir);
112    echo "クリーンアップが完了しました。\n";
113}
114
115?>

PHP 8のParentIterator::getChildren()メソッドは、ParentIteratorクラスに属し、現在イテレートしている「親」要素が持つ子要素をイテレータとして取得するために使用されます。このメソッドは引数を取りません。

ParentIteratorは、RecursiveDirectoryIteratorなどのRecursiveIteratorをラップして使用し、ファイルシステムのような階層構造を効率的に走査するのに役立ちます。ParentIterator自体をループすると、各反復で親となるディレクトリやファイルが得られます。その際、getChildren()メソッドを呼び出すことで、現在の親要素が持つ直接の子要素（ファイルやサブディレクトリ）をさらに詳細に取得することができます。

getChildren()は、子要素が存在する場合にRecursiveIteratorインターフェースを実装したオブジェクトを返します。これにより、取得した子要素をさらにループして個別に処理することが可能です。もし子要素が存在しない場合、例えば親要素が空のディレクトリであるか、あるいは親要素がファイルである場合は、nullが返されます。

サンプルコードでは、ディレクトリを走査するParentIteratorを使用し、各ディレクトリに対してgetChildren()を呼び出すことで、そのディレクトリに含まれるファイルやサブディレクトリの一覧を取得・表示しています。このメソッドを利用することで、親子の関係を容易に辿りながら、階層的なデータ構造を効果的に処理できるようになります。