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

Copy
1<?php
2
3// ParentIterator::getInnerIterator() のサンプルコード
4// このメソッドは、ParentIterator がラップしている元の RecursiveIterator オブジェクトを返します。
5// システムエンジニアを目指す初心者の方にも理解しやすいように、基本的な使用方法を示します。
6
7// 1. 動作確認のための仮のディレクトリとファイルを作成
8// 一時的なファイルシステム構造を作成し、RecursiveIterator の対象とします。
9$tempDir = __DIR__ . '/_temp_parent_iterator_demo';
10if (!is_dir($tempDir)) {
11    mkdir($tempDir, 0777, true);
12}
13file_put_contents($tempDir . '/file1.txt', 'Dummy content for file1');
14mkdir($tempDir . '/subdir', 0777, true);
15file_put_contents($tempDir . '/subdir/file2.txt', 'Dummy content for file2');
16
17echo "--- ParentIterator::getInnerIterator() のデモンストレーション ---\n\n";
18
19// 2. 内部イテレータ (RecursiveIterator) を作成
20// ParentIterator は RecursiveIterator インターフェースを実装するオブジェクトをラップします。
21// ここでは RecursiveDirectoryIterator を使用します。
22$innerIterator = new RecursiveDirectoryIterator(
23    $tempDir,
24    RecursiveDirectoryIterator::SKIP_DOTS // '.' と '..' をスキップ
25);
26echo "作成された内部イテレータのクラス: " . get_class($innerIterator) . "\n";
27echo "内部イテレータが指すパス: " . $innerIterator->getPath() . "\n\n";
28
29// 3. ParentIterator を作成し、上記で作成した内部イテレータをラップ
30$parentIterator = new ParentIterator($innerIterator);
31echo "作成された ParentIterator のクラス: " . get_class($parentIterator) . "\n\n";
32
33// 4. getInnerIterator() を呼び出し、ParentIterator がラップしている元のイテレータを取得
34// このメソッドは、ParentIterator のコンストラクタに渡された RecursiveIterator を返します。
35$retrievedInnerIterator = $parentIterator->getInnerIterator();
36echo "getInnerIterator() が返したイテレータのクラス: " . get_class($retrievedInnerIterator) . "\n\n";
37
38// 5. 返されたイテレータが元の内部イテレータと同一インスタンスであることを確認
39// オブジェクトが厳密に同一 (同じインスタンス) であるかを '===' で確認します。
40echo "元の内部イテレータと取得したイテレータは同一インスタンスか？: " . ($innerIterator === $retrievedInnerIterator ? 'はい' : 'いいえ') . "\n";
41
42// 後処理: 作成した仮のディレクトリとファイルを削除
43// サンプルコードを繰り返し実行できるように、一時ファイルをクリーンアップします。
44function deleteDirRecursive($dir) {
45    if (!is_dir($dir)) {
46        return;
47    }
48    $files = array_diff(scandir($dir), ['.', '..']);
49    foreach ($files as $file) {
50        (is_dir("$dir/$file")) ? deleteDirRecursive("$dir/$file") : unlink("$dir/$file");
51    }
52    rmdir($dir);
53}
54deleteDirRecursive($tempDir);
55echo "\n一時ディレクトリ '$tempDir' をクリーンアップしました。\n";
56
57?>

PHP 8のParentIterator::getInnerIterator()メソッドは、ParentIteratorが内部でラップしている元のRecursiveIteratorオブジェクトを取得するために使用されます。このメソッドは引数を必要とせず、戻り値としてRecursiveIteratorインターフェースを実装するオブジェクトを返します。

具体的には、ParentIteratorを生成する際にコンストラクタに渡されたRecursiveIteratorのインスタンスそのものが返されます。例えば、ファイルシステムを再帰的に走査するRecursiveDirectoryIteratorをまず作成し、そのオブジェクトをParentIteratorに渡してラップしたとします。その後、ParentIteratorからgetInnerIterator()を呼び出すことで、ラップされていた元のRecursiveDirectoryIteratorのインスタンスを取り出すことが可能です。これにより、ParentIteratorが提供する親要素へのアクセス機能を利用しつつ、必要に応じて元のイテレータの機能にも直接アクセスできます。返されるオブジェクトは、コンストラクタに渡したインスタンスと厳密に同一のものであるため、元のイテレータの状態や振る舞いを維持したまま操作を続けることができます。

Copy
1<?php
2
3/**
4 * ParentIterator::getInnerIterator() メソッドの使用例を示します。
5 *
6 * ParentIterator は、RecursiveIterator をラップし、再帰的なデータ構造（例: ファイルシステム）を
7 * 走査する際に利用されるイテレータです。
8 * getInnerIterator() メソッドは、ParentIterator がラップしている元のイテレータ（内部イテレータ）を返します。
9 * このサンプルコードでは、一時的なファイルシステム構造を作成し、それを再帰的に走査しながら、
10 * 各要素において ParentIterator が保持する内部イテレータが何かを示します。
11 *
12 * キーワード「イテレータ」に最も関連性の高い SPL イテレータの具体的な利用例として、
13 * ファイルシステムの再帰的な走査をデモンストレーションします。
14 */
15function demonstrateParentIteratorGetInnerIterator(): void
16{
17    // テスト用の作業ディレクトリを設定します。
18    // スクリプトが実行されているディレクトリに一時的なディレクトリを作成します。
19    $testDir = __DIR__ . '/test_files_for_parent_iterator';
20
21    // --- テストファイル構造の作成ロジック ---
22    // もしテストディレクトリが既に存在すれば、中身を削除してから再作成します。
23    if (file_exists($testDir)) {
24        // RecursiveIteratorIterator と RecursiveDirectoryIterator を使ってディレクトリを再帰的に削除します。
25        $files = new RecursiveIteratorIterator(
26            new RecursiveDirectoryIterator($testDir, RecursiveDirectoryIterator::SKIP_DOTS),
27            RecursiveIteratorIterator::CHILD_FIRST // 子要素から削除するよう指定
28        );
29        foreach ($files as $fileinfo) {
30            if ($fileinfo->isDir()) {
31                rmdir($fileinfo->getRealPath()); // ディレクトリを削除
32            } else {
33                unlink($fileinfo->getRealPath()); // ファイルを削除
34            }
35        }
36        rmdir($testDir); // 空になったルートディレクトリを削除
37    }
38    // ディレクトリとそのサブディレクトリを再帰的に作成します。
39    mkdir($testDir, 0777, true);
40
41    // テスト用のファイルとサブディレクトリを作成します。
42    file_put_contents($testDir . '/file1.txt', 'Content for file1');
43    mkdir($testDir . '/subdir1');
44    file_put_contents($testDir . '/subdir1/file2.txt', 'Content for file2');
45    mkdir($testDir . '/subdir1/subdir2');
46    file_put_contents($testDir . '/subdir1/subdir2/file3.txt', 'Content for file3');
47    echo "--- テストディレクトリ構造の作成完了 ---\n\n";
48    // --- テストファイル構造の作成ロジック終了 ---
49
50    try {
51        // RecursiveDirectoryIterator を使用して、指定されたディレクトリの内容を再帰的に走査します。
52        // SKIP_DOTS フラグにより、'.' と '..' (現在のディレクトリと親ディレクトリ) をスキップします。
53        $directoryIterator = new RecursiveDirectoryIterator(
54            $testDir,
55            RecursiveDirectoryIterator::SKIP_DOTS
56        );
57
58        // ParentIterator で RecursiveDirectoryIterator をラップします。
59        // ParentIterator は RecursiveIterator を受け取り、特定のユースケースで親ディレクトリへの
60        // アクセスを容易にしますが、ここでは getInnerIterator の動作に焦点を当てます。
61        $parentIterator = new ParentIterator($directoryIterator);
62
63        // RecursiveIteratorIterator を使用して、ParentIterator が提供するすべての要素を平坦化して走査します。
64        // SELF_FIRST は、現在のディレクトリまたはファイルを先に、次にその子要素を走査することを意味します。
65        $recursiveIterator = new RecursiveIteratorIterator(
66            $parentIterator,
67            RecursiveIteratorIterator::SELF_FIRST
68        );
69
70        echo "--- ParentIterator を使用したディレクトリ走査と getInnerIterator のデモンストレーション ---\n";
71        $counter = 0;
72        foreach ($recursiveIterator as $name => $fileInfo) {
73            $counter++;
74            echo "  [" . $counter . "] 現在の要素パス: " . $fileInfo->getPathname() . "\n";
75
76            // RecursiveIteratorIterator の getInnerIterator() メソッドは、
77            // 現在イテレートしている階層のイテレータを返します。
78            // この場合、それは ParentIterator のインスタンスです。
79            $currentParentIterator = $recursiveIterator->getInnerIterator();
80
81            // ParentIterator の getInnerIterator() メソッドを呼び出し、
82            // ParentIterator がラップしている元の RecursiveIterator を取得します。
83            // これにより、ParentIterator が内部的に保持している RecursiveDirectoryIterator のインスタンスにアクセスできます。
84            $innerIterator = $currentParentIterator->getInnerIterator();
85
86            // 取得した内部イテレータが、元の RecursiveDirectoryIterator のインスタンスであることを確認します。
87            echo "      -> ParentIterator から取得した内部イテレータのクラス: " . get_class($innerIterator) . "\n";
88            echo "      -> 取得した内部イテレータが指すパス: " . $innerIterator->getPathname() . "\n";
89            echo "\n";
90        }
91    } finally {
92        // --- テストファイル構造のクリーンアップロジック ---
93        // 処理が完了したら、作成したテストファイルを削除してクリーンアップします。
94        if (file_exists($testDir)) {
95            $files = new RecursiveIteratorIterator(
96                new RecursiveDirectoryIterator($testDir, RecursiveDirectoryIterator::SKIP_DOTS),
97                RecursiveIteratorIterator::CHILD_FIRST
98            );
99            foreach ($files as $fileinfo) {
100                if ($fileinfo->isDir()) {
101                    rmdir($fileinfo->getRealPath());
102                } else {
103                    unlink($fileinfo->getRealPath());
104                }
105            }
106            rmdir($testDir);
107        }
108        echo "--- テストディレクトリ構造のクリーンアップ完了 ---\n";
109        // --- テストファイル構造のクリーンアップロジック終了 ---
110    }
111}
112
113// 上記のデモンストレーション関数を実行します。
114demonstrateParentIteratorGetInnerIterator();
115

PHPのParentIterator::getInnerIterator()メソッドは、SPL（Standard PHP Library）イテレータの一部であり、ParentIteratorオブジェクトが内部でラップしている元のイテレータを取得するために利用されます。ParentIteratorは、ファイルシステムのような再帰的なデータ構造を走査するRecursiveIteratorをさらにラップし、その親要素へのアクセスなどを特定の状況で補助します。

getInnerIterator()メソッドは引数を取りません。このメソッドを呼び出すと、ParentIteratorがコンストラクタで受け取ったRecursiveIteratorのインスタンスが戻り値として返されます。これにより、ParentIterator越しにラップされた元のイテレータの機能や状態に直接アクセスすることが可能になります。

提示されたサンプルコードでは、まず一時的なディレクトリ構造が作成されます。次に、RecursiveDirectoryIteratorがこのディレクトリを走査するための内部イテレータとして用意され、それをParentIteratorでラップしています。さらにRecursiveIteratorIteratorを使って全体を再帰的に走査する中で、ParentIteratorインスタンスからgetInnerIterator()メソッドを呼び出し、それが元のRecursiveDirectoryIteratorのインスタンスであることを示しています。このように、ParentIteratorがどのイテレータを保持しているかを具体的に確認したり、その内部イテレータの持つ特定の情報を取得したりする際に、このメソッドが活用されます。