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

Copy
1<?php
2
3/**
4 * 1から3までの数値を生成するジェネレータ関数。
5 * ジェネレータは通常、一度しかイテレートできません（巻き戻し不可）。
6 *
7 * @return Generator
8 */
9function createNumberGenerator(): Generator
10{
11    echo "ジェネレータが開始されました。\n";
12    for ($i = 1; $i <= 3; $i++) {
13        // yieldキーワードで値を一つずつ生成します。
14        yield $i;
15    }
16    echo "ジェネレータが終了しました。\n";
17}
18
19// ジェネレータからイテレータインスタンスを作成します。
20$generator = createNumberGenerator();
21
22// CachingIteratorでジェネレータをラップします。
23// これにより、ジェネレータが生成した値をキャッシュし、巻き戻し可能になります。
24$cachingIterator = new CachingIterator($generator);
25
26echo "--- 1回目のループ処理 ---\n";
27// foreachでイテレータを最後まで処理します。
28// この時、ジェネレータが実行され、値がキャッシュされます。
29foreach ($cachingIterator as $number) {
30    echo $number . "\n";
31}
32echo "\n";
33
34echo "--- rewind() を呼び出します ---\n";
35// rewind()メソッドを呼び出し、イテレータを先頭に巻き戻します。
36// キャッシュされたデータが使われるため、元のジェネレータ関数は再実行されません。
37$cachingIterator->rewind();
38echo "イテレータが先頭に戻りました。\n\n";
39
40echo "--- 2回目のループ処理 ---\n";
41// rewind()によって、再度最初からループ処理を行うことができます。
42foreach ($cachingIterator as $number) {
43    echo $number . "\n";
44}
45

CachingIterator::rewind()は、イテレータをその先頭要素に巻き戻すためのメソッドです。このメソッドは引数を取らず、戻り値もありません。

PHPのジェネレータは、メモリを節約できる便利な機能ですが、通常は一度しかループ処理ができないという特性があります。しかし、サンプルコードのようにジェネレータをCachingIteratorでラップすることで、この制約を回避できます。

最初のforeachループを実行すると、元のジェネレータが実行され、生成されたすべての値（この場合は1, 2, 3）がCachingIteratorの内部にキャッシュ（一時保存）されます。ループが完了すると、通常そのジェネレータは使えなくなります。

しかし、ここでrewind()メソッドを呼び出すと、イテレータの内部ポインタがキャッシュされたデータの先頭に戻ります。このとき、元のジェネレータ関数が再実行されることはありません。そのため、2回目のforeachループでは、キャッシュされた値が再利用され、再び最初からデータを処理することが可能になります。

Copy
1<?php
2
3/**
4 * CachingIterator::rewind() の使用例を示します。
5 *
6 * rewind() メソッドは、イテレータを最初の要素に戻します。
7 * これにより、一度最後まで処理したイテレータを再度最初からループさせることができます。
8 * foreach ループは内部で自動的に rewind() を呼び出しますが、
9 * このサンプルでは明示的に呼び出すことでその動作を確認します。
10 */
11function demonstrateCachingIteratorRewind(): void
12{
13    // 1. 操作の対象となる配列を準備します。
14    $data = ['Apple', 'Banana', 'Cherry'];
15
16    // 2. 配列から ArrayIterator を作成し、それを CachingIterator でラップします。
17    $iterator = new CachingIterator(new ArrayIterator($data));
18
19    echo "--- 1回目のループ ---\n";
20    // 3. foreach ループで全ての要素を出力します。
21    // このループが終わると、イテレータの内部ポインタは末尾に移動しています。
22    foreach ($iterator as $item) {
23        echo $item . PHP_EOL;
24    }
25    echo "--- ループ終了 ---\n\n";
26
27    // 4. rewind() メソッドを明示的に呼び出し、イテレータの内部ポインタを先頭に戻します。
28    echo "iterator->rewind() を呼び出しました。\n\n";
29    $iterator->rewind();
30
31    echo "--- 2回目のループ ---\n";
32    // 5. 再度ループを実行すると、イテレータが先頭に戻っているため、
33    // もう一度最初から全ての要素が出力されます。
34    foreach ($iterator as $item) {
35        echo $item . PHP_EOL;
36    }
37    echo "--- ループ終了 ---\n";
38}
39
40// 関数を実行して動作を確認します。
41demonstrateCachingIteratorRewind();

PHPのCachingIterator::rewind()メソッドは、イテレータを最初の要素、つまり先頭に戻す機能を提供します。イテレータとは、配列のようなデータの集まりから要素を一つずつ順番に取り出すための仕組みです。このメソッドは引数を受け取らず、何かを返す（戻り値）こともありません。

サンプルコードでは、まず['Apple', 'Banana', 'Cherry']という配列を元にイテレータを作成しています。最初のforeachループで全ての要素を出力すると、イテレータの内部的な現在位置はデータの末尾に到達します。

次に$iterator->rewind()を呼び出すことで、この内部的な位置を強制的に先頭に戻しています。これにより、イテレータが初期状態にリセットされます。その結果、2回目のforeachループを実行した際にも、再び最初の要素である'Apple'から順番に全ての要素が出力されることが確認できます。

このようにrewind()メソッドは、一度最後まで処理したイテレータを、もう一度最初から利用したい場合に有効です。