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

Copy
1<?php
2
3/**
4 * CachingIterator::setFlags を使用して SplFileObject の内容をキャッシュするサンプル
5 *
6 * この関数は、SplFileObject を CachingIterator でラップし、
7 * setFlags(CachingIterator::FULL_CACHE) を設定することで、
8 * イテレーション完了後にすべての要素をキャッシュから再利用する方法を示します。
9 */
10function demonstrateCachingIteratorWithFile(): void
11{
12    // サンプル用の一時ファイルを作成
13    $filename = 'sample_log.txt';
14    $fileContent = "Line 1: First entry\n";
15    $fileContent .= "Line 2: Second entry\n";
16    $fileContent .= "Line 3: Third entry\n";
17    file_put_contents($filename, $fileContent);
18
19    try {
20        // SplFileObject でファイルを一行ずつ読み込むイテレータを作成
21        $fileObject = new SplFileObject($filename);
22        // SplFileObject を CachingIterator でラップする
23        $cachingIterator = new CachingIterator($fileObject);
24
25        // CachingIterator::FULL_CACHE フラグを設定
26        // これにより、イテレーション中にすべての要素がキャッシュされる
27        $cachingIterator->setFlags(CachingIterator::FULL_CACHE);
28
29        echo "--- 最初のイテレーション ---\n";
30        // ファイルを一行ずつ処理して表示
31        foreach ($cachingIterator as $line) {
32            echo trim($line); // trim()で改行コードを削除
33            // hasNext() で次の行があるか確認できる
34            if ($cachingIterator->hasNext()) {
35                echo " (次の行があります)\n";
36            } else {
37                echo " (最後の行です)\n";
38            }
39        }
40        echo "\n";
41
42        // setFlags(CachingIterator::FULL_CACHE) を設定したため、
43        // イテレーションが完了した後でも、キャッシュから内容を取得できる
44        if (count($cachingIterator->getCache()) > 0) {
45            echo "--- キャッシュされた内容の再利用 ---\n";
46            foreach ($cachingIterator->getCache() as $lineNumber => $line) {
47                // getCache()は連想配列を返す (キー: 0から始まるインデックス, 値: 要素)
48                printf("キャッシュ[%d]: %s\n", $lineNumber, trim($line));
49            }
50        }
51    } finally {
52        // サンプルファイルを削除
53        if (file_exists($filename)) {
54            unlink($filename);
55        }
56    }
57}
58
59// 関数を実行
60demonstrateCachingIteratorWithFile();

CachingIterator::setFlagsは、CachingIteratorオブジェクトの動作をカスタマイズするためのメソッドです。引数 $flags には、どのような挙動をさせるかを指定するための整数値を渡します。このメソッド自体に戻り値はありません。

サンプルコードでは、ファイルを一行ずつ読み込むSplFileObjectをCachingIteratorで包み込み、キャッシュ機能を追加しています。ここでsetFlagsメソッドに定数CachingIterator::FULL_CACHEを指定することで、「繰り返し処理で通過した全ての要素を内部にキャッシュ（一時保存）する」という動作モードに設定しています。

最初のforeachループでファイルの内容が読み込まれると、FULL_CACHEフラグの効果により、読み取られた全ての行がCachingIteratorオブジェクト内に保存されます。通常のイテレータは一度最後まで処理されると、再度データを取り出すことはできません。しかし、この設定により、ループが完了した後でもgetCache()メソッドを呼び出すことで、保存された全データを配列として取得し、再利用することが可能になります。