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

Copy
1<?php
2
3/**
4 * IteratorIterator::getInnerIterator() の使用例を示します。
5 *
6 * IteratorIterator は、他のイテレータ (内部イテレータ) をラップし、
7 * その上で独自の処理を追加するためのイテレータです。
8 * getInnerIterator() メソッドは、ラップしている元の内部イテレータを取得するために使用します。
9 */
10
11// 1. まず、内部イテレータとして ArrayIterator を作成します。
12//    これは反復処理したいデータを持つイテレータです。
13$data = ['Apple', 'Banana', 'Cherry', 'Date'];
14$originalInnerIterator = new ArrayIterator($data);
15
16echo "--- 元の内部イテレータの内容 ---" . PHP_EOL;
17foreach ($originalInnerIterator as $key => $value) {
18    echo "Key: " . $key . ", Value: " . $value . PHP_EOL;
19}
20echo PHP_EOL;
21
22// 2. 次に、作成した ArrayIterator を IteratorIterator でラップします。
23//    IteratorIterator は、元のイテレータの機能を維持しつつ、
24//    必要に応じてその動作を変更できる柔軟性を提供します。
25$wrappedIterator = new IteratorIterator($originalInnerIterator);
26
27echo "--- IteratorIterator を介したアクセス ---" . PHP_EOL;
28foreach ($wrappedIterator as $key => $value) {
29    echo "Key: " . $key . ", Value: " . $value . PHP_EOL;
30}
31echo PHP_EOL;
32
33// 3. getInnerIterator() メソッドを呼び出して、
34//    IteratorIterator がラップしている元の内部イテレータを取得します。
35$retrievedInnerIterator = $wrappedIterator->getInnerIterator();
36
37echo "--- getInnerIterator() で取得したイテレータの内容 ---" . PHP_EOL;
38foreach ($retrievedInnerIterator as $key => $value) {
39    echo "Key: " . $key . ", Value: " . $value . PHP_EOL;
40}
41echo PHP_EOL;
42
43// 4. 取得したイテレータが元のイテレータと同一のオブジェクトであることを確認します。
44if ($retrievedInnerIterator === $originalInnerIterator) {
45    echo "成功: getInnerIterator() で取得したイテレータは、元の内部イテレータと同一です。" . PHP_EOL;
46} else {
47    echo "失敗: getInnerIterator() で取得したイテレータは、元の内部イテレータと同一ではありません。" . PHP_EOL;
48}
49
50?>

PHPのIteratorIteratorは、他のイテレータ（内部イテレータと呼びます）をラップ（包み込む）し、その上で追加の処理を加えたり、イテレータの動作をカスタマイズしたりできる便利なクラスです。

getInnerIterator()メソッドは、このIteratorIteratorが内部に保持している、最初にラップした元のイテレータオブジェクトを取得するために使用されます。このメソッドは引数を一切取らず、戻り値としてラップされているIteratorオブジェクトを返します。

サンプルコードでは、まずArrayIteratorを使って配列データ（'Apple'など）を反復処理するための「元の内部イテレータ」を作成しています。次に、このArrayIteratorをIteratorIteratorで「ラップ」し、$wrappedIteratorとしています。$wrappedIteratorも元のデータと同じように反復処理が可能です。

その後、$wrappedIterator->getInnerIterator()を呼び出すことで、ラップされていた元のArrayIteratorが正確に取り出され、$retrievedInnerIteratorに代入されています。コードの最後では、取得した$retrievedInnerIteratorが、最初に作成した$originalInnerIteratorと全く同じオブジェクトであるかを厳密に比較し、同一であることを確認しています。

このメソッドは、IteratorIteratorを介してイテレータを扱っている場合でも、元のイテレータの特定の機能に直接アクセスしたり、状態を確認したりしたい場合に非常に役立ちます。

Copy
1<?php
2
3/**
4 * simpleGenerator 関数は、簡単なイテレータ（ジェネレータ）を生成します。
5 * これは IteratorIterator がラップする「内部イテレータ」として使用されます。
6 */
7function simpleGenerator(): Generator
8{
9    for ($i = 0; $i < 3; $i++) {
10        yield "データ-" . $i;
11    }
12}
13
14// 1. ジェネレータ（イテレータの一種）を作成します。
15$originalGenerator = simpleGenerator();
16
17echo "--- IteratorIterator を使用してジェネレータをラップし、反復処理します ---" . PHP_EOL;
18
19// 2. IteratorIterator は、別のイテレータをラップし、そのイテレータの機能を提供します。
20//    これにより、元のイテレータにさらなる操作（フィルタリングなど）を追加できます。
21$wrappedIterator = new IteratorIterator($originalGenerator);
22
23// 3. ラップされたイテレータを `foreach` ループで反復処理します。
24foreach ($wrappedIterator as $key => $value) {
25    echo "キー: " . $key . ", 値: " . $value . PHP_EOL;
26}
27
28echo PHP_EOL;
29
30echo "--- getInnerIterator() でラップされている元のイテレータを取得します ---" . PHP_EOL;
31
32// 4. getInnerIterator() メソッドは、IteratorIterator が内部でラップしている
33//    元のイテレータ（ここでは $originalGenerator）を返します。
34$innerIterator = $wrappedIterator->getInnerIterator();
35
36// 5. 取得した内部イテレータがどのようなものか確認します。
37echo "取得した内部イテレータのクラス名: " . get_class($innerIterator) . PHP_EOL;
38
39// ジェネレータは一度反復処理されると完了状態になるため、ここで再度 `$innerIterator` を
40// ループしてもデータは取得できません。ここではオブジェクトの型確認が目的です。
41if ($innerIterator instanceof Generator) {
42    echo "これは Generator オブジェクトです。ラップ元のオブジェクトと型が一致します。" . PHP_EOL;
43}
44?>

PHPのIteratorIterator::getInnerIterator()メソッドは、他のイテレータを「ラップ」（包み込んで装飾・拡張）して機能を提供するIteratorIteratorオブジェクトから、内部に保持されている元のイテレータを取り出すために使用されます。

このサンプルコードでは、まずsimpleGenerator関数で簡単なジェネレータ（イテレータの一種）を作成し、これを$originalGeneratorとしています。次に、この$originalGeneratorをIteratorIteratorでラップし、$wrappedIteratorというオブジェクトを作成しています。IteratorIteratorは、このように既存のイテレータの機能を保ちつつ、追加の処理を挟み込みたい場合に便利です。

その後、$wrappedIteratorのgetInnerIterator()メソッドを呼び出すことで、引数なしで、ラップされる前の$originalGeneratorオブジェクトを再び取得しています。このメソッドは戻り値としてIteratorインターフェースを実装したオブジェクトを返します。サンプルコードでは、取得した内部イテレータのクラス名が元のGenerator型と一致することを確認しており、IteratorIteratorが元のイテレータの参照を保持していることがわかります。この機能は、ラップされたイテレータの内部構造を検査したり、元のイテレータに直接アクセスする必要がある場合に役立ちます。