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

Copy
1<?php
2
3/**
4 * MultipleIterator::setFlags() の使用例
5 *
6 * この関数は、MultipleIterator を使用して複数のイテレータ（ここではSPLFileObject）を
7 * 組み合わせて反復処理する方法を示し、setFlags メソッドで振る舞いを変更します。
8 *
9 * MIT_NEED_ALL フラグを設定することで、アタッチされたすべてのイテレータが有効である間のみ、
10 * MultipleIterator の反復処理が続行されるようになります。
11 * 1つでもイテレータが終端に達すると、反復は終了します。
12 *
13 * @return void
14 */
15function demonstrateMultipleIteratorSetFlags(): void
16{
17    // テスト用の複数の一時ファイルを作成
18    $file1 = 'temp_file_mi_1.txt';
19    $file2 = 'temp_file_mi_2.txt';
20
21    file_put_contents($file1, "First line\nSecond line\nThird line\n"); // 3行
22    file_put_contents($file2, "Line A\nLine B\n");                      // 2行 (file1 より短い)
23
24    echo "--- MultipleIterator::setFlags(MultipleIterator::MIT_NEED_ALL) のデモンストレーション ---\n\n";
25
26    try {
27        // MultipleIterator をインスタンス化
28        $multiIterator = new MultipleIterator();
29
30        // setFlags() メソッドでフラグを設定
31        // ここでは MIT_NEED_ALL を設定し、すべてのイテレータが有効である場合にのみ反復を続けます。
32        // デフォルトでは、どれか1つでも有効なら反復を続けますが、このフラグで挙動が変わります。
33        $multiIterator->setFlags(MultipleIterator::MIT_NEED_ALL);
34
35        // SPLFileObject を使用してファイルイテレータを作成し、MultipleIterator にアタッチ
36        // SPLFileObject::setFlags() も使用してファイルの読み込み方法を設定します。
37        $splFileObject1 = new SPLFileObject($file1, 'r');
38        $splFileObject1->setFlags(
39            SPLFileObject::READ_AHEAD |     // 先読みを有効にする
40            SPLFileObject::SKIP_EMPTY |     // 空行をスキップする
41            SPLFileObject::DROP_NEW_LINE    // 各行の末尾の改行文字を削除する
42        );
43        $multiIterator->attachIterator($splFileObject1, 'file1'); // 'file1' はイテレータのキー名
44
45        $splFileObject2 = new SPLFileObject($file2, 'r');
46        $splFileObject2->setFlags(
47            SPLFileObject::READ_AHEAD |
48            SPLFileObject::SKIP_EMPTY |
49            SPLFileObject::DROP_NEW_LINE
50        );
51        $multiIterator->attachIterator($splFileObject2, 'file2'); // 'file2' はイテレータのキー名
52
53        echo "MultipleIterator::MIT_NEED_ALL フラグが設定されています。\n";
54        echo "すべてのイテレータが次の要素を持つ間のみループが続行されます。\n";
55        echo "file1 は3行、file2 は2行なので、ループは2回で終了するはずです。\n\n";
56
57        $iterationCount = 0;
58        foreach ($multiIterator as $key => $value) {
59            $iterationCount++;
60            echo "反復 {$iterationCount}:\n";
61            // $value はアタッチされた各イテレータの現在の要素を含む配列になります。
62            // キーは attachIterator() で指定したキー名（例: 'file1', 'file2'）です。
63            foreach ($value as $iteratorKey => $iteratorValue) {
64                echo "  {$iteratorKey}: '{$iteratorValue}'\n";
65            }
66            echo "\n";
67        }
68
69        echo "ループが終了しました。すべてのイテレータが有効でなくなったためです。\n";
70        echo "(file2.txt が先に終端に達したため、ループは {$iterationCount} 回で終了しました。)\n\n";
71
72    } catch (Exception $e) {
73        echo "エラーが発生しました: " . $e->getMessage() . "\n";
74    } finally {
75        // 後処理: 作成した一時ファイルを削除
76        if (file_exists($file1)) {
77            unlink($file1);
78        }
79        if (file_exists($file2)) {
80            unlink($file2);
81        }
82        echo "一時ファイルを削除しました。\n";
83    }
84}
85
86// 関数を実行
87demonstrateMultipleIteratorSetFlags();

PHP 8におけるMultipleIteratorクラスは、複数のイテレータを組み合わせて、それらを同時に反復処理するための機能を提供します。このクラスのsetFlags()メソッドは、そのMultipleIteratorがどのように反復処理を進めるかという振る舞いを制御するために使用されます。

setFlags()メソッドはint $flagsという整数値の引数を受け取ります。この引数に指定するフラグによって、MultipleIteratorの挙動が変化します。このメソッドは戻り値を返しません。

サンプルコードでは、2つのファイルを読み込むSPLFileObject（ファイルを1行ずつ読み込むイテレータ）をMultipleIteratorに結合し、setFlags()でMultipleIterator::MIT_NEED_ALLフラグを設定しています。このフラグを設定すると、MultipleIteratorにアタッチされたすべてのイテレータ（つまり両方のファイル）が次の要素を持っている間だけ、反復処理が継続されるようになります。そのため、異なる行数のファイルを読み込む際、短い方のファイルが終端に達した時点で全体のループが終了します。

なお、サンプルコードにはSPLFileObject::setFlags()も登場しますが、こちらは個々のファイルの読み込み方（例：改行文字を削除する、空行をスキップする）を設定するもので、MultipleIterator::setFlags()とは異なる目的で使用されています。このようにMultipleIterator::setFlags()を用いることで、複数のデータソースを連携させながら、反復処理の条件を詳細に制御できるようになります。