【PHP8.x】rewindメソッドの使い方

Copy
1<?php
2
3/**
4 * このジェネレータ関数は、指定された回数だけ整数を生成します。
5 * 通常のジェネレータは一度しかイテレートできません（巻き戻しができません）。
6 * しかし、ジェネレータ関数を再度呼び出すことで、
7 * 新しいジェネレータインスタンスを取得し、最初からイテレートできます。
8 * これが「巻き戻し可能 (rewindable) なジェネレータ」として機能する一般的な方法です。
9 *
10 * @return Generator 生成された数値を提供するジェネレータ
11 */
12function createRewindableGenerator(): Generator
13{
14    echo "--- ジェネレータの生成処理を開始します ---\n";
15    for ($i = 1; $i <= 3; $i++) {
16        echo "  値 {$i} を生成中...\n";
17        yield $i; // 値を生成し、イテレーションを一時停止します
18    }
19    echo "--- ジェネレータの生成処理を終了します ---\n";
20}
21
22echo "1回目: ジェネレータ関数を呼び出し、最初のイテレーションを開始します。\n";
23$generatorInstance1 = createRewindableGenerator(); // ジェネレータの新しいインスタンスを取得
24
25foreach ($generatorInstance1 as $value) {
26    echo "1回目: 取得した値: {$value}\n";
27}
28echo "1回目: イテレーションが終了しました。\n\n";
29
30// PHPの通常のジェネレータは、一度最後までイテレートされると、
31// そのインスタンスは「消費された」状態になり、巻き戻すことはできません。
32// 以下のように同じインスタンスを再度イテレートしようとしても、何も出力されません。
33echo "1回目に使ったジェネレータインスタンスを再度イテレートしようとします（出力はありません）。\n";
34foreach ($generatorInstance1 as $value) {
35    // このブロックは実行されません
36    echo "1回目 (再): 取得した値: {$value}\n";
37}
38echo "1回目に使ったジェネレータインスタンスの再イテレーション試行が終了しました。\n\n";
39
40// 「巻き戻し可能」なジェネレータの振る舞いを実現するためには、
41// ジェネレータ関数を再度呼び出し、新しいジェネレータインスタンスを作成します。
42// これにより、イテレーションを最初からやり直すことができます。
43echo "2回目: ジェネレータ関数を再度呼び出し、新しいインスタンスでイテレーションを開始します。\n";
44echo "この方法が、PHPにおける「巻き戻し可能なジェネレータ」の典型的な実現方法です。\n";
45$generatorInstance2 = createRewindableGenerator(); // ジェネレータの新しいインスタンスを再度取得
46
47foreach ($generatorInstance2 as $value) {
48    echo "2回目: 取得した値: {$value}\n";
49}
50echo "2回目: イテレーションが終了しました。\n";
51

PHPのジェネレータは、必要に応じて値を生成し、メモリ効率良く順次データを扱うための機能です。InternalIterator::rewindメソッドは、イテレータ（配列のように順にデータを扱うオブジェクト）の内部ポインタを先頭に戻し、イテレーションを最初からやり直すための内部的な操作です。PHPのジェネレータもこの仕組みを内部的に利用しますが、一度すべての値を生成し終えたジェネレータインスタンスに対しては、rewindメソッドを呼び出してもイテレーションを最初に戻すことはできません。

サンプルコードでは、createRewindableGenerator関数がジェネレータを生成します。最初のforeachループでジェネレータは全ての値を生成し終え、「消費された」状態になります。この消費されたジェネレータインスタンスを再度foreachループで処理しようとしても、内部ポインタが終端にあるため、何も出力されません。

PHPで「巻き戻し可能（rewindable）」なジェネレータの振る舞いを実現したい場合は、ジェネレータ関数を再度呼び出して新しいジェネレータインスタンスを作成する必要があります。これにより、イテレーションを最初から再開できます。rewindメソッドは引数を取らず、戻り値もありません。これは、内部的な状態のリセット操作を行うためです。

Copy
1<?php
2
3/**
4 * このサンプルコードは、PHPのイテレータにおいて `rewind()` メソッドがどのように機能するかを示します。
5 * `rewind()` は、イテレータの内部ポインタを最初の要素の位置に戻すために使用されます。
6 * 通常、`foreach` ループは自動的に `rewind()` を呼び出しますが、
7 * 手動でイテレータをリセットしたい場合に直接呼び出すことができます。
8 */
9
10// ArrayIterator は、配列をイテレータとして扱うための標準的なPHPクラスです。
11// これは Iterator インターフェースを実装しており、rewind() メソッドを含みます。
12$data = ['Apple', 'Banana', 'Cherry', 'Date'];
13$iterator = new ArrayIterator($data);
14
15echo "--- 最初の反復処理 ---\n";
16// 最初の foreach ループでイテレータの要素を順に処理します。
17// このループが完了すると、イテレータの内部ポインタは末尾に移動しています。
18foreach ($iterator as $key => $value) {
19    echo "Key: {$key}, Value: {$value}\n";
20}
21
22echo "\n--- rewind() の呼び出し ---\n";
23// ここで rewind() メソッドを呼び出すことにより、
24// イテレータの内部ポインタを最初の位置（インデックス0）に戻します。
25// これにより、イテレータを最初から再び利用できるようになります。
26$iterator->rewind();
27echo "イテレータのポインタが先頭に戻されました。\n";
28
29echo "\n--- 2回目の反復処理 ---\n";
30// rewind() の呼び出し後、再度 foreach ループでイテレータを反復処理すると、
31// ポインタが先頭に戻っているため、最初の要素から表示されます。
32foreach ($iterator as $key => $value) {
33    echo "Key: {$key}, Value: {$value}\n";
34}
35
36?>

PHPのInternalIterator::rewind()メソッドは、イテレータの内部ポインタを最初の要素の位置に戻すために使用されます。InternalIteratorは、foreachループなどで反復可能なオブジェクトの基本的な振る舞いを定義するインターフェースに属します。

このサンプルコードでは、配列をイテレータとして扱うArrayIteratorクラスを用いてrewind()の動作を示しています。最初のforeachループで配列の要素が順に処理されると、イテレータのポインタは末尾に移動します。この状態では、もう一度反復処理を行っても要素は処理されません。

そこで$iterator->rewind();を呼び出すと、イテレータの内部ポインタが「Apple」の要素がある最初の位置に戻されます。このメソッドは引数を一切取らず、また、戻り値もvoidであるため、何も値を返しません。単にイテレータの状態を変更するだけです。rewind()の呼び出し後、2回目のforeachループではポインタが先頭に戻っているため、再び最初の要素から全てが処理され表示されます。これにより、一度使用したイテレータを最初から再利用できるようになります。通常、foreachループは開始時に自動でrewind()を呼び出しますが、このように手動で呼び出すことで、イテレータを特定のタイミングでリセットする制御が可能になります。