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

Copy
1<?php
2
3/**
4 * ジェネレータ関数を定義します。
5 * これは一度しかイテレートできない通常のジェネレータです。
6 */
7function generateSequence(): Generator
8{
9    echo "--- ジェネレータ開始 ---\n";
10    for ($i = 1; $i <= 3; $i++) {
11        echo "値を生成: " . $i . "\n";
12        yield $i;
13    }
14    echo "--- ジェネレータ終了 ---\n";
15}
16
17/**
18 * ジェネレータの出力をArrayIteratorでラップすることで、
19 * 巻き戻し可能なイテレータとして扱うデモンストレーション。
20 * PHPのネイティブジェネレータはrewind()メソッドを持たないため、
21 * 一度結果を収集し、ArrayIteratorを使うのが一般的なアプローチです。
22 */
23function demonstrateRewindableGeneratorSimulation(): void
24{
25    // 1. ジェネレータから全ての値を収集し、配列に格納します。
26    // これにより、ジェネレータの出力がメモリに保持され、複数回イテレート可能になります。
27    $collectedData = [];
28    foreach (generateSequence() as $value) {
29        $collectedData[] = $value;
30    }
31
32    echo "\n--- ジェネレータから収集されたデータ ---\n";
33    print_r($collectedData);
34
35    // 2. 収集した配列をArrayIteratorでラップします。
36    // ArrayIteratorはRewindableIteratorインターフェースを実装しており、rewind()メソッドを提供します。
37    $arrayIterator = new ArrayIterator($collectedData);
38
39    echo "\n--- ArrayIteratorによる最初のイテレーション ---\n";
40    // 3. ArrayIteratorを一度最後までイテレートします。
41    foreach ($arrayIterator as $key => $value) {
42        echo "1回目イテレート: " . $value . "\n";
43    }
44
45    echo "\n--- ArrayIterator::rewind() の呼び出し ---\n";
46    // 4. rewind()メソッドを呼び出します。
47    // これにより、イテレータの内部ポインタがデータの先頭に戻ります。
48    $arrayIterator->rewind();
49
50    echo "\n--- ArrayIterator::rewind() 後、2回目のイテレーション ---\n";
51    // 5. rewind()後、再度イテレートします。
52    // ポインタが先頭に戻っているため、最初からデータが再表示されます。
53    foreach ($arrayIterator as $key => $value) {
54        echo "2回目イテレート: " . $value . "\n";
55    }
56
57    echo "\n--- 巻き戻し可能なジェネレータシミュレーション終了 ---\n";
58}
59
60// サンプルコードを実行します。
61demonstrateRewindableGeneratorSimulation();

PHPのArrayIterator::rewind()メソッドは、イテレータの内部ポインタをデータの最初の要素に戻すためのものです。このメソッドは引数を取らず、特に値を返しません。

通常のPHPのジェネレータは、一度すべての値を生成し終えると、再度最初からデータを処理することはできません。しかし、ArrayIteratorは「巻き戻し可能なイテレータ」としての機能を提供します。

提供されたサンプルコードでは、まず通常のジェネレータから生成されたすべてのデータを一度配列に収集しています。この収集した配列をArrayIteratorでラップすることで、配列の内容を繰り返し処理できるイテレータを作成しています。

一度ArrayIteratorが最後までイテレートされ、データの終わりに達した後でも、$arrayIterator->rewind()を呼び出すことで、内部ポインタをデータの先頭に戻すことができます。これにより、同じArrayIteratorインスタンスを使って、配列のデータを何度でも最初から処理し直すことが可能になります。これは、一度だけ生成されるジェネレータの出力を、複数回利用したい場合に有効な手法です。

Copy
1<?php
2
3/**
4 * ArrayIterator::rewind() メソッドのサンプルコード
5 *
6 * ArrayIterator は、配列やオブジェクトを反復処理するためのイテレータです。
7 * rewind() メソッドは、イテレータの内部ポインタを最初の要素にリセットします。
8 * これにより、すでに一度反復処理を行ったイテレータを最初から再度反復処理できます。
9 */
10function demonstrateArrayIteratorRewind(): void
11{
12    // 反復処理するサンプル配列を準備
13    $data = ['Apple', 'Banana', 'Cherry', 'Date'];
14
15    // ArrayIterator インスタンスを作成
16    $iterator = new ArrayIterator($data);
17
18    echo "--- 最初のイテレーション ---" . PHP_EOL;
19    // イテレータを反復処理し、内部ポインタを進める
20    foreach ($iterator as $key => $value) {
21        echo "Key: {$key}, Value: {$value}" . PHP_EOL;
22    }
23
24    echo PHP_EOL . "--- rewind() メソッドの呼び出し ---" . PHP_EOL;
25    // rewind() メソッドを呼び出し、イテレータのポインタを最初の要素にリセット
26    $iterator->rewind();
27    echo "イテレータのポインタを最初の要素にリセットしました。" . PHP_EOL;
28
29    echo PHP_EOL . "--- rewind() 後の2回目のイテレーション ---" . PHP_EOL;
30    // 再度イテレータを反復処理すると、最初から開始される
31    foreach ($iterator as $key => $value) {
32        echo "Key: {$key}, Value: {$value}" . PHP_EOL;
33    }
34}
35
36// 関数の実行
37demonstrateArrayIteratorRewind();
38
39?>

PHP 8で提供されるArrayIteratorクラスは、配列やオブジェクトなどの集合データを、統一された方法で繰り返し処理（イテレーション）するための機能です。このArrayIteratorクラスに属するrewind()メソッドは、イテレータの内部ポインタを最初の要素にリセットする役割を持っています。

このメソッドは引数を必要とせず、呼び出しても特定の値を返しません。サンプルコードでは、まず配列をArrayIteratorでラップし、最初のforeachループで要素を順に処理しています。この処理が終わると、イテレータの内部ポインタは配列の終端まで進んだ状態になります。

その後に$iterator->rewind()を呼び出すことで、イテレータのポインタが配列の最初の要素を指す状態にリセットされます。これにより、次に同じ$iteratorを使ってforeachループを実行すると、再度最初からすべての要素を繰り返し処理できるようになります。rewind()メソッドは、一度データを処理した後に、もう一度最初から同じデータを処理したい場合に利用されます。