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

Copy
1<?php
2
3// このサンプルコードは、PHPのRecursiveRegexIterator::getInnerIterator() メソッドの動作を示します。
4// RecursiveRegexIterator は、別の RecursiveIterator をラップし、正規表現で項目をフィルタリングします。
5// getInnerIterator() メソッドは、フィルタリングの「内側」にある、ラップされている元の RecursiveIterator を取得するために使用されます。
6
7// このコードを単体で動作させるため、一時的なディレクトリとファイルをセットアップします。
8// 実際のアプリケーションでは、既存のディレクトリ構造を使用することが一般的です。
9$tempDir = sys_get_temp_dir() . DIRECTORY_SEPARATOR . 'recursive_test_' . uniqid();
10mkdir($tempDir); // メインディレクトリを作成
11mkdir($tempDir . DIRECTORY_SEPARATOR . 'sub_dir'); // サブディレクトリを作成
12
13// テスト用のファイルを作成
14file_put_contents($tempDir . DIRECTORY_SEPARATOR . 'file1.txt', 'This is file1.txt');
15file_put_contents($tempDir . DIRECTORY_SEPARATOR . 'another_file.php', '<?php echo "Hello PHP!";');
16file_put_contents($tempDir . DIRECTORY_SEPARATOR . 'sub_dir' . DIRECTORY_SEPARATOR . 'file2.txt', 'This is file2.txt in sub_dir.');
17file_put_contents($tempDir . DIRECTORY_SEPARATOR . 'sub_dir' . DIRECTORY_SEPARATOR . 'image.jpg', 'Binary image data.');
18
19echo "--- サンプル開始 ---\n";
20echo "検索対象ディレクトリ: " . $tempDir . "\n";
21echo "正規表現フィルタ: /.*\\.txt$/ (拡張子が.txtのファイルのみを抽出)\n\n";
22
23try {
24    // 1. ディレクトリを再帰的に走査するための基本イテレータを作成します。
25    // RecursiveDirectoryIterator は、指定されたディレクトリとそのサブディレクトリ内の各項目（ファイル、ディレクトリ）をイテレートします。
26    // RecursiveDirectoryIterator::SKIP_DOTS フラグは、'.' (現在のディレクトリ) と '..' (親ディレクトリ) のエントリをスキップします。
27    $directoryIterator = new RecursiveDirectoryIterator(
28        $tempDir,
29        RecursiveDirectoryIterator::SKIP_DOTS
30    );
31
32    // 2. RecursiveRegexIterator を使用して、上記の $directoryIterator をフィルタリングします。
33    // このイテレータは、指定された正規表現にファイル名がマッチする項目のみを通過させます。
34    // この例では、ファイル名が '.txt' で終わるファイルのみを対象とします。
35    $regexIterator = new RecursiveRegexIterator(
36        $directoryIterator,
37        '/.*\.txt$/', // 正規表現パターン: 任意の文字が0回以上続き、.txtで終わるファイル名にマッチ
38        RecursiveRegexIterator::GET_MATCH // マッチした項目を返すモード
39    );
40
41    // 3. RecursiveIteratorIterator を使用して、再帰的な構造（ディレクトリツリー）を平坦化して走査します。
42    // これにより、サブディレクトリ内のファイルも簡単にループ処理できるようになります。
43    // RecursiveIteratorIterator::LEAVES_ONLY フラグは、ディレクトリ自体ではなく、最終的なファイル（葉）のみを返します。
44    $recursiveIterator = new RecursiveIteratorIterator(
45        $regexIterator,
46        RecursiveIteratorIterator::LEAVES_ONLY
47    );
48
49    echo "フィルタリングされたファイルの一覧:\n";
50    foreach ($recursiveIterator as $pathName => $fileInfo) {
51        // 現在のイテレータ要素 (フィルタリングされたファイル) のパスを表示します。
52        // $fileInfo は SplFileInfo オブジェクトであり、ファイルに関する情報を提供します。
53        echo "  - マッチしたパス: " . $fileInfo->getPathname() . "\n";
54
55        // RecursiveRegexIterator::getInnerIterator() の動作を理解します。
56        // RecursiveIteratorIterator::getInnerIterator() は、現在のイテレータ階層の「内側」にあるイテレータを返します。
57        // この場合、$recursiveIterator は $regexIterator をラップしているので、
58        // 最初の getInnerIterator() 呼び出しは RecursiveRegexIterator のインスタンスを返します。
59        $innerRegexIterator = $recursiveIterator->getInnerIterator();
60
61        // さらに、$innerRegexIterator (RecursiveRegexIterator) も $directoryIterator (RecursiveDirectoryIterator) をラップしています。
62        // そこで、$innerRegexIterator に対して再度 getInnerIterator() を呼び出すことで、
63        // フィルタリング元となった最初のデータソースである RecursiveDirectoryIterator のインスタンスを取得できます。
64        $originalDirectoryIterator = $innerRegexIterator->getInnerIterator();
65
66        // 取得した元のイテレータのパスとクラス名を表示します。
67        // これは、フィルタリングされる前の元のファイルのパスを示し、そのイテレータが何であるかを確認できます。
68        echo "    -> getInnerIterator() で取得した元のイテレータのパス: " . $originalDirectoryIterator->getPathname() . "\n";
69        echo "    -> 元のイテレータのクラス名: " . get_class($originalDirectoryIterator) . "\n\n";
70    }
71
72} catch (UnexpectedValueException $e) {
73    // ディレクトリが存在しないなどのエラーが発生した場合の処理
74    echo "エラーが発生しました: " . $e->getMessage() . "\n";
75} finally {
76    // スクリプトの実行終了時に作成した一時ファイルをクリーンアップするための補助関数です。
77    // この関数は、指定されたディレクトリとその中のすべてのファイルおよびサブディレクトリを削除します。
78    function rrmdir($dir) {
79        if (!file_exists($dir)) {
80            return;
81        }
82        $objects = scandir($dir);
83        foreach ($objects as $object) {
84            if ($object != "." && $object != "..") { // '.' と '..' はスキップ
85                if (is_dir($dir . DIRECTORY_SEPARATOR . $object)) {
86                    rrmdir($dir . DIRECTORY_SEPARATOR . $object); // サブディレクトリを再帰的に削除
87                } else {
88                    unlink($dir . DIRECTORY_SEPARATOR . $object); // ファイルを削除
89                }
90            }
91        }
92        rmdir($dir); // 空になったディレクトリを削除
93    }
94
95    rrmdir($tempDir); // サンプル実行後に一時ディレクトリを削除
96    echo "--- 一時ディレクトリをクリーンアップしました。---\n";
97    echo "--- サンプル終了 ---\n";
98}

PHP 8のRecursiveRegexIterator::getInnerIterator()メソッドは、正規表現で項目をフィルタリングするRecursiveRegexIteratorが、内部でラップ（包み込んでいる）している元のイテレータを取得するために利用されます。このメソッドは引数を一切取らず、戻り値としてRecursiveIteratorインターフェースを実装したオブジェクトを返します。

RecursiveRegexIteratorは、例えばRecursiveDirectoryIteratorのような別のイテレータをデータソースとして受け取り、指定された正規表現に一致する項目のみを通過させるフィルタとして機能します。getInnerIterator()を呼び出すと、そのフィルタリングが行われる前の、もともとRecursiveRegexIteratorに渡されたイテレータのインスタンスを取り出すことができます。

サンプルコードでは、まずRecursiveDirectoryIteratorでディレクトリツリーを走査し、それをRecursiveRegexIteratorで拡張子が.txtのファイルにフィルタリングしています。さらにそのRecursiveRegexIteratorをRecursiveIteratorIteratorでラップし、再帰的な構造を平坦化してループ処理を行っています。この階層構造の中で、RecursiveIteratorIterator::getInnerIterator()を呼び出すとRecursiveRegexIteratorが得られ、さらにそのRecursiveRegexIterator::getInnerIterator()を呼び出すことで、最終的に元のRecursiveDirectoryIteratorのインスタンスが取得できる様子が示されています。これにより、フィルタリング過程のどの段階でどのイテレータがデータソースとして使われていたかを追跡し、確認することが可能です。

Copy
1<?php
2
3/**
4 * PHPのRecursiveRegexIterator::getInnerIteratorメソッドの使用例を示します。
5 * この関数は、イテレータと正規表現によるファイルフィルタリングの基本をカバーし、
6 * システムエンジニアを目指す初心者にも理解しやすいように構成されています。
7 */
8function demonstrateRecursiveRegexIteratorWithInnerIterator(): void
9{
10    // 一時ディレクトリの名前を定義します。これはスクリプトが実行されるディレクトリに作成されます。
11    $tempDir = __DIR__ . '/temp_php_iterator_example';
12
13    try {
14        // --- 1. サンプル用のディレクトリとファイルを準備します ---
15        echo "1. サンプル用のディレクトリとファイルを作成中...\n";
16        if (!is_dir($tempDir)) {
17            mkdir($tempDir, 0777, true);
18        }
19        file_put_contents($tempDir . '/example_script1.php', '<?php echo "Hello from script 1!";');
20        file_put_contents($tempDir . '/document.txt', 'This is a text document.');
21        mkdir($tempDir . '/sub_folder', 0777, true);
22        file_put_contents($tempDir . '/sub_folder/example_script2.php', '<?php echo "Hello from script 2!";');
23        file_put_contents($tempDir . '/sub_folder/image.jpg', 'Binary image data.');
24        echo "   一時ディレクトリ: {$tempDir}\n\n";
25
26        // --- 2. RecursiveDirectoryIterator を作成します ---
27        // これは、指定されたディレクトリとそのサブディレクトリを再帰的に走査するためのイテレータです。
28        // SKIP_DOTS フラグは、'.'（現在のディレクトリ）と '..'（親ディレクトリ）をスキップします。
29        echo "2. RecursiveDirectoryIterator を準備中...\n";
30        $directoryIterator = new RecursiveDirectoryIterator(
31            $tempDir,
32            RecursiveDirectoryIterator::SKIP_DOTS
33        );
34        echo "   RecursiveDirectoryIterator がルートパス '{$directoryIterator->getPath()}' を走査します。\n\n";
35
36        // --- 3. RecursiveRegexIterator を作成し、PHPファイルのみをフィルタリングします ---
37        // RecursiveRegexIterator は、内部イテレータ（この場合 $directoryIterator）を
38        // 正規表現でフィルタリングしながら再帰的に走査します。
39        // ここでは、ファイル名が '.php' で終わるものだけを抽出する正規表現を指定します。
40        // GET_MATCH モードは、マッチした部分を配列として返します。
41        echo "3. RecursiveRegexIterator でPHPファイルをフィルタリング中...\n";
42        $phpFileFilterIterator = new RecursiveRegexIterator(
43            $directoryIterator,
44            '/^.+\.php$/i', // 正規表現: '.php' で終わるファイル名にマッチ
45            RecursiveRegexIterator::GET_MATCH
46        );
47        echo "   正規表現 '/^.+\.php$/i' でフィルタリングされます。\n\n";
48
49        // --- 4. RecursiveIteratorIterator を使用して、フィルタリングされたイテレータを走査します ---
50        // RecursiveIteratorIterator は、再帰的なイテレータ（RecursiveRegexIterator）を
51        // フラットな形で走査できるようにし、すべての要素を簡単にループ処理できるようにします。
52        echo "--- フィルタリングされたPHPファイルのリスト --- \n";
53        foreach (new RecursiveIteratorIterator($phpFileFilterIterator) as $path => $file) {
54            // $path はファイルまたはディレクトリのフルパスです。
55            echo "見つかったPHPファイル: {$path}\n";
56
57            // --- 5. getInnerIterator() メソッドの使用 ---
58            // getInnerIterator() は、現在の RecursiveRegexIterator がラップしている
59            // 元のイテレータ（この場合は RecursiveDirectoryIterator）を返します。
60            // これにより、フィルタリング前の元のイテレータの情報を取得できます。
61            $innerIterator = $phpFileFilterIterator->getInnerIterator();
62
63            // 取得した内部イテレータが期待通りの型であることを確認します。
64            if ($innerIterator instanceof RecursiveDirectoryIterator) {
65                echo "  (getInnerIterator() が返した元のイテレータのパス: " . $innerIterator->getPathname() . ")\n";
66                // getInnerIterator() は常に RecursiveDirectoryIterator のインスタンス自体を返しますが、
67                // そのインスタンスの現在の「カーソル位置」は、外部イテレータの進行に合わせて変化します。
68            } else {
69                echo "  (getInnerIterator() が予期しない型のイテレータを返しました)\n";
70            }
71        }
72        echo "--------------------------------------------------\n\n";
73
74    } finally {
75        // --- 6. 常に一時ディレクトリとファイルをクリーンアップします ---
76        // スクリプトの実行が成功しても失敗しても、このfinallyブロックが実行され、
77        // 作成した一時ファイルとディレクトリが削除されます。
78        echo "6. 一時ディレクトリとファイルをクリーンアップ中...\n";
79        if (is_dir($tempDir)) {
80            $files = new RecursiveIteratorIterator(
81                new RecursiveDirectoryIterator($tempDir, RecursiveDirectoryIterator::SKIP_DOTS),
82                RecursiveIteratorIterator::CHILD_FIRST // 子要素を先に処理して削除できるようにします
83            );
84            foreach ($files as $fileinfo) {
85                // ファイルかディレクトリかによって削除方法を切り替えます
86                $todo = ($fileinfo->isDir() ? 'rmdir' : 'unlink');
87                $todo($fileinfo->getRealPath());
88            }
89            rmdir($tempDir); // 最後にルートディレクトリを削除します
90        }
91        echo "   クリーンアップ完了。\n";
92    }
93}
94
95// 上記の関数を実行してデモンストレーションを開始します。
96demonstrateRecursiveRegexIteratorWithInnerIterator();
97
98?>

PHP 8のRecursiveRegexIterator::getInnerIteratorメソッドは、正規表現で要素をフィルタリングしながら再帰的に走査するRecursiveRegexIteratorが内部で利用している「元のイテレータ」を取得します。このメソッドは引数を取らず、戻り値はRecursiveIteratorインターフェースを実装したイテレータです。

RecursiveRegexIteratorは、例えばファイルシステムから特定の正規表現に合致するファイルを再帰的に抽出する際に活用されます。getInnerIterator()を呼び出すことで、現在処理中のフィルタリングされた要素に対応する、フィルタリング前の元のイテレータが持つ詳細な情報（ファイルパスやその他の属性など）にアクセスできます。

サンプルコードでは、まずRecursiveDirectoryIteratorでディレクトリを走査する準備をし、これを基にRecursiveRegexIteratorが正規表現「.php$」にマッチするPHPファイルのみを抽出しています。ループ内でgetInnerIterator()を使うと、現在処理中のPHPファイルに対応するRecursiveDirectoryIteratorを取得でき、その元のパス名などを確認できます。このように、getInnerIterator()は、フィルタリング後のデータから、元のデータソースのより深い情報を取得する際に役立ちます。