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

Copy
1<?php
2
3/**
4 * AppendIterator::getIteratorIndex() の使用例を示す関数。
5 * AppendIterator は複数のイテレータを連結し、単一のイテレータとして扱えるようにします。
6 * getIteratorIndex() メソッドは、現在イテレートしている元のイテレータのインデックスを返します。
7 */
8function demonstrateAppendIteratorGetIteratorIndex(): void
9{
10    echo "--- AppendIterator::getIteratorIndex() のデモンストレーション ---" . PHP_EOL;
11
12    // 1. 複数の ArrayIterator を作成
13    // これらのイテレータを AppendIterator に追加します。
14    $fruitsIterator = new ArrayIterator(['apple', 'banana', 'cherry']);
15    echo "  - 最初のイテレータ (インデックス 0): " . implode(', ', $fruitsIterator->getArrayCopy()) . PHP_EOL;
16
17    $vegetablesIterator = new ArrayIterator(['carrot', 'daikon']);
18    echo "  - 2番目のイテレータ (インデックス 1): " . implode(', ', $vegetablesIterator->getArrayCopy()) . PHP_EOL;
19
20    $numbersIterator = new ArrayIterator([10, 20]);
21    echo "  - 3番目のイテレータ (インデックス 2): " . implode(', ', $numbersIterator->getArrayCopy()) . PHP_EOL;
22
23    echo PHP_EOL;
24
25    // 2. AppendIterator のインスタンスを作成
26    $appendIterator = new AppendIterator();
27
28    // 3. 各イテレータを AppendIterator に追加
29    // 追加された順序がインデックスになります (0, 1, 2...)
30    $appendIterator->append($fruitsIterator);
31    $appendIterator->append($vegetablesIterator);
32    $appendIterator->append($numbersIterator);
33
34    echo "AppendIterator をループして要素と現在のイテレータインデックスを表示:" . PHP_EOL;
35
36    // 4. AppendIterator をループ処理
37    foreach ($appendIterator as $key => $value) {
38        // getIteratorIndex() を呼び出し、現在イテレートしている元のイテレータのインデックスを取得
39        $iteratorIndex = $appendIterator->getIteratorIndex();
40
41        echo sprintf(
42            "  要素: '%s' (キー: '%s'), 現在のイテレータインデックス: %d%s",
43            $value,
44            $key,
45            $iteratorIndex,
46            PHP_EOL
47        );
48    }
49
50    echo PHP_EOL;
51    echo "--- デモンストレーション終了 ---" . PHP_EOL;
52}
53
54// 関数の実行
55demonstrateAppendIteratorGetIteratorIndex();
56
57?>

PHP 8のAppendIterator::getIteratorIndex()メソッドは、複数のイテレータを一つに連結して順に処理できるAppendIteratorクラスにおいて、現在イテレートしている要素がどの元のイテレータに属しているかを示すインデックスを取得するために利用されます。このメソッドは引数を取りません。

AppendIteratorは、例えば複数のデータソース（異なるリストなど）をまとめて一つの流れとして扱いたい場合に非常に便利です。getIteratorIndex()メソッドは、AppendIteratorにイテレータを追加した順序（0から始まる整数）をインデックスとして返します。これにより、ループ処理中に現在どの元のイテレータのデータにアクセスしているのかを簡単に識別できます。

戻り値は整数（int）型で、対応するイテレータのインデックスを返しますが、もし現在のイテレータが存在しない場合や、AppendIteratorがまだ初期化されていない場合はnullが返されます。

提供されたサンプルコードでは、フルーツ、野菜、数字の3つのArrayIteratorを作成し、これらをAppendIteratorに追加しています。その後、AppendIteratorをループ処理しながらgetIteratorIndex()を呼び出すことで、各要素がどの元のリスト（例えば、フルーツはインデックス0、野菜はインデックス1など）に属しているかを具体的に表示しています。この機能は、複数のデータセットを統合して扱う際に、元の出所を把握したい場面で特に役立ちます。

Copy
1<?php
2
3/**
4 * AppendIterator を使用して複数のイテレータを結合し、
5 * getIteratorIndex メソッドの動作を確認するサンプルコードです。
6 *
7 * AppendIterator は、複数のイテレータ（例: ArrayIterator）を一つに連結し、
8 * それらをあたかも一つの大きなコレクションであるかのように順次処理できるようにします。
9 * これは、異なるデータソースを「集約」して、単一の反復可能なインターフェースとして
10 * 扱いたい場合に特に有用です。この「集約」の概念が、IteratorAggregate インターフェースの
11 * 目的と共通しています。
12 *
13 * getIteratorIndex() メソッドは、現在反復処理されているイテレータが、
14 * AppendIterator に何番目に追加されたイテレータであるかを示すインデックスを返します。
15 * (0から始まるインデックス)。
16 */
17
18// 1. 最初のデータセットとその ArrayIterator を準備します
19$dataCustomers = ['Alice', 'Bob', 'Charlie'];
20$iteratorCustomers = new ArrayIterator($dataCustomers);
21
22// 2. 2番目のデータセットとその ArrayIterator を準備します
23$dataProducts = ['Laptop', 'Mouse', 'Keyboard'];
24$iteratorProducts = new ArrayIterator($dataProducts);
25
26// 3. 3番目のデータセットとその ArrayIterator を準備します
27$dataOrders = ['Order_001', 'Order_002'];
28$iteratorOrders = new ArrayIterator($dataOrders);
29
30// AppendIterator のインスタンスを作成します
31$combinedIterator = new AppendIterator();
32
33// AppendIterator にイテレータを追加します。追加された順にインデックスが割り当てられます。
34// このインデックスは getIteratorIndex() で取得できます。
35$combinedIterator->append($iteratorCustomers); // インデックス 0
36$combinedIterator->append($iteratorProducts); // インデックス 1
37$combinedIterator->append($iteratorOrders);    // インデックス 2
38
39echo "=== AppendIterator による結合されたデータの反復処理 ===\n";
40echo "複数のデータソース（顧客、製品、注文）を結合して処理します。\n\n";
41
42// AppendIterator を foreach ループで反復処理します。
43// ループ中、getIteratorIndex() を呼び出すことで、
44// 現在の要素がどの元のイテレータから来ているかを確認できます。
45foreach ($combinedIterator as $key => $value) {
46    // getIteratorIndex() は、現在反復処理中のイテレータのインデックスを返します。
47    // PHP 8 では int|null を返しますが、AppendIterator のループ内では常に int が返されます。
48    $currentIndex = $combinedIterator->getIteratorIndex();
49
50    echo "インデックス: {$currentIndex}, 要素: {$value}\n";
51}
52
53echo "\n=== 処理完了 ===\n";
54
55?>

AppendIteratorは、複数の異なるデータ源（イテレータ）を一つにまとめ、あたかも単一の大きなリストであるかのように順次処理するためのPHPの機能です。getIteratorIndex()メソッドは、この結合されたデータの中から現在処理している要素が、元々「何番目に追加されたイテレータ」から取得されたものかを示すインデックス（0から始まる整数）を返します。このメソッドは引数を取りません。

このサンプルコードでは、顧客データ、製品データ、注文データという3つの独立したデータセットをそれぞれArrayIteratorとして準備しています。これらをAppendIteratorにappend()メソッドを使って追加することで、順序を保ちながら一つのデータストリームとして扱えるようになります。例えば、顧客データは0番目、製品データは1番目、注文データは2番目のイテレータとして追加されます。

foreachループで結合されたデータを反復処理する際、getIteratorIndex()を呼び出すことで、現在取り出している要素が、追加したどの元のイテレータに属しているかを把握できます。これにより、複数の異なる種類のデータが混在していても、それぞれがどのデータ源に由来するかを識別しながら処理を進めることが可能になります。getIteratorIndex()は、異なるデータソースを統合して扱う際に、現在のコンテキストを識別するための重要な情報を提供します。