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

Copy
1<?php
2
3/**
4 * テスト用のディレクトリとファイルを準備します。
5 * 既に存在する場合はクリーンアップしてから再作成します。
6 *
7 * @param string $basePath 作成するディレクトリのベースパス
8 */
9function setupTestDirectory(string $basePath): void
10{
11    // 既に存在する場合はクリーンアップ
12    if (is_dir($basePath)) {
13        cleanupTestDirectory($basePath);
14    }
15
16    // ディレクトリ構造の作成
17    mkdir($basePath);
18    file_put_contents($basePath . '/file1.txt', 'これはfile1です。');
19    mkdir($basePath . '/subdir_a');
20    file_put_contents($basePath . '/subdir_a/file_a1.txt', 'これはsubdir_aのfile_a1です。');
21    mkdir($basePath . '/subdir_b');
22    file_put_contents($basePath . '/subdir_b/file_b1.txt', 'これはsubdir_bのfile_b1です。');
23
24    echo "テストディレクトリ構造を生成しました: " . realpath($basePath) . "\n\n";
25}
26
27/**
28 * テスト用に作成したディレクトリとファイルを削除します。
29 *
30 * @param string $basePath 削除するディレクトリのベースパス
31 */
32function cleanupTestDirectory(string $basePath): void
33{
34    if (!is_dir($basePath)) {
35        return;
36    }
37
38    // RecursiveIteratorIterator を使用して、ディレクトリ内の全要素を削除します。
39    // CHILD_FIRST は、子要素から先に処理し、その後で親ディレクトリを削除するために使用します。
40    $iterator = new RecursiveIteratorIterator(
41        new RecursiveDirectoryIterator($basePath, FilesystemIterator::SKIP_DOTS),
42        RecursiveIteratorIterator::CHILD_FIRST
43    );
44
45    foreach ($iterator as $item) {
46        if ($item->isDir()) {
47            rmdir($item->getPathname()); // ディレクトリを削除
48        } else {
49            unlink($item->getPathname()); // ファイルを削除
50        }
51    }
52    rmdir($basePath); // 最上位のディレクトリを削除
53    echo "テストディレクトリ構造を削除しました: " . realpath($basePath) . "\n";
54}
55
56/**
57 * RecursiveDirectoryIterator の getChildren() メソッドの使用例を示します。
58 * このメソッドは、現在のディレクトリ要素の子要素に対する新しいイテレータを返します。
59 */
60function demonstrateRecursiveDirectoryIteratorGetChildren(): void
61{
62    $testDirPath = __DIR__ . '/recursive_iterator_example_dir';
63    setupTestDirectory($testDirPath);
64
65    echo "--- ディレクトリのトップレベルを走査し、サブディレクトリの子要素を表示 ---\n";
66
67    try {
68        // RecursiveDirectoryIterator をインスタンス化し、指定されたディレクトリを走査します。
69        // FilesystemIterator::SKIP_DOTS は、'.' (カレントディレクトリ) と '..' (親ディレクトリ) をスキップします。
70        $directoryIterator = new RecursiveDirectoryIterator($testDirPath, FilesystemIterator::SKIP_DOTS);
71
72        // トップレベルのファイルとディレクトリをループします。
73        foreach ($directoryIterator as $item) {
74            echo "親要素: " . $item->getFilename();
75
76            if ($item->isDir()) {
77                // 要素がディレクトリの場合
78                echo " (ディレクトリ)\n";
79                echo "  --- [" . $item->getFilename() . "] の子要素 (getChildren() を使用) ---\n";
80
81                // getChildren() メソッドは、現在のディレクトリ要素の子要素に対する
82                // 新しい RecursiveDirectoryIterator オブジェクトを返します。
83                $childrenIterator = $item->getChildren();
84
85                // 取得した子要素のイテレータをループして、その中身を表示します。
86                foreach ($childrenIterator as $childItem) {
87                    echo "    子要素: " . $childItem->getFilename();
88                    if ($childItem->isDir()) {
89                        echo " (ディレクトリ)";
90                    } else {
91                        echo " (ファイル)";
92                    }
93                    echo "\n";
94                }
95                echo "  --------------------------------------------------------\n";
96            } else {
97                // 要素がファイルの場合
98                echo " (ファイル)\n";
99            }
100        }
101    } catch (UnexpectedValueException $e) {
102        // ディレクトリが見つからないなどのエラーが発生した場合の処理
103        echo "エラーが発生しました: " . $e->getMessage() . "\n";
104    } finally {
105        // 後処理として、作成したテストディレクトリを削除します。
106        cleanupTestDirectory($testDirPath);
107    }
108}
109
110// 関数の実行
111demonstrateRecursiveDirectoryIteratorGetChildren();

PHP 8 の RecursiveDirectoryIterator クラスに属する getChildren() メソッドは、ファイルシステムを再帰的に走査する際に非常に役立ちます。このメソッドは引数を取らず、現在のイテレータが指している要素がディレクトリである場合に、そのディレクトリ内の子要素（ファイルやサブディレクトリ）を処理するための新しい RecursiveDirectoryIterator オブジェクトを返します。

RecursiveDirectoryIterator は、指定されたディレクトリ内の要素を順次提供しますが、getChildren() を使うことで、特定のサブディレクトリの内部構造をさらに詳しく探索するための専用イテレータを取得できます。これにより、トップレベルのディレクトリを走査しながら、必要に応じて任意のサブディレクトリの中身も個別にループ処理することが可能になります。

サンプルコードでは、まず recursive_iterator_example_dir のトップレベルを RecursiveDirectoryIterator で走査しています。ループ中に「subdir_a」や「subdir_b」のようなサブディレクトリが見つかった場合、$item->getChildren() を呼び出しています。この呼び出しによって、該当するサブディレクトリ内のファイルやディレクトリを列挙するための新しいイテレータが返され、その中身をさらに表示しています。このように getChildren() を利用することで、多階層のディレクトリ構造を柔軟に探索し、特定の階層の情報を取得できるため、ファイルシステムの操作において非常に便利な機能です。

Copy
1<?php
2
3/**
4 * RecursiveDirectoryIterator と getChildren() メソッドの使用例を示します。
5 *
6 * getChildren() メソッドは、RecursiveDirectoryIterator が現在の要素がディレクトリである場合に
7 * その子要素を反復処理するための新しい RecursiveDirectoryIterator を返すために使用されます。
8 * 通常、開発者は RecursiveIteratorIterator と組み合わせて使用することで、
9 * 明示的に getChildren() を呼び出すことなくディレクトリツリー全体を簡単に走査できます。
10 */
11
12/**
13 * テスト用のディレクトリ構造を作成します。
14 *
15 * @return string 作成されたテストディレクトリのパス
16 */
17function createTestDirectory(): string
18{
19    $tempDir = sys_get_temp_dir() . '/php_recursive_test_' . uniqid();
20    mkdir($tempDir);
21    mkdir($tempDir . '/dir1');
22    mkdir($tempDir . '/dir1/subdirA');
23    file_put_contents($tempDir . '/file0.txt', 'This is file0.');
24    file_put_contents($tempDir . '/dir1/file1.txt', 'This is file1.');
25    file_put_contents($tempDir . '/dir1/subdirA/file2.log', 'This is file2.');
26
27    echo "テストディレクトリを作成しました: " . $tempDir . "\n";
28    return $tempDir;
29}
30
31/**
32 * テスト用のディレクトリ構造を削除します。
33 *
34 * @param string $dir 削除するディレクトリのパス
35 */
36function cleanTestDirectory(string $dir): void
37{
38    // ディレクトリが存在しない場合は何もしない
39    if (!is_dir($dir)) {
40        return;
41    }
42
43    // RecursiveIteratorIterator を使って、ディレクトリ内の全てのファイルとディレクトリを削除
44    // このループは、RecursiveDirectoryIterator が内部的に getChildren() を使って
45    // サブディレクトリのコンテンツを取得する方法を示しています。
46    $it = new RecursiveDirectoryIterator($dir, RecursiveDirectoryIterator::SKIP_DOTS);
47    $files = new RecursiveIteratorIterator($it, RecursiveIteratorIterator::CHILD_FIRST);
48
49    foreach ($files as $file) {
50        if ($file->isDir()) {
51            rmdir($file->getRealPath()); // ディレクトリを削除
52        } else {
53            unlink($file->getRealPath()); // ファイルを削除
54        }
55    }
56    rmdir($dir); // 空になったルートディレクトリを削除
57
58    echo "テストディレクトリを削除しました: " . $dir . "\n";
59}
60
61// ------------------------------------------------------------------------------------
62// メインの処理
63// ------------------------------------------------------------------------------------
64
65// 1. テストディレクトリを作成
66$testDir = createTestDirectory();
67
68try {
69    // 2. RecursiveDirectoryIterator を作成
70    // このイテレータは、指定されたディレクトリの内容を反復処理します。
71    // フラグ (SKIP_DOTS) は、'.' と '..' エントリをスキップします。
72    $directoryIterator = new RecursiveDirectoryIterator(
73        $testDir,
74        RecursiveDirectoryIterator::SKIP_DOTS
75    );
76
77    // 3. RecursiveIteratorIterator でラップして、ディレクトリツリー全体を再帰的に走査
78    // RecursiveIteratorIterator は、内部で RecursiveDirectoryIterator::getChildren() を呼び出して、
79    // 現在の要素がディレクトリである場合にそのサブディレクトリを走査します。
80    $recursiveIterator = new RecursiveIteratorIterator(
81        $directoryIterator,
82        RecursiveIteratorIterator::SELF_FIRST // まず親ディレクトリ自身を、次にその子要素を返す
83    );
84
85    echo "\n--- ディレクトリツリーの走査結果 ---\n";
86
87    // 4. ディレクトリツリー内の各要素を反復処理し、パスを出力
88    foreach ($recursiveIterator as $item) {
89        // SplFileInfo オブジェクトからファイルまたはディレクトリのパスを取得
90        echo str_repeat('  ', $recursiveIterator->getDepth()); // 階層に応じたインデント
91        echo $item->getPathname() . "\n";
92    }
93
94    echo "------------------------------------\n";
95
96    // 5. RecursiveDirectoryIterator::getChildren() の明示的な使用例 (参考)
97    // 通常は RecursiveIteratorIterator を使用しますが、手動で子イテレータを取得することも可能です。
98    echo "\n--- getChildren() の明示的な使用例 ---\n";
99    $iterator = new RecursiveDirectoryIterator($testDir, RecursiveDirectoryIterator::SKIP_DOTS);
100    foreach ($iterator as $item) {
101        echo "親要素: " . $item->getPathname() . "\n";
102        // 現在の要素がディレクトリであれば、getChildren() で子イテレータを取得
103        if ($item->isDir()) {
104            echo "  子要素:\n";
105            $children = $item->getChildren(); // ここで getChildren() が呼び出される
106            foreach ($children as $childItem) {
107                echo "    - " . $childItem->getPathname() . "\n";
108            }
109        }
110    }
111    echo "------------------------------------\n";
112
113} catch (UnexpectedValueException $e) {
114    echo "エラー: " . $e->getMessage() . "\n";
115} finally {
116    // 6. テストディレクトリをクリーンアップ
117    cleanTestDirectory($testDir);
118}
119
120?>

PHP 8のRecursiveDirectoryIterator::getChildren()メソッドは、ディレクトリ構造を再帰的に走査する際に利用される機能です。このメソッドは引数を持たず、現在の要素がディレクトリである場合に、そのディレクトリの子要素を反復処理するための新しいRecursiveDirectoryIteratorオブジェクトを返します。これにより、多階層のディレクトリ構造を簡単に探ることができます。

通常、開発者はRecursiveIteratorIteratorクラスとRecursiveDirectoryIteratorを組み合わせて使用します。RecursiveIteratorIteratorは内部でgetChildren()メソッドを自動的に呼び出すため、明示的にこのメソッドを呼び出すことなく、ディレクトリツリー全体を効率的に走査することが可能です。

サンプルコードでは、まず一時的なディレクトリ構造を作成し、そのディレクトリツリー全体をRecursiveIteratorIteratorで走査する例を示しています。この方法では、ファイルのパスとディレクトリの階層構造を簡単に表示できます。また、参考としてgetChildren()メソッドを明示的に呼び出してサブディレクトリの内容を取得する例も示されており、このメソッドの具体的な挙動を理解するのに役立ちます。最後に、作成したテストディレクトリは適切に削除されます。