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

Copy
1<?php
2
3/**
4 * OuterIterator::key() メソッドの使用例を示します。
5 *
6 * OuterIterator は、他のイテレータ（内部イテレータ）をラップするためのインターフェースです。
7 * key() メソッドは、ラップしている内部イテレータの現在の要素のキーを返します。
8 */
9function demonstrateOuterIteratorKey(): void
10{
11    // 1. 内部イテレータとして使用するデータを準備します。
12    //    キーと値のペアを持つ連想配列を使います。
13    $data = [
14        'product_id_A' => 100,
15        'product_id_B' => 150,
16        'product_id_C' => 120,
17    ];
18
19    // 2. ArrayIterator を作成します。これが OuterIterator にラップされる「内部イテレータ」です。
20    //    ArrayIterator は、配列を反復処理するための標準的なイテレータです。
21    $innerIterator = new ArrayIterator($data);
22
23    // 3. IteratorIterator を作成し、$innerIterator をラップします。
24    //    IteratorIterator は OuterIterator インターフェースを実装する具体的なクラスの一つです。
25    //    これにより、外部から $innerIterator の要素にアクセスできるようになります。
26    $outerIterator = new IteratorIterator($innerIterator);
27
28    echo "OuterIterator::key() を使ったデータ反復処理:\n";
29    echo "-------------------------------------------\n";
30
31    // 4. foreach ループを使って OuterIterator を反復処理します。
32    //    ループ内で OuterIterator::key() と OuterIterator::current() を明示的に呼び出し、
33    //    現在の要素のキーと値を取得します。
34    foreach ($outerIterator as $value) {
35        // OuterIterator::key() を呼び出して、現在の要素のキーを取得します。
36        $key = $outerIterator->key();
37        
38        // OuterIterator::current() を呼び出して、現在の要素の値を取得します。
39        // （foreach ($outerIterator as $value) の $value と同じ値です。）
40        $currentValue = $outerIterator->current();
41
42        echo "現在の要素のキー (Key): '$key', 値 (Value): $currentValue\n";
43    }
44    echo "-------------------------------------------\n";
45    echo "全ての要素の反復処理が完了しました。\n";
46}
47
48// サンプル関数を実行します。
49demonstrateOuterIteratorKey();
50

OuterIterator::key()は、PHP 8で提供されるOuterIteratorインターフェースが定義するメソッドです。OuterIteratorは、他のイテレータ（内部イテレータ）をラップし、その内部イテレータが持つ要素に外部からアクセスできるようにするための仕組みを提供します。このkey()メソッドは引数を一切取らず、ラップしている内部イテレータが現在指し示している要素の「キー」を返します。戻り値の型はmixedであり、キーが文字列や整数など、様々なデータ型で表現される可能性があることを意味します。

サンプルコードでは、連想配列をArrayIteratorでラップしたものを内部イテレータとして準備しています。次に、IteratorIteratorを用いてこのArrayIteratorをさらにラップし、OuterIteratorの実装としています。foreachループを使って外部イテレータを反復処理する際、ループ内で$outerIterator->key()を呼び出すことにより、現在処理中の要素のキー（例えば 'product_id_A' など）を正確に取得し、表示しています。これにより、イテレータを通してデータ構造を順にたどりながら、各要素の「キー」と「値」のペアを容易に識別し、活用することが可能になります。

Copy
1<?php
2
3/**
4 * OuterIterator::key() メソッドを使用して、イテレータの現在のキーを取得するサンプル。
5 *
6 * OuterIterator は内部イテレータをラップし、そのイテレーションを外部から制御・参照するインターフェースです。
7 * IteratorIterator クラスは OuterIterator インターフェースを実装する最も一般的なクラスの一つです。
8 */
9
10// 1. 内部イテレータとして ArrayIterator を作成
11//    これは、キーと値のペアを持つ配列をイテレートするためのものです。
12$data = [
13    'fruit_a' => 'Apple',
14    'fruit_b' => 'Banana',
15    0 => 'Orange', // 意図的に整数キーを混ぜる
16    'fruit_c' => 'Grape',
17];
18$innerIterator = new ArrayIterator($data);
19
20// 2. OuterIterator インターフェースを実装する IteratorIterator で内部イテレータをラップ
21//    これにより、innerIterator の要素に OuterIterator を通じてアクセスできます。
22$outerIterator = new IteratorIterator($innerIterator);
23
24echo "OuterIterator を利用して現在のキーを取得する例:\n";
25echo "--------------------------------------------------\n";
26
27// 3. OuterIterator をループし、各要素のキーと値、および OuterIterator::key() で取得したキーを表示
28foreach ($outerIterator as $key => $value) {
29    // foreach ループで取得される $key は、OuterIterator がラップしている
30    // 内部イテレータの現在のキーに相当します。
31    echo "  foreach キー: '" . $key . "', ";
32    echo "値: '" . $value . "', ";
33
34    // OuterIterator::key() メソッドは、ラップしている内部イテレータの
35    // 現在の要素のキーを返します。
36    echo "OuterIterator::key(): '" . $outerIterator->key() . "'\n";
37}
38
39echo "--------------------------------------------------\n";
40
41?>

このサンプルコードは、PHPのOuterIterator::key()メソッドを使用して、イテレータの現在のキーを取得する方法を示しています。OuterIteratorは、別のイテレータ（内部イテレータ）をラップし、そのイテレーションを外部から制御したり、現在の状態を参照したりするためのインターフェースです。IteratorIteratorクラスは、このOuterIteratorインターフェースを実装する代表的なクラスの一つです。

OuterIterator::key()メソッドは、引数を受け取らず、ラップしている内部イテレータの現在の要素のキーを返します。戻り値の型はmixedで、キーが文字列でも整数でも対応できることを意味します。

コードではまず、キーと値のペアを持つ配列を扱うArrayIteratorを内部イテレータとして用意しています。次に、このArrayIteratorをIteratorIteratorでラップし、outerIteratorというOuterIteratorインスタンスを作成しています。foreachループでouterIteratorを処理する際、ループ内で$keyとして取得される値と、$outerIterator->key()メソッドを呼び出して取得される値が同じであることが確認できます。これにより、OuterIterator::key()メソッドが、ラップされた内部イテレータの現在のキーを正確に提供していることがわかります。このメソッドは、イテレータの現在の位置に関する情報をプログラムで取得する際に利用されます。