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

Copy
1<?php
2
3// このコードは、RecursiveCachingIterator クラスの count() メソッドの使用例を示します。
4// count() メソッドは、イテレータがキャッシュした要素の総数を返します。
5
6// 1. テスト用のディレクトリとファイルを作成します。
7//    RecursiveCachingIterator が走査する対象として使用します。
8$tempDir = __DIR__ . '/recursive_iterator_test_dir';
9if (!is_dir($tempDir)) {
10    mkdir($tempDir);
11}
12file_put_contents($tempDir . '/file1.txt', 'これはファイル1です。');
13mkdir($tempDir . '/subdir');
14file_put_contents($tempDir . '/subdir/file2.txt', 'これはサブディレクトリ内のファイル2です。');
15
16try {
17    // 2. RecursiveDirectoryIterator を作成します。
18    //    FilesystemIterator::SKIP_DOTS を指定することで、'.' と '..' (現在のディレクトリと親ディレクトリ)
19    //    のエントリをスキップし、実際のファイルやディレクトリのみを対象とします。
20    $directoryIterator = new RecursiveDirectoryIterator($tempDir, FilesystemIterator::SKIP_DOTS);
21
22    // 3. RecursiveCachingIterator で RecursiveDirectoryIterator をラップします。
23    //    これにより、イテレータの要素がキャッシュされ、複数回アクセスしてもパフォーマンスが向上します。
24    //    特に count() メソッドは、内部でイテレータを最後まで進めて要素をキャッシュします。
25    $cachingIterator = new RecursiveCachingIterator($directoryIterator);
26
27    // 4. count() メソッドを呼び出し、キャッシュされた要素の総数を取得します。
28    //    このメソッドはイテレータを最後まで進め、その過程でキャッシュされた全要素の数を返します。
29    $numberOfCachedItems = $cachingIterator->count();
30
31    // 5. 結果を出力します。
32    //    この例では、作成したファイルとディレクトリ（'file1.txt', 'subdir', 'subdir/file2.txt'）
33    //    の合計3つのエントリが期待されます。
34    echo "RecursiveCachingIterator がキャッシュした要素の総数: " . $numberOfCachedItems . PHP_EOL;
35
36} finally {
37    // 6. テスト用に作成したディレクトリとファイルをクリーンアップします。
38    //    このクロージャ関数は、指定されたディレクトリとその中の全てのファイル・サブディレクトリを再帰的に削除します。
39    $cleanup = function ($dir) use (&$cleanup) {
40        if (is_dir($dir)) {
41            $objects = scandir($dir);
42            foreach ($objects as $object) {
43                if ($object != "." && $object != "..") {
44                    if (is_dir($dir . "/" . $object)) {
45                        $cleanup($dir . "/" . $object);
46                    } else {
47                        unlink($dir . "/" . $object);
48                    }
49                }
50            }
51            rmdir($dir);
52        }
53    };
54    $cleanup($tempDir);
55}
56
57?>

PHPのRecursiveCachingIteratorクラスに属するcount()メソッドは、イテレータが内部にキャッシュしている要素の総数を取得するために使用されます。このメソッドは引数を一切必要とせず、キャッシュされた要素の合計数を整数（int）として返します。

RecursiveCachingIteratorは、繰り返し処理を行うイテレータの要素をキャッシュすることで、特に複数回アクセスする場合や、イテレータの全要素を事前に把握したい場合にパフォーマンスを向上させる目的で利用されます。count()メソッドを呼び出すと、内部でラップしているイテレータを最後まで進め、その過程で全ての要素をキャッシュに保存します。その後、キャッシュに保存された全ての要素の数を正確に数え上げて返します。

サンプルコードでは、まず一時的なディレクトリとファイルを作成し、これをRecursiveDirectoryIteratorで走査します。次に、このディレクトリイテレータをRecursiveCachingIteratorでラップし、そのcount()メソッドを呼び出しています。これにより、指定したディレクトリ内のファイルやサブディレクトリの総数が数えられ、その結果（この例では3つ）が出力されます。この機能は、特定のコレクションやファイルシステムの要素数を効率的に把握したい場合に大変便利です。