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

Copy
1<?php
2
3/**
4 * RecursiveCachingIterator::FULL_CACHE 定数を使用して、
5 * ディレクトリツリーを完全に走査し、その内容（フルパス）をキャッシュする例。
6 *
7 * この関数は指定されたベースパス以下の全てのファイルとディレクトリのパスを2回表示します。
8 * RecursiveCachingIterator::FULL_CACHE が設定されているため、
9 * 2回目のイテレーションはキャッシュされたデータから読み込まれ、パフォーマンスが向上する可能性があります。
10 *
11 * @param string $basePath 走査対象のベースディレクトリのパス。
12 *                         スクリプト実行前に、このパスにいくつかのファイルやサブディレクトリを作成して試してください。
13 */
14function demonstrateFullCacheForDirectoryTraversal(string $basePath): void
15{
16    try {
17        // ディレクトリイテレータを作成し、'.' と '..' をスキップする
18        $directoryIterator = new RecursiveDirectoryIterator(
19            $basePath,
20            FilesystemIterator::SKIP_DOTS
21        );
22
23        // 再帰イテレータを作成し、ディレクトリ自身も含む形で走査する
24        $recursiveIterator = new RecursiveIteratorIterator(
25            $directoryIterator,
26            RecursiveIteratorIterator::SELF_FIRST
27        );
28
29        // RecursiveCachingIterator で再帰イテレータをラップし、FULL_CACHE フラグを設定する
30        // FULL_CACHE は、イテレータが完全に消費された後にその内容を全てキャッシュに保存するよう指示します。
31        $cachingIterator = new RecursiveCachingIterator(
32            $recursiveIterator,
33            RecursiveCachingIterator::FULL_CACHE
34        );
35
36        echo "--- 1回目のイテレーション (キャッシュ生成とフルパス表示) ---\n";
37        $count1 = 0;
38        foreach ($cachingIterator as $fileInfo) {
39            // getRealPath() はファイルやディレクトリの絶対パス（フルパス）を返します。
40            echo "パス: " . $fileInfo->getRealPath() . "\n";
41            $count1++;
42        }
43        echo "合計 " . $count1 . " 件の項目を検出しました。\n\n";
44
45        // FULL_CACHE が設定されているため、2回目のイテレーションはキャッシュからデータを読み込みます。
46        // これにより、実際のファイルシステムへのアクセスが減り、高速化が期待できます。
47        echo "--- 2回目のイテレーション (キャッシュ利用とフルパス表示) ---\n";
48        $count2 = 0;
49        foreach ($cachingIterator as $fileInfo) {
50            echo "パス: " . $fileInfo->getRealPath() . " (キャッシュから)\n";
51            $count2++;
52        }
53        echo "合計 " . $count2 . " 件の項目を検出しました。\n\n";
54
55    } catch (UnexpectedValueException $e) {
56        echo "エラー: 指定されたパス '{$basePath}' は有効なディレクトリではありません。\n";
57        echo "詳細: " . $e->getMessage() . "\n";
58    } catch (Exception $e) {
59        echo "予期せぬエラーが発生しました: " . $e->getMessage() . "\n";
60    }
61}
62
63// このスクリプトが実行されるディレクトリを対象とします。
64// 実行前に、このディレクトリ内にいくつかのファイルやサブディレクトリを作成して試してみてください。
65$targetDirectory = __DIR__;
66echo "対象ディレクトリ: " . $targetDirectory . "\n\n";
67
68// 関数を実行して動作を確認
69demonstrateFullCacheForDirectoryTraversal($targetDirectory);

PHPのRecursiveCachingIterator::FULL_CACHE定数は、イテレータが走査した結果をすべてキャッシュするための設定です。この定数を指定すると、イテレータは一度すべての要素を読み込み、その内容を内部に保存します。サンプルコードでは、指定されたディレクトリツリー内の全てのファイルやディレクトリのフルパスを繰り返し表示する際にこの機能を利用しています。

具体的には、RecursiveCachingIterator::FULL_CACHEを設定してイテレータを作成することで、初回イテレーション時にディレクトリ全体の構造と各項目のフルパスが完全にメモリにキャッシュされます。そのため、2回目のイテレーションでは実際のファイルシステムにアクセスすることなく、キャッシュから迅速にデータを取得できます。これにより、特に大規模なディレクトリ構造を複数回走査する場合に、プログラムのパフォーマンス向上に寄与します。この定数は引数を取らず、内部的に整数値として扱われますが、直接その値を操作することはありません。ファイルシステムのフルパス情報など、コストのかかる操作の結果を効率的に再利用したい場合に有用です。

Copy
1<?php
2
3/**
4 * RecursiveCachingIterator::FULL_CACHE 定数を使用して、
5 * イテレータの要素を完全にキャッシュし、その動作を示すサンプルです。
6 *
7 * RecursiveCachingIterator は、内部で元のイテレータの要素をキャッシュするイテレータです。
8 * FULL_CACHE モードでは、イテレータが最初に完全に走査されると、その全ての要素がメモリに保持されます。
9 * これにより、以降のイテレーションで元のデータソースに再度アクセスすることなく、
10 * キャッシュされたデータが再利用され、パフォーマンスが向上します。
11 *
12 * 「キャッシュクリア」というキーワードについて:
13 * RecursiveCachingIterator には、内部キャッシュを直接「クリア」するメソッドはありません。
14 * キャッシュを実質的にクリアするには、RecursiveCachingIterator オブジェクトを破棄し、
15 * 新しいデータソースで新しいインスタンスを作成することで行われます。
16 * これにより、次にアクセスする際には新しいキャッシュが構築されます。
17 */
18function demonstrateRecursiveCachingIteratorFullCache(): void
19{
20    // 1. キャッシュ対象となるデータソース（ネストされた配列）を準備します。
21    // RecursiveArrayIterator を使用して、この配列を再帰的なイテレータとして扱えるようにします。
22    $data = [
23        'fruits' => ['apple', 'banana', 'cherry'],
24        'vegetables' => ['carrot', 'potato'],
25        'dairy' => ['milk', 'cheese'],
26    ];
27    $arrayIterator = new RecursiveArrayIterator($data);
28
29    // 2. RecursiveCachingIterator を FULL_CACHE モードで初期化します。
30    // RecursiveCachingIterator::FULL_CACHE 定数を指定することで、
31    // イテレータ全体が一度にキャッシュされるよう設定されます。
32    $cachingIterator = new RecursiveCachingIterator(
33        $arrayIterator,
34        RecursiveCachingIterator::FULL_CACHE
35    );
36
37    echo "--- 最初のイテレーション (キャッシュが構築されます) ---\n";
38    // 最初のイテレーションでは、データソースから要素が読み込まれ、同時にキャッシュに格納されます。
39    // hasChildren() と getChildren() を使用して、再帰的な構造を処理します。
40    foreach ($cachingIterator as $key => $value) {
41        echo "要素処理中: {$key} => ";
42        if ($cachingIterator->hasChildren()) {
43            echo "子要素を持つコンテナ\n";
44            // 子イテレータを取得し、さらにイテレーション
45            foreach ($cachingIterator->getChildren() as $childKey => $childValue) {
46                echo "  子要素: {$childKey} => {$childValue}\n";
47            }
48        } else {
49            echo "{$value}\n";
50        }
51    }
52
53    echo "\n--- 2回目のイテレーション (キャッシュが利用されます) ---\n";
54    // 2回目のイテレーションでは、データソースではなく、既に構築されたキャッシュから要素が読み込まれます。
55    // これにより、元のデータソースへのアクセス負荷が軽減されます。
56    // 特にデータベースやネットワークからのデータ取得で効果を発揮します。
57    foreach ($cachingIterator as $key => $value) {
58        echo "キャッシュから再処理中: {$key} => ";
59        if ($cachingIterator->hasChildren()) {
60            echo "子要素を持つコンテナ\n";
61            foreach ($cachingIterator->getChildren() as $childKey => $childValue) {
62                echo "  子要素: {$childKey} => {$childValue}\n";
63            }
64        } else {
65            echo "{$value}\n";
66        }
67    }
68
69    echo "\n--- 「php cache クリア」に関する補足 ---\n";
70    echo "RecursiveCachingIterator にはキャッシュを直接「クリア」する専用メソッドはありません。\n";
71    echo "しかし、このキャッシュを実質的に「クリア」したい場合は、\n";
72    echo "  1. 現在の RecursiveCachingIterator オブジェクトを破棄するか、\n";
73    echo "  2. 新しいデータソース（元のデータが変更された場合など）で新しい RecursiveCachingIterator インスタンスを作成します。\n";
74    echo "これにより、古いキャッシュの内容は破棄され、次にアクセスする際に新しいデータでキャッシュが再構築されます。\n";
75
76    // 例: オブジェクトを破棄して新しいデータでキャッシュを再構築する（概念的な説明）
77    // $cachingIterator = null; // オブジェクトを破棄
78    // $newData = ['new_item' => ['item1', 'item2']];
79    // $newArrayIterator = new RecursiveArrayIterator($newData);
80    // $newCachingIterator = new RecursiveCachingIterator($newArrayIterator, RecursiveCachingIterator::FULL_CACHE);
81    // echo "\n--- 新しいキャッシュでイテレーション ---\n";
82    // foreach ($newCachingIterator as $key => $value) { /* ... */ }
83}
84
85// 関数の実行
86demonstrateRecursiveCachingIteratorFullCache();
87

RecursiveCachingIterator::FULL_CACHEは、PHPのRecursiveCachingIteratorクラスに属するint型の定数です。この定数をRecursiveCachingIteratorのコンストラクタに渡すことで、内部イテレータの全要素を一度にメモリにキャッシュするよう設定します。引数はなく、単にキャッシュモードを指定するために使用されます。

このキャッシュモードの主な目的は、元のデータソースへの繰り返しアクセスを減らし、パフォーマンスを向上させることです。FULL_CACHEが指定された場合、イテレータが最初に完全に走査された時点で、その全ての要素が内部に保持されます。これにより、2回目以降のイテレーションでは、データソースに再度アクセスすることなく、既にキャッシュされたデータが高速に利用されます。

サンプルコードでは、まずネストされた配列をRecursiveArrayIteratorでラップし、それをRecursiveCachingIterator::FULL_CACHEモードで初期化しています。最初のイテレーション時にデータが読み込まれ、その際にキャッシュが構築されます。2回目のイテレーションでは、データソースではなく、このキャッシュから要素が取得されることで、処理の効率化が図られています。

「php cache クリア」というキーワードについてですが、RecursiveCachingIteratorにはキャッシュを直接クリアする専用のメソッドは提供されていません。キャッシュを実質的にクリアするには、現在のRecursiveCachingIteratorオブジェクトを破棄し、新しいデータソースや更新されたデータソースで新しいインスタンスを作成し直す必要があります。これにより、次にイテレータにアクセスする際に、新しいデータでキャッシュが再構築されます。