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

Copy
1<?php
2
3/**
4 * CachingIterator::getInnerIterator() メソッドの使用例
5 *
6 * このスクリプトは、CachingIterator がラップしている元のイテレータを取得する方法を示します。
7 * システムエンジニアを目指す初心者の方にも理解しやすいように、ステップごとに説明します。
8 */
9
10// 1. イテレートするデータ（配列）を用意します。
11$data = ['Apple', 'Banana', 'Cherry', 'Date'];
12
13// 2. 元のイテレータ（ArrayIterator）を作成します。
14// ArrayIterator は配列をイテレートするための標準的なPHPのイテレータです。
15$originalIterator = new ArrayIterator($data);
16
17echo "--- 元のイテレータ (" . get_class($originalIterator) . ") の内容 ---\n";
18// 元のイテレータから要素を1つずつ取得して表示します。
19foreach ($originalIterator as $key => $value) {
20    echo "Key: $key, Value: $value\n";
21}
22// イテレータは一度最後まで回すと内部ポインタが終端に移動します。
23// 再度イテレートする場合は rewind() を呼び出してポインタを先頭に戻す必要があります。
24$originalIterator->rewind();
25
26
27// 3. CachingIterator を作成し、元のイテレータをラップします。
28// CachingIterator は内部のイテレータの要素をキャッシュする機能を持っていますが、
29// ここでは getInnerIterator() の動作に焦点を当てます。
30$cachingIterator = new CachingIterator($originalIterator);
31
32echo "\n--- CachingIterator (" . get_class($cachingIterator) . ") の内容 ---\n";
33// CachingIterator も元のイテレータと同様にイテレートできます。
34foreach ($cachingIterator as $key => $value) {
35    echo "Key: $key, Value: $value\n";
36}
37
38
39// 4. CachingIterator::getInnerIterator() を呼び出し、元のイテレータを取得します。
40// このメソッドは、CachingIterator がコンストラクタで受け取った元のイテレータオブジェクトを返します。
41$retrievedInnerIterator = $cachingIterator->getInnerIterator();
42
43echo "\n--- getInnerIterator() で取得したイテレータの確認 ---\n";
44// 取得したイテレータが元のイテレータと同じオブジェクトインスタンスであるかを確認します。
45// === 演算子でオブジェクトを比較すると、同じインスタンスかどうかをチェックできます。
46if ($retrievedInnerIterator === $originalIterator) {
47    echo "getInnerIterator() で取得したイテレータは、元のイテレータと全く同じオブジェクトです。\n";
48} else {
49    echo "getInnerIterator() で取得したイテレータは、元のイテレータとは異なるオブジェクトです。\n";
50}
51
52// 取得したイテレータもイテレート可能です。
53// CachingIterator を回した後なので、内部ポインタをリセットするために rewind() を呼び出します。
54$retrievedInnerIterator->rewind();
55echo "取得したイテレータ (" . get_class($retrievedInnerIterator) . ") の内容:\n";
56foreach ($retrievedInnerIterator as $key => $value) {
57    echo "Key: $key, Value: $value\n";
58}
59
60?>

PHP 8のCachingIteratorクラスが提供するgetInnerIterator()メソッドは、CachingIteratorが内部でラップしている「元のイテレータ」を取得するために使用されます。このメソッドは引数を一切必要とせず、戻り値としてラップされている元のIteratorオブジェクトを返します。CachingIteratorは、例えば配列を扱うArrayIteratorのような別のイテレータを包み込み、そのイテレータの要素をキャッシュするなどの機能を追加する特殊なイテレータです。

サンプルコードでは、ArrayIteratorで作成した$originalIteratorをCachingIteratorでラップしています。$cachingIterator->getInnerIterator()を呼び出すと、最初にラップした$originalIteratorと完全に同じIteratorオブジェクトが取得できることが示されています。これは、getInnerIterator()が元のイテレータのインスタンスそのものを返すため、CachingIteratorを介さずに元のイテレータの固有のメソッドを呼び出したり、状態を確認したりする場合に大変役立ちます。これにより、CachingIteratorの追加機能を利用しつつ、必要に応じて元のイテレータの機能にも直接アクセスできる柔軟性が得られます。

Copy
1<?php
2
3/**
4 * PHPのジェネレータ機能を使って、シンプルな文字列のイテレータを生成します。
5 * ジェネレータはIteratorインターフェースを実装したオブジェクトを返します。
6 *
7 * @param array<string> $data イテレートする要素の配列
8 * @return Generator<string> 生成されたイテレータ
9 */
10function createSimpleStringIterator(array $data): Generator
11{
12    foreach ($data as $item) {
13        yield $item;
14    }
15}
16
17// 1. ジェネレータ関数を呼び出し、元のイテレータ (Generatorオブジェクト) を作成します。
18$originalIterator = createSimpleStringIterator(['Apple', 'Banana', 'Cherry']);
19echo "元のイテレータの型: " . get_class($originalIterator) . "\n";
20
21// 2. CachingIterator クラスを使って、元のイテレータをラップします。
22//    CachingIterator は、内部のイテレータの要素をキャッシュする機能を持つイテレータです。
23$cachingIterator = new CachingIterator($originalIterator);
24echo "CachingIterator の型: " . get_class($cachingIterator) . "\n";
25
26// 3. CachingIterator::getInnerIterator() メソッドを呼び出し、
27//    CachingIterator がラップしている「元の」イテレータを取得します。
28$retrievedInnerIterator = $cachingIterator->getInnerIterator();
29echo "getInnerIterator() で取得したイテレータの型: " . get_class($retrievedInnerIterator) . "\n\n";
30
31// 取得したイテレータが、最初に作成した元のイテレータと
32// 同じインスタンスであるかどうかを確認します。
33if ($originalIterator === $retrievedInnerIterator) {
34    echo "✔ getInnerIterator() は元のイテレータと同じインスタンスを返します。\n\n";
35} else {
36    echo "❌ getInnerIterator() は元のイテレータと異なるインスタンスを返しました。\n\n";
37}
38
39echo "--- CachingIterator をループして要素にアクセス ---\n";
40// CachingIterator をループすると、内部のイテレータから要素が取得されます。
41// この時点で $originalIterator の要素も消費されていきます。
42foreach ($cachingIterator as $key => $value) {
43    echo "CachingIterator: キー=" . $key . ", 値=" . $value . "\n";
44}
45echo "--------------------------------------------------\n\n";
46
47echo "--- getInnerIterator() で取得したイテレータをループ ---\n";
48// CachingIterator をループしたため、$originalIterator (および $retrievedInnerIterator) は終端に達しています。
49// そのため、このループでは何も出力されません。これはイテレータが一度消費されると終端に達する特性のためです。
50foreach ($retrievedInnerIterator as $key => $value) {
51    echo "RetrievedIterator: キー=" . $key . ", 値=" . $value . "\n";
52}
53echo "上記ループは何も出力されませんでした。\n\n";
54
55// イテレータを巻き戻す (rewind) ことで、再度最初から要素にアクセスできるようになります。
56echo "--- CachingIterator を巻き戻して (rewind) 再度ループ ---\n";
57$cachingIterator->rewind(); // CachingIterator を巻き戻すと、内部のイテレータも巻き戻されます。
58foreach ($cachingIterator as $key => $value) {
59    echo "Rewound CachingIterator: キー=" . $key . ", 値=" . $value . "\n";
60}
61echo "----------------------------------------------------------\n";
62

PHPのCachingIterator::getInnerIterator()メソッドは、イテレータをラップしてキャッシュ機能を提供するCachingIteratorクラスが、その内部に保持している「元の」イテレータを取得するために使われます。このメソッドは引数を必要とせず、戻り値としてIteratorインターフェースを実装したオブジェクト、つまりラップされている元のイテレータのインスタンスそのものを返します。

サンプルコードでは、まずPHPのジェネレータ機能を利用して、文字列の要素を一つずつ生成するシンプルなGenerator（イテレータの一種）を作成しています。次に、この元のイテレータをCachingIteratorでラップします。CachingIteratorは、内部のイテレータの要素をキャッシュする機能を持つ、特別なイテレータです。

getInnerIterator()メソッドを呼び出すことで、CachingIteratorが管理している元のイテレータのインスタンスを直接取得できます。これは、最初に作成したGeneratorのインスタンスと完全に同一であることが確認できます。

イテレータは、一度要素を全て消費すると終端に達するという特性があります。CachingIteratorをループして要素を取り出すと、その内部の元のイテレータも同時に消費されて終端に達します。そのため、getInnerIterator()で取得したイテレータをその後ループしても、既に終端であるため何も出力されません。しかし、CachingIterator::rewind()メソッドを呼び出すと、内部のイテレータも巻き戻され、再度最初から要素にアクセスできるようになります。このようにgetInnerIterator()は、ラップされた元のイテレータに直接アクセスする手段を提供し、イテレータの柔軟な操作を可能にします。