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

Copy
1<?php
2
3/**
4 * このクラスはIteratorAggregateインターフェースを実装し、
5 * 内部でジェネレータを使用して、複数回イテレート可能な（rewindableな）データソースを提供します。
6 *
7 * PHPの標準的なGeneratorクラスはIteratorインターフェースを実装していますが、
8 * そのrewind()メソッドを直接呼び出すとBadMethodCallExceptionが発生し、巻き戻すことはできません。
9 *
10 * 「rewindable generator」という概念は、多くの場合、このクラスのようにIteratorAggregateを実装し、
11 * getIterator()メソッドが呼び出されるたびに毎回新しいGeneratorインスタンスを返すことで実現されます。
12 * これにより、foreachループが複数回実行された際に、常にデータの先頭からイテレーションを再開できます。
13 * これが、外部から見たときの「巻き戻し可能」（rewindable）な振る舞いです。
14 */
15class RewindableGeneratorAggregate implements IteratorAggregate
16{
17    /**
18     * @var array イテレートする元のデータ
19     */
20    private array $data;
21
22    /**
23     * コンストラクタ。
24     *
25     * @param array $data イテレートするデータの配列
26     */
27    public function __construct(array $data)
28    {
29        $this->data = $data;
30    }
31
32    /**
33     * このオブジェクトのイテレータを返します。
34     * foreachループが開始されるたびにこのメソッドが呼び出され、
35     * 新しいGeneratorインスタンスが生成されて返されます。
36     *
37     * このメカニズムにより、PHPのGenerator自体は巻き戻せないにもかかわらず、
38     * このRewindableGeneratorAggregateオブジェクトは外部から見て巻き戻し可能となります。
39     * 
40     * @return Generator PHPのGeneratorはIteratorインターフェースを実装しています。
41     *                   内部的には、foreachループが新しいイテレーションを開始する際に、
42     *                   このメソッドが返すGeneratorオブジェクトに対してrewind()を呼び出しますが、
43     *                   PHPのGeneratorはrewind()をサポートしないため、実際には例外が投げられます。
44     *                   しかし、このパターンでは新しいGeneratorインスタンスが毎回生成されるため、
45     *                   結果的に最初からイテレーションが開始されます。
46     */
47    public function getIterator(): Generator
48    {
49        foreach ($this->data as $index => $value) {
50            yield $index => $value;
51        }
52    }
53}
54
55// --- サンプルコードの実行 ---
56
57// イテレートするデータを用意します
58$dataItems = ['apple', 'banana', 'cherry', 'date'];
59
60// RewindableGeneratorAggregateのインスタンスを作成します
61$rewindableSource = new RewindableGeneratorAggregate($dataItems);
62
63echo "--- 1回目のイテレーション ---" . PHP_EOL;
64foreach ($rewindableSource as $key => $value) {
65    echo "  Key: {$key}, Value: {$value}" . PHP_EOL;
66}
67
68echo "--- 2回目のイテレーション（巻き戻し動作）---" . PHP_EOL;
69// 2回目のforeachループが開始されると、rewindableSource->getIterator()が再度呼び出され、
70// 新しいGeneratorインスタンスが取得されるため、データが最初から再度イテレートされます。
71foreach ($rewindableSource as $key => $value) {
72    echo "  Key: {$key}, Value: {$value}" . PHP_EOL;
73}
74
75echo "--- 3回目のイテレーション（途中で中断後、再び最初から）---" . PHP_EOL;
76foreach ($rewindableSource as $key => $value) {
77    echo "  Key: {$key}, Value: {$value}" . PHP_EOL;
78    if ($key === 1) { // 途中でイテレーションを中断します
79        break;
80    }
81}
82
83// 4回目のイテレーションは、中断された3回目の続きからではなく、
84// 再び最初（Key: 0）から開始されます。これが「rewindable」な振る舞いです。
85echo "--- 4回目のイテレーション ---" . PHP_EOL;
86foreach ($rewindableSource as $key => $value) {
87    echo "  Key: {$key}, Value: {$value}" . PHP_EOL;
88}

PHPのIterator::rewindメソッドは、イテレータをコレクションの最初の要素の位置にリセットするための内部メソッドです。これにより、イテレータはデータの先頭から再度処理を開始できる状態になります。このメソッドは引数を受け取らず、戻り値もありません。

しかし、PHPの標準的なGeneratorは、一度イテレーションを開始するとその状態を保持するため、rewind()メソッドを直接呼び出して巻き戻すことはできません。直接呼び出すとエラーが発生します。

提供されたサンプルコードは、「巻き戻し可能（rewindable）なジェネレータ」の振る舞いを実現する一般的なパターンを示しています。これはIteratorAggregateインターフェースを実装することで実現されます。IteratorAggregateを実装するクラスのgetIterator()メソッドは、foreachループが開始されるたびに呼び出され、そのたびに新しいGeneratorインスタンスを生成して返します。このメカニズムにより、foreachループが複数回実行された場合でも、毎回新しいGeneratorが提供されるため、常にデータの先頭からイテレーションが再開されます。PHPのGenerator自体は巻き戻せないものの、このパターンを用いることで、外部からデータソースが巻き戻し可能であるかのように扱うことができます。

Copy
1<?php
2
3/**
4 * このスクリプトは、PHPのIteratorインターフェースのrewind()メソッドの基本的な使い方を示します。
5 * ArrayIteratorクラスを使って配列をイテレートし、rewind()を使ってイテレータを最初の位置に戻します。
6 */
7
8// サンプルデータとなる配列を定義します。
9$fruits = ['Apple', 'Banana', 'Cherry', 'Date'];
10
11// ArrayIteratorは、配列をイテレータとして扱うための組み込みクラスです。
12// これにより、Iteratorインターフェースのメソッド（rewind, valid, current, key, next）を利用できます。
13$arrayIterator = new ArrayIterator($fruits);
14
15echo "--- 最初のイテレーション ---\n";
16// 最初のイテレーションで配列の要素を順に出力します。
17foreach ($arrayIterator as $key => $value) {
18    echo "Key: {$key}, Value: {$value}\n";
19}
20
21echo "\n--- イテレータを巻き戻します (rewind()) ---\n";
22// rewind()メソッドは、イテレータの内部ポインタをコレクションの最初の要素に戻します。
23// これにより、イテレータを再度最初から走査できるようになります。
24$arrayIterator->rewind();
25
26echo "\n--- 二度目のイテレーション (rewind() 後) ---\n";
27// rewind()を呼び出した後、もう一度イテレーションを行います。
28// 最初のイテレーションと同じ結果が出力されることを確認できます。
29foreach ($arrayIterator as $key => $value) {
30    echo "Key: {$key}, Value: {$value}\n";
31}
32
33?>

PHP 8のIterator::rewindメソッドは、コレクション（配列など）の要素を順番に処理するための「イテレータ」の現在位置を、そのコレクションの最初の要素に戻す役割を持つメソッドです。これはIteratorインターフェースに定義されており、このインターフェースを実装するクラス（例えばArrayIterator）で利用できます。

rewindメソッドは引数を取りません。また、特定の値を返すこともありません。メソッドを呼び出すだけで、イテレータの内部状態がリセットされ、最初からデータを読み取れるようになります。

サンプルコードでは、まず配列$fruitsをArrayIteratorオブジェクトに変換し、最初のforeachループで要素を順に出力しています。このループが完了すると、イテレータの現在位置は配列の終わりに達しています。そこで$arrayIterator->rewind()を呼び出すことで、イテレータの位置が配列の先頭に戻されます。この操作により、続く二度目のforeachループでは、最初からすべての要素が再び出力されることを確認できます。

このように、rewindメソッドは、一度イテレートしたデータセットをもう一度最初から処理したい場合に非常に役立ちます。