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

Copy
1<?php
2
3/**
4 * PHP 8 の InfiniteIterator::rewind メソッドの使用例。
5 *
6 * PHPのGeneratorは通常一度しかイテレートできません（巻き戻し不可）。
7 * InfiniteIteratorは内部のイテレータが終端に達すると、そのイテレータの
8 * rewind() メソッドを呼び出して無限に反復しますが、Generatorを直接渡すと
9 * 巻き戻しができないため期待通りに動作しません。
10 *
11 * この例では、Generatorの出力を一時的にメモリに格納し、
12 * それをArrayIteratorでラップすることで、実質的に「巻き戻し可能」な
13 * データソースとしてInfiniteIteratorで使用する方法を示します。
14 */
15
16/**
17 * 単純なジェネレータ関数。
18 * yieldを使って値を順番に生成します。
19 */
20function simpleGenerator(): Generator
21{
22    yield 'A';
23    yield 'B';
24    yield 'C';
25}
26
27// 1. simpleGenerator() から生成された値を全て配列に展開します。
28//    これにより、ジェネレータの「一度きりのイテレーション」という特性を回避し、
29//    データ全体をメモリ上に保持します。
30$generatedData = iterator_to_array(simpleGenerator());
31
32// 2. 配列をArrayIteratorでラップします。
33//    ArrayIteratorはPHPの標準的なイテレータで、巻き戻しが可能です。
34$rewindableIterator = new ArrayIterator($generatedData);
35
36// 3. ArrayIterator を InfiniteIterator でラップします。
37//    InfiniteIteratorは、内部のイテレータが終端に達すると、
38//    自動的にそのイテレータの rewind() メソッドを呼び出して最初から反復を再開します。
39$infiniteIterator = new InfiniteIterator($rewindableIterator);
40
41echo "--- InfiniteIteratorによるデータの無限反復 (最初の10要素) ---\n";
42$count = 0;
43foreach ($infiniteIterator as $item) {
44    echo $item . "\n";
45    $count++;
46    if ($count >= 10) { // 無限ループを防ぐため、10要素で強制終了
47        break;
48    }
49}
50
51echo "\n--- InfiniteIterator::rewind() を明示的に呼び出した後の動作 ---\n";
52// InfiniteIterator::rewind() を明示的に呼び出すことで、
53// 内部の ArrayIterator も最初（要素 'A'）に巻き戻されます。
54// これは、ループの途中や特定の時点でイテレーションを最初から再開したい場合に有用です。
55$infiniteIterator->rewind();
56
57$count = 0;
58foreach ($infiniteIterator as $item) {
59    echo $item . "\n";
60    $count++;
61    if ($count >= 5) { // 無限ループを防ぐため、5要素で強制終了
62        break;
63    }
64}
65
66?>

PHP 8のInfiniteIterator::rewindメソッドは、InfiniteIteratorが内部で使用しているイテレータの現在位置を、最初の状態に巻き戻す（イテレーションを最初からやり直す）ためのものです。このメソッドは引数を必要とせず、値を返しません（void）。

通常、PHPのジェネレータは一度しか値を取り出すことができず、途中でイテレーションをやり直す「巻き戻し」はできません。しかし、InfiniteIteratorは、内部のイテレータが終端に達するたびに、そのイテレータのrewind()メソッドを自動的に呼び出して繰り返し処理を続けます。そのため、巻き戻しができないジェネレータを直接InfiniteIteratorに渡すと期待通りに動作しません。

サンプルコードでは、まずジェネレータから生成されたすべての値を配列に格納し、その配列をArrayIteratorでラップしています。ArrayIteratorは巻き戻しが可能であるため、これをInfiniteIteratorに渡すことで、ジェネレータの値を無限に反復できるようにしています。最初のループでは、InfiniteIteratorが内部でArrayIteratorを自動的に巻き戻しながらデータを繰り返し表示しています。次に、明示的に$infiniteIterator->rewind()を呼び出すことで、内部のArrayIteratorが最初の要素（'A'）に戻り、イテレーションを好きなタイミングで最初から再開できることを示しています。

Copy
1<?php
2
3/**
4 * InfiniteIterator::rewind() メソッドの動作をデモンストレーションします。
5 *
6 * この関数は、PHPのInfiniteIteratorクラスを使用して、配列の要素を無限に
7 * イテレーションする例を示します。特に、イテレーションを途中で中断した後、
8 * rewind() メソッドを明示的に呼び出すことで、イテレータがコレクションの
9 * 先頭に巻き戻される様子を確認できます。
10 *
11 * システムエンジニアを目指す初心者の方へ：
12 * PHPのイテレータは、配列のようなデータコレクションを効率的に巡回するための
13 * 標準的な方法を提供します。rewind() メソッドは、イテレータをそのコレクションの
14 * 最初の要素に戻す際に使用され、データの再処理などに役立ちます。
15 */
16function demonstrateInfiniteIteratorRewind(): void
17{
18    // 1. イテレーションする元のデータ配列を準備します。
19    $data = ['Apple', 'Banana', 'Cherry'];
20
21    // 2. ArrayIterator を使用して、通常の配列をイテレータとして扱います。
22    //    InfiniteIterator は Iterator インターフェースを実装したオブジェクトを必要とします。
23    $arrayIterator = new ArrayIterator($data);
24
25    // 3. InfiniteIterator を作成し、ArrayIterator をラップします。
26    //    これにより、内部イテレータが終端に達しても、自動的に巻き戻されて
27    //    無限にイテレーションが続きますが、ここでは明示的な rewind() の効果を示します。
28    $infiniteIterator = new InfiniteIterator($arrayIterator);
29
30    echo "--- 最初のイテレーション (2つの要素まで進める) ---" . PHP_EOL;
31    $count = 0;
32    foreach ($infiniteIterator as $index => $value) {
33        echo "要素 [{$index}]: {$value}" . PHP_EOL;
34        $count++;
35        if ($count >= 2) {
36            // 2つの要素を出力したらイテレーションを中断します。
37            // この時点でイテレータは2番目の要素 ('Banana') を処理済みで、
38            // 次の要素 ('Cherry') を指している状態です。
39            break;
40        }
41    }
42
43    echo PHP_EOL . "--- InfiniteIterator::rewind() メソッドを呼び出し中 ---" . PHP_EOL;
44    // 4. rewind() メソッドを呼び出して、イテレータを先頭に巻き戻します。
45    //    InfiniteIterator の rewind() は、ラップしている内部イテレータ ($arrayIterator) の
46    //    rewind() メソッドを呼び出し、全体をリセットします。
47    $infiniteIterator->rewind();
48    echo "イテレータがコレクションの先頭に巻き戻されました。" . PHP_EOL;
49
50    echo PHP_EOL . "--- rewind() 後のイテレーション (再び先頭から2つの要素を出力) ---" . PHP_EOL;
51    $count = 0;
52    foreach ($infiniteIterator as $index => $value) {
53        echo "要素 [{$index}]: {$value}" . PHP_EOL;
54        $count++;
55        if ($count >= 2) {
56            // 再び2つの要素を出力したらイテレーションを中断します。
57            // rewind() の効果により、先頭の 'Apple' からイテレーションが再開されます。
58            break;
59        }
60    }
61
62    echo PHP_EOL . "デモンストレーション終了。" . PHP_EOL;
63}
64
65// 関数を実行して InfiniteIterator::rewind() の動作を確認します。
66demonstrateInfiniteIteratorRewind();

PHP 8のInfiniteIteratorクラスに属するrewind()メソッドは、イテレータが指す位置をデータコレクションの先頭に巻き戻すために使用されます。このメソッドは引数を受け取らず、何も値を返しません（void）。

InfiniteIteratorは、内部でラップされたイテレータ（例えばArrayIteratorなど）の要素を無限に繰り返し処理するための特別なクラスです。通常のイテレータは一度終端に達すると終了しますが、InfiniteIteratorは自動的に巻き戻して無限ループを継続します。しかし、開発者が明示的にイテレーションの途中で位置をリセットし、再びデータコレクションの最初から処理を開始したい場面があります。

rewind()メソッドはまさにその目的のために存在します。このメソッドが呼び出されると、InfiniteIteratorは内部のイテレータに対して巻き戻し指示を出し、現在どの要素を指していても強制的にコレクションの最初の要素を指す状態に戻します。

サンプルコードでは、InfiniteIteratorを使って配列「Apple」「Banana」「Cherry」をイテレーションし、途中で「Banana」まで処理して中断しています。その後にrewind()を呼び出すことで、次にイテレーションを再開した際に、再び最初の要素である「Apple」から処理が開始される様子が示されています。これにより、同じデータセットを複数回、または特定の時点から再処理する際に、柔軟な制御が可能になります。