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

Copy
1<?php
2
3// 1. 基となるイテレータの準備
4// 現在のディレクトリを再帰的に走査するためのイテレータを作成します。
5// このスクリプトが実行されるディレクトリとそのサブディレクトリのファイルを扱います。
6// FilesystemIterator::SKIP_DOTS フラグは、'.' と '..' エントリをスキップします。
7$directoryIterator = new RecursiveDirectoryIterator(
8    __DIR__,
9    FilesystemIterator::SKIP_DOTS
10);
11
12// RecursiveIteratorIterator は、RecursiveDirectoryIterator と組み合わせて
13// ディレクトリツリー全体を再帰的に走査するために使用されます。
14// RecursiveIteratorIterator::LEAVES_ONLY フラグは、ディレクトリ自体ではなく、ファイル（葉）のみを取得します。
15$recursiveIterator = new RecursiveIteratorIterator(
16    $directoryIterator,
17    RecursiveIteratorIterator::LEAVES_ONLY
18);
19
20// 2. RecursiveCachingIterator のインスタンス化
21// RecursiveCachingIterator は、渡されたイテレータの要素をキャッシュするイテレータです。
22// これにより、同じ要素に複数回アクセスする際のパフォーマンスが向上します。
23// __construct メソッドは、イテレータとオプションのフラグを受け取ります。
24// ここでは、上記の $recursiveIterator を渡し、フラグはデフォルト値（1、RecursiveCachingIterator::CATCH_GET_CHILD に相当）を使用します。
25// フラグを明示的に指定する場合は、RecursiveCachingIterator::CATCH_GET_CHILD などを指定できます。
26$cachingIterator = new RecursiveCachingIterator(
27    $recursiveIterator
28    // 2番目の引数 $flags はオプションで、デフォルト値は1 (RecursiveCachingIterator::CATCH_GET_CHILD) です。
29    // 例: RecursiveCachingIterator::CATCH_GET_CHILD を明示的に指定することも可能です。
30);
31
32// 3. キャッシュされたイテレータの使用例
33echo "現在のディレクトリ以下のファイル一覧 (RecursiveCachingIteratorを使用):\n";
34foreach ($cachingIterator as $fileInfo) {
35    // $fileInfo は RecursiveCachingIterator オブジェクト自身ですが、
36    // 内部的に現在の要素（SplFileInfoオブジェクト）として振る舞います。
37    // そのため、getFilename() などの SplFileInfo メソッドを直接呼び出すことができます。
38    // キャッシュ機構により、要素への複数回アクセスが最適化されます。
39    echo $fileInfo->getFilename() . "\n";
40}
41
42// 注意: このスクリプトを試すには、実行するディレクトリにいくつかのファイルやサブディレクトリが存在すると、
43// 出力結果を確認しやすくなります。
44?>

RecursiveCachingIteratorクラスの__constructメソッドは、新しいRecursiveCachingIteratorオブジェクトを初期化する際に呼び出される特殊なメソッドです。このクラスは、他のイテレータから取得した要素をキャッシュすることで、同じ要素に複数回アクセスする際の処理性能を向上させる目的で使用されます。

最初の引数$iteratorには、キャッシュの対象となるイテレータオブジェクトを渡します。サンプルコードでは、ディレクトリツリーを再帰的に走査してファイルを取得するRecursiveIteratorIteratorのインスタンスが渡されており、これによりディレクトリ内のファイル一覧を効率的に処理できます。

2番目の引数$flagsはオプションであり、キャッシュの動作を細かく制御するための整数値を指定します。デフォルト値は1で、これはRecursiveCachingIterator::CATCH_GET_CHILD定数に相当します。このメソッドはコンストラクタであるため、特定の戻り値はなく、呼び出しが成功すると初期化されたRecursiveCachingIteratorオブジェクトが生成されます。サンプルコードは、このRecursiveCachingIteratorを利用して、現在のディレクトリとそのサブディレクトリに存在するファイル名を効率的に表示する例を示しています。

Copy
1<?php
2
3/**
4 * PHPのRecursiveCachingIterator::__constructメソッドの使用例
5 * システムエンジニアを目指す初心者向けに、コンストラクタの基本的な使い方を示します。
6 */
7
8// 1. RecursiveCachingIteratorがラップする対象のイテレータを準備します。
9//    ここではSPLのArrayIteratorを例として使用します。
10$data = ['apple', 'banana', 'cherry'];
11$baseIterator = new ArrayIterator($data);
12
13echo "元のデータ: " . implode(', ', $data) . PHP_EOL;
14echo "-----------------------------------" . PHP_EOL;
15
16// 2. RecursiveCachingIteratorのインスタンスを生成します。
17//    この時、__constructメソッドが自動的に呼び出されます。
18//    引数には、先に準備したイテレータ ($baseIterator) を渡します。
19//    第2引数のフラグ ($flags) は省略可能で、デフォルト値 (1) が使用されます。
20$cachingIterator = new RecursiveCachingIterator($baseIterator);
21
22echo "RecursiveCachingIteratorのインスタンスが正常に生成されました。" . PHP_EOL;
23echo "コンストラクタを通じてArrayIteratorが内部にセットアップされました。" . PHP_EOL;
24echo "-----------------------------------" . PHP_EOL;
25
26// 3. 生成されたRecursiveCachingIteratorを使用して要素をイテレートし、動作を確認します。
27//    これはコンストラクタが正しく機能し、オブジェクトが利用可能になったことを示します。
28echo "RecursiveCachingIteratorを介した要素の走査:" . PHP_EOL;
29foreach ($cachingIterator as $key => $value) {
30    echo "  Key: " . $key . ", Value: " . $value . PHP_EOL;
31}
32
33?>

RecursiveCachingIterator::__constructメソッドは、RecursiveCachingIteratorクラスの新しいインスタンスを作成する際に自動的に呼び出される初期化用の特殊なメソッドです。このメソッドは、生成されるオブジェクトがその後に正しく機能するための準備を行います。

引数は二つあります。一つ目の$iteratorは、RecursiveCachingIteratorがその要素をキャッシュする対象となる元のイテレータを指定するために必須です。サンプルコードでは、配列を扱うArrayIteratorを準備し、これをRecursiveCachingIteratorに渡しています。これにより、RecursiveCachingIteratorは内部でこのArrayIteratorの要素を操作できるようになります。二つ目の$flagsはオプションの整数値で、キャッシュの動作に関する詳細な設定を行うフラグです。この引数を省略した場合、デフォルト値の1が適用されます。コンストラクタは新しいインスタンスを生成する役割を果たすため、明示的な戻り値はありません。

サンプルコードでは、まず文字列の配列をArrayIteratorでラップし、そのArrayIteratorを引数としてRecursiveCachingIteratorのインスタンスを生成しています。このとき、__constructメソッドが呼び出され、ArrayIteratorがRecursiveCachingIteratorの内部に適切にセットアップされます。その後、生成された$cachingIteratorオブジェクトをforeachループで走査することで、コンストラクタが正しく機能し、オブジェクトが利用可能な状態になっていることを確認できます。