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

Copy
1<?php
2
3/**
4 * RecursiveIteratorIterator::getInnerIterator() メソッドの使用例。
5 *
6 * このスクリプトは、RecursiveIteratorIterator を使ってディレクトリ構造を走査し、
7 * 各要素で getInnerIterator() を呼び出して、現在のネストレベルの内部イテレータ情報を表示します。
8 * システムエンジニアを目指す初心者の方にも分かりやすいように、コメントを加えています。
9 */
10
11// --- 1. 一時的なディレクトリとファイルを作成し、再帰的なデータ構造を準備します ---
12// システムの一時ディレクトリ内に、ユニークな名前でディレクトリを作成します。
13$baseDir = sys_get_temp_dir() . DIRECTORY_SEPARATOR . 'php_get_inner_iterator_example_' . uniqid();
14mkdir($baseDir);
15mkdir($baseDir . DIRECTORY_SEPARATOR . 'subdir_a');
16file_put_contents($baseDir . DIRECTORY_SEPARATOR . 'file1.txt', 'This is file1 in the root.');
17file_put_contents($baseDir . DIRECTORY_SEPARATOR . 'subdir_a' . DIRECTORY_SEPARATOR . 'file2.txt', 'This is file2 in subdir_a.');
18mkdir($baseDir . DIRECTORY_SEPARATOR . 'subdir_a' . DIRECTORY_SEPARATOR . 'subsubdir_b');
19file_put_contents($baseDir . DIRECTORY_SEPARATOR . 'subdir_a' . DIRECTORY_SEPARATOR . 'subsubdir_b' . DIRECTORY_SEPARATOR . 'file3.txt', 'This is file3 in subsubdir_b.');
20
21echo "=== 作成された一時ディレクトリ構造 ===" . PHP_EOL;
22echo $baseDir . DIRECTORY_SEPARATOR . PHP_EOL;
23echo "  ├── file1.txt" . PHP_EOL;
24echo "  └── subdir_a" . DIRECTORY_SEPARATOR . PHP_EOL;
25echo "      ├── file2.txt" . PHP_EOL;
26echo "      └── subsubdir_b" . DIRECTORY_SEPARATOR . PHP_EOL;
27echo "          └── file3.txt" . PHP_EOL . PHP_EOL;
28
29try {
30    // --- 2. RecursiveDirectoryIterator を作成 ---
31    // 指定されたディレクトリを再帰的に走査するためのイテレータです。
32    // RecursiveDirectoryIterator::SKIP_DOTS フラグは、"." と ".." のエントリ（カレントディレクトリと親ディレクトリへの参照）をスキップします。
33    $directoryIterator = new RecursiveDirectoryIterator(
34        $baseDir,
35        RecursiveDirectoryIterator::SKIP_DOTS
36    );
37
38    // --- 3. RecursiveIteratorIterator で RecursiveDirectoryIterator をラップ ---
39    // RecursiveIteratorIterator は、RecursiveDirectoryIterator のような再帰的なイテレータを
40    // 平坦化して（一段階のリストのように）イテレートできるようにします。
41    // RecursiveIteratorIterator::LEAVES_ONLY モードは、ディレクトリ自体はスキップし、ファイル（ツリーの「葉」）のみをイテレートします。
42    $recursiveIterator = new RecursiveIteratorIterator(
43        $directoryIterator,
44        RecursiveIteratorIterator::LEAVES_ONLY
45    );
46
47    echo "=== RecursiveIteratorIterator を使った繰り返し処理 ===" . PHP_EOL;
48    $count = 0;
49
50    // --- 4. foreach ループで RecursiveIteratorIterator を回し、各要素を処理 ---
51    foreach ($recursiveIterator as $pathName => $fileInfo) {
52        $count++;
53        echo "--- 要素 #" . $count . " ---" . PHP_EOL;
54        echo "現在の要素 (フルパス): " . $fileInfo->getPathname() . PHP_EOL;
55        echo "現在の要素 (ファイル名): " . $fileInfo->getFilename() . PHP_EOL;
56
57        // --- 5. getInnerIterator() メソッドの呼び出し ---
58        // getInnerIterator() は、現在のイテレーションにおける
59        // 最も内側の RecursiveIterator (この場合は RecursiveDirectoryIterator) を取得します。
60        // LEAVES_ONLY モードの場合、これは現在のファイルが存在するディレクトリを指すイテレータを返します。
61        $innerIterator = $recursiveIterator->getInnerIterator();
62
63        echo "  - getInnerIterator() が返したイテレータのクラス: " . get_class($innerIterator) . PHP_EOL;
64        // 内部イテレータ（RecursiveDirectoryIterator）が現在指しているディレクトリのパスを表示します。
65        // これは、現在のファイルがあるディレクトリのパスに相当します。
66        echo "  - 内部イテレータの現在のディレクトリパス: " . $innerIterator->getPath() . PHP_EOL;
67        echo PHP_EOL;
68    }
69
70} finally {
71    // --- 6. クリーンアップ: 作成した一時ディレクトリとファイルを削除します ---
72    // finally ブロックを使用することで、スクリプトの実行中にエラーが発生した場合でも、
73    // このクリーンアップ処理が確実に実行されるようにします。
74    function removeDirRecursively($dir) {
75        if (!is_dir($dir)) {
76            return;
77        }
78        $objects = scandir($dir);
79        foreach ($objects as $object) {
80            if ($object === '.' || $object === '..') {
81                continue;
82            }
83            $path = $dir . DIRECTORY_SEPARATOR . $object;
84            if (is_dir($path) && !is_link($path)) {
85                // ディレクトリの場合は再帰的に削除
86                removeDirRecursively($path);
87            } else {
88                // ファイルの場合は削除
89                unlink($path);
90            }
91        }
92        // ディレクトリが空になったら削除
93        rmdir($dir);
94    }
95    removeDirRecursively($baseDir);
96
97    echo "=== 処理完了とクリーンアップ ===" . PHP_EOL;
98}

このサンプルコードは、PHPのRecursiveIteratorIteratorクラスに属するgetInnerIterator()メソッドの利用例を示しています。RecursiveIteratorIteratorは、RecursiveDirectoryIteratorのような再帰的な構造を持つイテレータを、あたかも単一のリストであるかのように順次処理できるようにするクラスです。

getInnerIterator()メソッドは引数を取らず、現在のイテレーションで最も内側にあるRecursiveIteratorオブジェクトを戻り値として返します。本サンプルコードでは、ファイルシステムを再帰的に走査するためにRecursiveDirectoryIteratorをRecursiveIteratorIteratorでラップしています。このとき、getInnerIterator()を呼び出すことで、現在処理しているファイルやディレクトリが存在する階層のRecursiveDirectoryIteratorインスタンスが取得できます。これにより、多重にネストされたイテレータのどのレベルで処理が行われているかを把握し、内部イテレータが持つパスなどの情報に直接アクセスすることが可能になります。例えば、サンプルでは取得した内部イテレータから現在のディレクトリパスを表示し、処理中の要素のコンテキストを示しています。

Copy
1<?php
2
3/**
4 * 一時ディレクトリとその内容を再帰的に削除するヘルパー関数。
5 * システムエンジニアを目指す方にも、イテレータを使ったクリーンアップの例として参考になります。
6 *
7 * @param string $dir 削除対象のディレクトリパス
8 */
9function cleanup_temp_dir(string $dir): void
10{
11    if (!is_dir($dir)) {
12        return;
13    }
14
15    // RecursiveIteratorIterator を使用して、ディレクトリ内のすべてのファイルとサブディレクトリを走査します。
16    // CHILD_FIRST は、子要素から先に処理し、その後に親ディレクトリを処理することを意味します。
17    // FilesystemIterator::SKIP_DOTS は、特殊なディレクトリ「.」と「..」をスキップします。
18    $objects = new RecursiveIteratorIterator(
19        new RecursiveDirectoryIterator($dir, FilesystemIterator::SKIP_DOTS),
20        RecursiveIteratorIterator::CHILD_FIRST
21    );
22
23    foreach ($objects as $name => $object) {
24        // オブジェクトがディレクトリであれば rmdir、ファイルであれば unlink を使用
25        if ($object->isDir()) {
26            rmdir($name);
27        } else {
28            unlink($name);
29        }
30    }
31    // すべての子要素を削除した後、最上位のディレクトリを削除
32    rmdir($dir);
33}
34
35/**
36 * RecursiveIteratorIterator::getInnerIterator() メソッドの利用方法を示す関数。
37 * 再帰的なデータ構造（ここではファイルシステム）をイテレートし、
38 * 各階層のイテレータへのアクセス方法をデモンストレーションします。
39 */
40function demonstrateRecursiveIteratorGetInnerIterator(): void
41{
42    $baseDir = 'temp_recursive_iterator_example';
43
44    // --- 1. 一時ディレクトリとファイルの準備 ---
45    echo "--- 1. 一時ディレクトリとファイルの準備 ---\n";
46    // 以前の実行が残っていた場合を考慮してクリーンアップ
47    if (is_dir($baseDir)) {
48        cleanup_temp_dir($baseDir);
49    }
50    // サンプルのディレクトリ構造を作成
51    mkdir($baseDir . '/sub_dir', 0777, true);
52    file_put_contents($baseDir . '/file1.txt', 'This is file1 in the base directory.');
53    file_put_contents($baseDir . '/sub_dir/file2.txt', 'This is file2 in a subdirectory.');
54    file_put_contents($baseDir . '/sub_dir/file3.log', 'Log entry in a subdirectory.');
55
56    echo "作成されたディレクトリ構造:\n";
57    echo "  " . $baseDir . "/\n";
58    echo "  ├── file1.txt\n";
59    echo "  └── sub_dir/\n";
60    echo "      ├── file2.txt\n";
61    echo "      └── file3.log\n\n";
62
63    echo "--- 2. RecursiveDirectoryIterator と RecursiveIteratorIterator を使用して走査 ---\n";
64    try {
65        // RecursiveDirectoryIterator を作成し、指定されたディレクトリから再帰的にファイルを読み込む基盤とします。
66        $directoryIterator = new RecursiveDirectoryIterator(
67            $baseDir,
68            FilesystemIterator::SKIP_DOTS // 「.」と「..」のエントリをスキップします
69        );
70
71        // RecursiveIteratorIterator で RecursiveDirectoryIterator をラップすることで、
72        // ネストされたディレクトリ構造全体をフラットなシーケンスとしてイテレートできるようになります。
73        // SELF_FIRST は、親ディレクトリ自身を先に、その後にその内容を処理することを意味します。
74        $recursiveIterator = new RecursiveIteratorIterator(
75            $directoryIterator,
76            RecursiveIteratorIterator::SELF_FIRST
77        );
78
79        // イテレータを使ってディレクトリを走査し、各要素の情報を表示します
80        foreach ($recursiveIterator as $path => $fileInfo) {
81            echo "--------------------------------------------------\n";
82            echo "現在の要素: " . $fileInfo->getFilename() . " (パス: " . $fileInfo->getPathname() . ")\n";
83            echo "  タイプ: " . ($fileInfo->isDir() ? "ディレクトリ" : "ファイル") . "\n";
84            echo "  現在のイテレータの深さ (getDepth()): " . $recursiveIterator->getDepth() . "\n";
85
86            // RecursiveIteratorIterator::getInnerIterator() を使用して、
87            // 現在のイテレーションで最内部のイテレータ（この場合は RecursiveDirectoryIterator）を取得します。
88            // これにより、RecursiveIteratorIterator が現在処理している階層の
89            // 元のイテレータインスタンスにアクセスできます。
90            $innerIterator = $recursiveIterator->getInnerIterator();
91
92            echo "  getInnerIterator() が返すイテレータのクラス: " . get_class($innerIterator) . "\n";
93            echo "  getInnerIterator() が返すイテレータのパス: " . $innerIterator->getPath() . "\n";
94            echo "  getInnerIterator() が返すイテレータは RecursiveIterator のインスタンス？ " .
95                 (is_a($innerIterator, RecursiveIterator::class) ? "はい" : "いいえ") . "\n";
96            echo "\n";
97        }
98        echo "--------------------------------------------------\n";
99
100    } catch (Exception $e) {
101        echo "エラーが発生しました: " . $e->getMessage() . "\n";
102    } finally {
103        // --- 3. クリーンアップ ---
104        // 使用後の一時ディレクトリとファイルを削除します
105        echo "\n--- 3. クリーンアップ ---\n";
106        cleanup_temp_dir($baseDir);
107        echo "一時ディレクトリ '" . $baseDir . "' を削除しました。\n";
108    }
109}
110
111// 関数を実行して、getInnerIterator() の動作を確認します
112demonstrateRecursiveIteratorGetInnerIterator();
113
114?>

PHPのRecursiveIteratorIterator::getInnerIterator()メソッドは、ディレクトリ構造のような再帰的なデータ構造を効率的に走査するRecursiveIteratorIteratorが、現在どの階層のデータに注目しているか、その階層を担当する元のイテレータ（「内側のイテレータ」）を取得する際に利用されます。このメソッドは引数を取らず、戻り値としてRecursiveIteratorインターフェースを実装したイテレータインスタンスを返します。これにより、現在の処理対象が属する階層に特有の情報にアクセスできるようになります。

サンプルコードでは、一時的なディレクトリとファイルで構成されたファイルシステムを作成し、RecursiveDirectoryIteratorとRecursiveIteratorIteratorを組み合わせてこの構造を再帰的に走査しています。foreachループの各イテレーションでgetInnerIterator()を呼び出すと、RecursiveIteratorIteratorが現在処理しているファイルやディレクトリが属する、その深さのRecursiveDirectoryIteratorインスタンスが得られます。例えば、これにより現在のファイルやサブディレクトリの親ディレクトリパスを正確に把握できることを示しています。この機能は、複雑な階層構造を持つデータを扱う際、特定の階層の状況に応じた柔軟な処理を行うために役立ちます。