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

Copy
1<?php
2
3/**
4 * RecursiveCachingIterator とその current() メソッドを使用して、
5 * 現在のスクリプト実行ディレクトリを再帰的に走査し、各要素を表示します。
6 *
7 * RecursiveCachingIterator は、イテレータの要素をキャッシュし、
8 * パフォーマンスを向上させるのに役立ちます。
9 * current() メソッドは、イテレータが現在指している要素（通常はSplFileInfoオブジェクト）を返します。
10 *
11 * この例では、スクリプトが実行されているディレクトリを対象とします。
12 *
13 * @return void
14 */
15function exploreCurrentDirectoryRecursively(): void
16{
17    // スクリプトが実行されている現在のディレクトリを取得します。
18    // このキーワードに関連する部分です。
19    $currentDirectory = getcwd();
20    if ($currentDirectory === false) {
21        echo "エラー: 現在の作業ディレクトリを取得できませんでした。" . PHP_EOL;
22        return;
23    }
24    echo "現在のスクリプト実行ディレクトリ: " . $currentDirectory . PHP_EOL . PHP_EOL;
25
26    // 走査対象のディレクトリを指定します。ここでは現在のディレクトリを使用します。
27    $targetDir = $currentDirectory;
28
29    try {
30        // 1. RecursiveDirectoryIterator: 指定したディレクトリの要素（ファイルやサブディレクトリ）を
31        //    再帰的に取得するためのイテレータを作成します。
32        //    FilesystemIterator::SKIP_DOTS を使用して、'.' と '..' をスキップします。
33        $directoryIterator = new RecursiveDirectoryIterator($targetDir, FilesystemIterator::SKIP_DOTS);
34
35        // 2. RecursiveCachingIterator: 上記のイテレータをラップし、要素をキャッシュします。
36        //    これにより、同じ要素に複数回アクセスする際のパフォーマンスが向上します。
37        //    current() メソッドは、このイテレータがキャッシュした現在の要素を返します。
38        $cachingIterator = new RecursiveCachingIterator($directoryIterator);
39
40        // 3. RecursiveIteratorIterator: 再帰的なイテレータ（ここではRecursiveCachingIterator）を
41        //    フラットに反復処理するためのイテレータです。
42        //    SELF_FIRST は、ディレクトリ自体をその内容の前に表示することを意味します。
43        $iterator = new RecursiveIteratorIterator($cachingIterator, RecursiveIteratorIterator::SELF_FIRST);
44
45        echo "--- " . basename($targetDir) . " ディレクトリの要素を再帰的に表示 ---" . PHP_EOL;
46
47        // イテレータをループし、各要素の情報を取得します。
48        foreach ($iterator as $name => $fileInfo) {
49            // RecursiveCachingIterator::current() メソッドを明示的に呼び出します。
50            // これはイテレータが現在指している要素（SplFileInfoオブジェクト）を返します。
51            $currentElement = $iterator->current();
52
53            // 取得した要素のパスと種類を表示します。
54            // getDepth() で現在の階層を取得し、インデントで視覚的に表現します。
55            echo str_repeat("  ", $iterator->getDepth()); // 階層を示すインデント
56            echo ($currentElement->isDir() ? "[D] " : "[F] "); // ディレクトリかファイルか
57            echo $currentElement->getPathname() . PHP_EOL;
58        }
59
60    } catch (UnexpectedValueException $e) {
61        echo "エラー: ディレクトリが見つからないか、アクセスできません。" . PHP_EOL;
62        echo "詳細: " . $e->getMessage() . PHP_EOL;
63    } catch (Exception $e) {
64        echo "予期せぬエラーが発生しました: " . $e->getMessage() . PHP_EOL;
65    }
66}
67
68// 関数を実行して、現在のディレクトリを探索します。
69exploreCurrentDirectoryRecursively();

このPHPサンプルコードは、RecursiveCachingIteratorクラスのcurrent()メソッドを使用して、現在のスクリプト実行ディレクトリを再帰的に走査し、その内容を表示する方法を示しています。

コードはまずgetcwd()関数で現在の作業ディレクトリを取得し、そのディレクトリを走査の起点とします。次に、RecursiveDirectoryIteratorで指定されたディレクトリのファイルやサブディレクトリを再帰的に取得するイテレータを作成し、それをRecursiveCachingIteratorでラップしています。RecursiveCachingIteratorは、イテレータの要素をキャッシュすることで、同じ要素への複数回のアクセス性能を向上させます。さらに、RecursiveIteratorIteratorを使って、これらの再帰的な要素を一つずつ順番に処理できるようにしています。

ループ処理内で呼び出されるRecursiveCachingIterator::current()メソッドは、引数を一切取らず、イテレータが現在指している要素を返します。この戻り値はmixed型であり、通常はファイルやディレクトリの詳細情報を持つSplFileInfoオブジェクトです。サンプルコードでは、このcurrent()メソッドによって得られたSplFileInfoオブジェクトから、要素のパス名と種類（ディレクトリかファイルか）を取得し、現在の階層を示すインデントを付けて視覚的に分かりやすく表示しています。これにより、効率的に現在のディレクトリ構造を探索し、各要素の情報を取得するプロセスを学ぶことができます。

Copy
1<?php
2
3/**
4 * RecursiveCachingIterator::current() の使用例。
5 *
6 * この関数は、RecursiveCachingIterator を用いてディレクトリ構造を走査し、
7 * current() メソッドでイテレータが指す現在の要素（ファイルやディレクトリ）を取得します。
8 * RecursiveCachingIterator は内部イテレータの要素をキャッシュすることで、
9 * 効率的なイテレーションを提供します。
10 */
11function demonstrateRecursiveCachingIteratorCurrent(): void
12{
13    // 一時ディレクトリを作成し、テスト用のファイルとサブディレクトリを配置します。
14    $tempDir = sys_get_temp_dir() . DIRECTORY_SEPARATOR . 'test_recursive_iter_cache_' . uniqid();
15    if (!mkdir($tempDir, 0777, true) && !is_dir($tempDir)) {
16        throw new RuntimeException(sprintf('Directory "%s" was not created', $tempDir));
17    }
18    mkdir($tempDir . DIRECTORY_SEPARATOR . 'subdir');
19    file_put_contents($tempDir . DIRECTORY_SEPARATOR . 'file1.txt', 'Hello PHP!');
20    file_put_contents($tempDir . DIRECTORY_SEPARATOR . 'subdir' . DIRECTORY_SEPARATOR . 'file2.log', 'Log data.');
21
22    echo "--- RecursiveCachingIterator::current() Example ---\n";
23
24    try {
25        // RecursiveDirectoryIterator を作成し、指定したディレクトリを走査します。
26        $directoryIterator = new RecursiveDirectoryIterator(
27            $tempDir,
28            RecursiveDirectoryIterator::SKIP_DOTS // '.' と '..' をスキップします。
29        );
30
31        // RecursiveIteratorIterator で再帰的にディレクトリを深く走査できるようにします。
32        // RecursiveIteratorIterator::LEAVES_ONLY を指定することで、ファイルのみを対象とします。
33        $recursiveIterator = new RecursiveIteratorIterator(
34            $directoryIterator,
35            RecursiveIteratorIterator::LEAVES_ONLY
36        );
37
38        // RecursiveCachingIterator で内部イテレータをラップします。
39        // これにより、イテレータの要素がキャッシュされ、効率的なアクセスが可能になります。
40        $cachingIterator = new RecursiveCachingIterator($recursiveIterator);
41
42        $index = 0;
43        foreach ($cachingIterator as $key => $value) {
44            // current() メソッドは、イテレータが現在指している要素（この場合は SplFileInfo オブジェクト）を返します。
45            $currentElement = $cachingIterator->current();
46
47            echo sprintf(
48                "[%d] Path: %s (Type: %s)\n",
49                ++$index,
50                $currentElement->getPathname(),
51                $currentElement->getType()
52            );
53        }
54
55    } catch (Exception $e) {
56        echo "Error: " . $e->getMessage() . "\n";
57    } finally {
58        // テスト用に作成したディレクトリとファイルをクリーンアップします。
59        $deleteDirectoryRecursive = function (string $dir) use (&$deleteDirectoryRecursive): void {
60            if (!is_dir($dir)) {
61                return;
62            }
63            $items = new FilesystemIterator($dir);
64            foreach ($items as $item) {
65                if ($item->isDir()) {
66                    $deleteDirectoryRecursive($item->getPathname());
67                } else {
68                    unlink($item->getPathname());
69                }
70            }
71            rmdir($dir);
72        };
73        $deleteDirectoryRecursive($tempDir);
74        echo "--- Cleanup Complete ---\n";
75    }
76}
77
78// 関数の実行
79demonstrateRecursiveCachingIteratorCurrent();

RecursiveCachingIterator::current() は、PHPでディレクトリ構造のような再帰的なデータを効率的に走査する際に利用される RecursiveCachingIterator クラスのメソッドです。このクラスは、内部のイテレータが提供する要素をキャッシュすることで、同じ要素へ繰り返しアクセスする際の処理速度を向上させ、システム全体のパフォーマンスに貢献します。

current() メソッドは引数を一切取らず、イテレータが現在指している要素をそのまま返します。戻り値の型は mixed と示されていますが、これは様々な型の値が返される可能性があることを意味します。ディレクトリを走査する例では、通常、ファイルやディレクトリの詳細情報を持つ SplFileInfo オブジェクトが返されます。

サンプルコードでは、まず一時ディレクトリを作成し、その中にテスト用のファイルやサブディレクトリを配置しています。次に、RecursiveDirectoryIterator と RecursiveIteratorIterator を組み合わせてディレクトリ構造を深く走査し、それを RecursiveCachingIterator でラップしています。これにより、ループ処理が効率化されます。foreach ループ内で $cachingIterator->current() を呼び出すことで、イテレータが現在処理しているファイルやディレクトリの情報を取得し、そのパスや種類を表示しています。このメソッドを使うことで、複雑な階層構造の中から必要な情報に正確にアクセスできます。