【PHP8.x】CachingIterator::FULL_CACHE定数の使い方

Copy
1<?php
2
3/**
4 * CachingIterator::FULL_CACHE 定数を使用して、ファイルパスを完全にキャッシュし、
5 * 効率的にイテレートする方法を示すサンプルコードです。
6 *
7 * この関数は一時ディレクトリを作成し、いくつかのダミーファイルを追加します。
8 * その後、FilesystemIterator と CachingIterator::FULL_CACHE を組み合わせて使用し、
9 * これらのファイルのフルパスを一度にメモリにキャッシュしてから処理します。
10 * 最後に、作成した一時ディレクトリとファイルをクリーンアップします。
11 */
12function demonstrateCachingFullPaths(): void
13{
14    // 一時ディレクトリを作成し、テストファイルを用意
15    $tempDir = sys_get_temp_dir() . DIRECTORY_SEPARATOR . 'php_full_cache_demo_' . uniqid();
16    if (!mkdir($tempDir) && !is_dir($tempDir)) {
17        throw new RuntimeException(sprintf('Temporary directory "%s" could not be created.', $tempDir));
18    }
19
20    $testFiles = ['file1.txt', 'document.pdf', 'image.jpg'];
21    foreach ($testFiles as $fileName) {
22        file_put_contents($tempDir . DIRECTORY_SEPARATOR . $fileName, "Content for $fileName.");
23    }
24
25    echo "--- 準備: 一時ディレクトリとファイル ---\n";
26    echo "作成された一時ディレクトリ: " . realpath($tempDir) . "\n\n";
27
28    try {
29        // FilesystemIterator を使用して、指定されたディレクトリのファイルパスをイテレートします。
30        // FilesystemIterator::SKIP_DOTS で '.' と '..' を除外します。
31        // FilesystemIterator::CURRENT_AS_PATHNAME で、各要素をファイルのフルパスとして取得します。
32        $baseIterator = new FilesystemIterator(
33            $tempDir,
34            FilesystemIterator::SKIP_DOTS | FilesystemIterator::CURRENT_AS_PATHNAME
35        );
36
37        // CachingIterator を使用して、ベースイテレータの全要素を完全にキャッシュします。
38        // CachingIterator::FULL_CACHE フラグにより、イテレータ全体が最初にメモリに読み込まれ、
39        // 後続のイテレーションで基になるイテレータへのアクセスが不要になります。
40        echo "--- CachingIterator::FULL_CACHE を使用してファイルパスをイテレート ---\n";
41        $cachingIterator = new CachingIterator($baseIterator, CachingIterator::FULL_CACHE);
42
43        // キャッシュされたイテレータをループし、ファイルのフルパスを表示
44        echo "初回イテレーション (キャッシュへの読み込み):\n";
45        foreach ($cachingIterator as $fullPath) {
46            echo "  ファイルパス: " . $fullPath . "\n";
47        }
48        echo "\n";
49
50        // CachingIterator::FULL_CACHE の利点を示すため、再度イテレート
51        // 基になるイテレータがリセットされていなくても、キャッシュされたデータから迅速に再利用されます。
52        echo "2回目イテレーション (キャッシュからの再利用):\n";
53        foreach ($cachingIterator as $fullPath) {
54            echo "  ファイルパス: " . $fullPath . "\n";
55        }
56        echo "\n";
57
58    } finally {
59        // 後処理: 一時ディレクトリとファイルを削除します。
60        echo "--- クリーンアップ: 一時ディレクトリとファイルを削除 ---\n";
61        foreach ($testFiles as $fileName) {
62            $filePath = $tempDir . DIRECTORY_SEPARATOR . $fileName;
63            if (file_exists($filePath)) {
64                unlink($filePath);
65                echo "  削除: " . $filePath . "\n";
66            }
67        }
68        if (is_dir($tempDir)) {
69            rmdir($tempDir);
70            echo "  一時ディレクトリを削除: " . $tempDir . "\n";
71        }
72    }
73}
74
75// 関数を実行してデモンストレーションを開始します。
76demonstrateCachingFullPaths();

CachingIterator::FULL_CACHEは、PHP 8のCachingIteratorクラスで使用される拡張機能の定数です。この定数は、イテレータのすべての要素を一度にメモリに完全にキャッシュするよう指定するために利用されます。

サンプルコードでは、一時ディレクトリに作成されたダミーファイルのフルパスを効率的に処理する方法を示しています。まずFilesystemIteratorを使ってファイルのフルパスを取得し、次にCachingIteratorをCachingIterator::FULL_CACHE定数と共に使用します。これにより、最初のイテレーション時にすべてのファイルパスがメモリに読み込まれ、キャッシュされます。その結果、2回目以降のイテレーションでは、基となるイテレータに再度アクセスすることなく、すでにメモリにあるキャッシュから高速にデータを利用できます。

この定数を使用することで、特にデータソースへのアクセスにコストがかかる場合や、同じデータを複数回イテレートする場合に、パフォーマンスを向上させることが可能です。FULL_CACHEは定数であるため、引数を取ることも、特定の値を戻すこともありません。

Copy
1<?php
2
3/**
4 * CachingIterator::FULL_CACHE 定数の利用例と、間接的なキャッシュ「クリア」の概念を示す関数。
5 *
6 * CachingIterator は、基となるイテレータの要素を内部的にキャッシュし、繰り返しアクセスする際に
7 * パフォーマンスを向上させるためのイテレータです。
8 *
9 * CachingIterator::FULL_CACHE 定数を設定すると、CachingIterator は基となるイテレータが
10 * 最初に完全に反復された時点で、その全ての要素を自身の内部に読み込み、キャッシュします。
11 * 一度キャッシュされると、基となるイテレータのデータが変更されても、CachingIterator は
12 * 古いキャッシュデータを使い続ける特性があります。
13 *
14 * ここで言う「キャッシュクリア」は、CachingIterator 自身にキャッシュを明示的にクリアする
15 * メソッドがないため、新しいデータソースでイテレータを再構築することによって、以前のキャッシュを
16 * 実質的に置き換える（新しいキャッシュを作成する）概念を示します。
17 */
18function demonstrateCachingIteratorFullCache(): void
19{
20    // 1. 初期データを用意
21    $initialData = ['apple', 'banana', 'cherry'];
22    echo "--- 初期データで CachingIterator を構築 ---" . PHP_EOL;
23
24    // 2. ArrayIterator で初期データをラップし、CachingIterator を作成します。
25    // CachingIterator::FULL_CACHE を指定することで、最初のイテレーションで全要素がキャッシュされます。
26    $arrayIterator = new ArrayIterator($initialData);
27    $cachingIterator = new CachingIterator(
28        $arrayIterator,
29        CachingIterator::FULL_CACHE // 全ての要素をキャッシュするモードを設定
30    );
31
32    // 3. 最初のイテレーション:
33    // この時点で、CachingIterator は $arrayIterator から全ての要素を読み込み、内部にキャッシュします。
34    echo "最初のイテレーション (データキャッシュ時):" . PHP_EOL;
35    foreach ($cachingIterator as $item) {
36        echo " - " . $item . PHP_EOL;
37    }
38
39    // 4. 基となるデータソースを変更します。
40    // 注意: CachingIterator::FULL_CACHE が有効な場合、既にキャッシュされたデータは、
41    // 基となる ArrayIterator ($initialData) のデータが変更されても自動では更新されません。
42    $initialData[] = 'date'; // 元の配列に新しい要素を追加
43    echo PHP_EOL . "--- 元のデータソースを変更 (CachingIterator のキャッシュには影響なし) ---" . PHP_EOL;
44    echo "元のデータ: " . implode(', ', $initialData) . PHP_EOL;
45
46    // 5. CachingIterator をもう一度イテレートします。
47    // FULL_CACHE モードのため、変更された新しいデータではなく、
48    // 最初にキャッシュされた古いデータが表示され続けます。
49    echo "2回目のイテレーション (変更前のキャッシュデータが表示):" . PHP_EOL;
50    foreach ($cachingIterator as $item) {
51        echo " - " . $item . PHP_EOL;
52    }
53
54    echo PHP_EOL . "--- 新しいデータソースで CachingIterator を再構築し、「キャッシュをクリア」 ---" . PHP_EOL;
55
56    // 6. 新しいデータソース (変更後の $initialData) で CachingIterator を「再構築」します。
57    // これが実質的に新しいキャッシュを生成し、以前のキャッシュを「クリア」する操作に相当します。
58    // 新しい ArrayIterator インスタンスを作成し、それを新しい CachingIterator に渡すことで実現します。
59    $newArrayIterator = new ArrayIterator($initialData);
60    $cachingIterator = new CachingIterator(
61        $newArrayIterator,
62        CachingIterator::FULL_CACHE
63    );
64
65    // 7. 3回目のイテレーション:
66    // 新しいデータがキャッシュされ、表示されます。
67    echo "3回目のイテレーション (新しいデータがキャッシュされて表示):" . PHP_EOL;
68    foreach ($cachingIterator as $item) {
69        echo " - " . $item . PHP_EOL;
70    }
71
72    echo PHP_EOL . "備考: CachingIterator::FULL_CACHE はキャッシュ挙動を設定する定数であり、" . PHP_EOL;
73    echo "直接キャッシュをクリアするメソッドではありません。キャッシュの内容を更新するには、" . PHP_EOL;
74    echo "新しいデータで CachingIterator を再構築する必要があります。" . PHP_EOL;
75}
76
77// 関数を実行して、CachingIterator の動作とキャッシュの概念を確認します。
78demonstrateCachingIteratorFullCache();

PHPのCachingIterator::FULL_CACHE定数は、CachingIteratorクラスで、基となるイテレータの要素のキャッシュ方法を指定する定数です。CachingIteratorは、データの繰り返しアクセス性能向上のため、要素をキャッシュします。FULL_CACHE設定時、CachingIteratorは最初のイテレーションで基となる全要素を読み込み、完全にキャッシュします。

一度FULL_CACHEモードでキャッシュされたデータは、基となるデータソースが変更されても自動的に更新されません。そのため、キャッシュを更新したい場合、CachingIteratorには直接クリアするメソッドがありません。「キャッシュクリア」とは、最新のデータソースでCachingIteratorインスタンスを「再構築」することを意味します。新しいインスタンスに最新データを渡すことで、以前のキャッシュは新しいキャッシュに置き換えられます。このFULL_CACHEは定数であり、引数や戻り値はありません。