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

Copy
1<?php
2
3// 1. サンプルとして、ネストされた配列を作成します。
4//    この配列の「葉」（非配列）要素の数を数えます。
5$data = [
6    'Apple',
7    'Banana',
8    [ // ネストされた配列
9        'Orange',
10        'Grape',
11    ],
12    'Mango',
13];
14
15// 2. RecursiveArrayIterator を使って、配列を再帰的なイテレータに変換します。
16$arrayIterator = new RecursiveArrayIterator($data);
17
18// 3. RecursiveIteratorIterator を使って、ネストされた要素も含めてフラットに走査できるようにします。
19//    RecursiveIteratorIterator::LEAVES_ONLY は、最終的な「葉」（非配列）の要素のみを返すモードです。
20//    この例では、'Apple', 'Banana', 'Orange', 'Grape', 'Mango' の5つの要素が対象となります。
21$recursiveIterator = new RecursiveIteratorIterator($arrayIterator, RecursiveIteratorIterator::LEAVES_ONLY);
22
23// 4. RecursiveCachingIterator で上記のイテレータをラップします。
24//    このクラスは内部イテレータの要素をキャッシュし、Countable インターフェースを実装しています。
25//    これにより、イテレータを複数回走査する際のパフォーマンスが向上し、
26//    count() メソッドやグローバルな count() 関数が利用可能になります。
27$cachingIterator = new RecursiveCachingIterator($recursiveIterator);
28
29// 5. RecursiveCachingIterator::count() メソッドを使用して要素数を取得します。
30//    このメソッドはキャッシュされた要素の数を返します。
31//    正確な数を取得するためには、事前にイテレータがキャッシュを構築している必要があります。
32//    一般的に、rewind() を呼び出すことで内部のイテレータが走査され、キャッシュが構築されます。
33$cachingIterator->rewind(); // イテレータを巻き戻し、キャッシュを構築します。
34
35echo "要素の数 (RecursiveCachingIterator::count()): " . $cachingIterator->count() . "\n";
36
37// 6. PHPのグローバルな count() 関数も利用できます。
38//    RecursiveCachingIterator は Countable インターフェースを実装しているため、
39//    オブジェクトを直接 count() 関数に渡すことができます。
40echo "要素の数 (グローバル count() 関数): " . count($cachingIterator) . "\n";
41

PHP 8のRecursiveCachingIteratorクラスに定義されているcount()メソッドは、引数なしで、イテレータが内部でキャッシュしている要素の総数をint型で返します。このクラスは、複数のイテレータを結合したり、ネストされた構造を走査したりする際に、要素を効率的にキャッシュするために使われます。RecursiveCachingIteratorはPHPのCountableインターフェースを実装しているため、オブジェクト自体にcount()メソッドが用意されているほか、PHPのグローバルなcount()関数に直接渡して要素数を取得することもできます。これにより、イテレータを複数回走査する際のパフォーマンス向上が期待できます。

サンプルコードでは、ネストされた配列の非配列要素（葉要素）のみを対象とし、RecursiveArrayIteratorとRecursiveIteratorIteratorを組み合わせてフラットなイテレータを作成し、それをRecursiveCachingIteratorでラップしています。count()メソッドを正確に利用するためには、事前にrewind()メソッドを呼び出してイテレータを巻き戻し、キャッシュが構築されている必要があります。これにより、キャッシュされた要素の総数が返され、この例では「Apple」「Banana」「Orange」「Grape」「Mango」の5つの要素が正しく数えられます。

Copy
1<?php
2
3/**
4 * RecursiveCachingIterator::count() メソッドの動作を示すサンプル関数です。
5 *
6 * この関数は、システムエンジニアを目指す初心者の方向けに、
7 * RecursiveCachingIterator がイテレータ内の要素数をどのように数えるかを、
8 * 特に null 値を含む場合やイテレータが空の場合に焦点を当てて示します。
9 */
10function demonstrateRecursiveCachingIteratorCountBehavior(): void
11{
12    echo "--- RecursiveCachingIterator::count() のデモンストレーション ---\n\n";
13
14    // ケース1: 通常の要素を含むイテレータ
15    // 配列 ['apple', 'banana', 'cherry'] を使ってイテレータを作成します。
16    $data1 = ['apple', 'banana', 'cherry'];
17    echo "ケース1: 通常の要素を含むイテレータ\n";
18    echo "元の配列: ['apple', 'banana', 'cherry']\n";
19
20    // RecursiveArrayIterator を使って配列を再帰的なイテレータに変換します。
21    $arrayIterator1 = new RecursiveArrayIterator($data1);
22
23    // RecursiveCachingIterator でラップすることで、内部イテレータの要素をキャッシュし、
24    // 繰り返し処理の効率化や、count() メソッドの利用が可能になります。
25    $cachingIterator1 = new RecursiveCachingIterator($arrayIterator1);
26
27    // count() メソッドは、イテレータ内の現在の要素数（ここでは3）を整数値で返します。
28    echo "RecursiveCachingIterator::count() の結果: " . $cachingIterator1->count() . "\n\n";
29
30
31    // ケース2: null 値を含むイテレータ
32    // 配列 ['red', null, 'blue'] を使ってイテレータを作成します。
33    $data2 = ['red', null, 'blue'];
34    echo "ケース2: null 値を含むイテレータ\n";
35    echo "元の配列: ['red', null, 'blue']\n";
36
37    $arrayIterator2 = new RecursiveArrayIterator($data2);
38    $cachingIterator2 = new RecursiveCachingIterator($arrayIterator2);
39
40    // RecursiveCachingIterator::count() は、null も1つの有効な要素として数えます。
41    // そのため、このイテレータの要素数は3となります。
42    echo "RecursiveCachingIterator::count() の結果: " . $cachingIterator2->count() . "\n\n";
43
44
45    // ケース3: 空のイテレータ
46    // 空の配列 [] を使ってイテレータを作成します。
47    $data3 = [];
48    echo "ケース3: 空のイテレータ\n";
49    echo "元の配列: []\n";
50
51    $arrayIterator3 = new RecursiveArrayIterator($data3);
52    $cachingIterator3 = new RecursiveCachingIterator($arrayIterator3);
53
54    // イテレータが空の場合、count() メソッドは 0 を返します。
55    // これは、PHP の一般的な count() 関数が null や空の配列に対して 0 を返す挙動と似ており、
56    // 「要素がない」状態を明確に示します。
57    echo "RecursiveCachingIterator::count() の結果: " . $cachingIterator3->count() . "\n\n";
58}
59
60// 上記のサンプル関数を実行します。
61demonstrateRecursiveCachingIteratorCountBehavior();
62

RecursiveCachingIterator::count()メソッドは、PHP 8で提供される拡張機能の一部で、RecursiveCachingIteratorオブジェクトが内部にキャッシュしている要素の総数を整数値で返す機能を提供します。このメソッドは引数を取りません。

このサンプルコードは、RecursiveCachingIterator::count()の挙動を3つの異なるシナリオで示しています。最初のケースでは、['apple', 'banana', 'cherry']のように通常のデータを持つイテレータを作成し、count()メソッドを呼び出すと、要素の総数である3が返されます。

次に、キーワードであるnull値を含むイテレータ['red', null, 'blue']の場合を見てみましょう。RecursiveCachingIterator::count()は、nullも1つの有効な要素として認識し数え上げます。そのため、このイテレータに対しても要素数として3が返されます。これは、nullが単なる「値がない」状態ではなく、特定のインデックスを占める「要素」として扱われることを示しています。

最後のケースとして、空の配列[]から作成されたイテレータでは、要素が一つも存在しないため、count()メソッドは0を返します。

このように、RecursiveCachingIterator::count()はイテレータ内の要素数を正確に取得するためのシンプルな方法を提供し、特にnull値も要素としてカウントする点が特徴です。

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つ）が出力されます。この機能は、特定のコレクションやファイルシステムの要素数を効率的に把握したい場合に大変便利です。