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

Copy
1<?php
2
3/**
4 * ジェネレータを内部に持ち、rewindable (巻き戻し可能) な振る舞いを提供するカスタムイテレータ。
5 * RecursiveIterator インターフェースを実装し、rewind メソッドを明示的に定義します。
6 *
7 * 通常のPHPジェネレータは一度イテレーションを開始すると巻き戻せないため、
8 * rewind が呼ばれるたびに新しいジェネレータインスタンスを生成することで、
9 * 複数回イテレーションを可能にします。
10 */
11class RewindableGeneratorIterator implements RecursiveIterator
12{
13    /**
14     * ジェネレータを新しく生成するためのクロージャ（ファクトリ関数）。
15     */
16    private Closure $generatorFactory;
17
18    /**
19     * 現在のイテレーションで使用されているジェネレータインスタンス。
20     */
21    private ?Generator $currentGenerator = null;
22
23    /**
24     * イテレータが扱うデータ。
25     */
26    private array $data;
27
28    /**
29     * コンストラクタ。イテレータが処理するデータを初期化します。
30     *
31     * @param array $data イテレーションの対象となるデータ配列。
32     */
33    public function __construct(array $data)
34    {
35        $this->data = $data;
36        // ジェネレータを生成するファクトリ関数を定義します。
37        // これにより、rewind() が呼ばれるたびに新しいジェネレータインスタンスを取得できます。
38        $this->generatorFactory = function () use ($data): Generator {
39            foreach ($data as $key => $value) {
40                yield $key => $value;
41            }
42        };
43        // イテレータの初期化時に一度巻き戻しておき、最初のジェネレータを準備します。
44        $this->rewind();
45    }
46
47    /**
48     * イテレータを最初の要素に戻します。
49     * RecursiveIterator インターフェースの一部であり、Iterator インターフェースから継承されます。
50     *
51     * ジェネレータは一度開始されると巻き戻せないため、
52     * このメソッドでは常に新しいジェネレータインスタンスを生成し直します。
53     */
54    public function rewind(): void
55    {
56        echo "デバッグ: イテレータを巻き戻しています。新しいジェネレータを生成します。\n";
57        // ジェネレータファクトリを呼び出し、新しいジェネレータインスタンスを取得します。
58        $factory = $this->generatorFactory;
59        $this->currentGenerator = $factory();
60    }
61
62    /**
63     * 現在の要素が有効かどうかをチェックします。
64     *
65     * @return bool 有効な場合は true、そうでない場合は false。
66     */
67    public function valid(): bool
68    {
69        return $this->currentGenerator->valid();
70    }
71
72    /**
73     * 現在の要素の値を返します。
74     *
75     * @return mixed 現在の要素の値。
76     */
77    public function current(): mixed
78    {
79        return $this->currentGenerator->current();
80    }
81
82    /**
83     * 現在の要素のキーを返します。
84     *
85     * @return mixed 現在の要素のキー。
86     */
87    public function key(): mixed
88    {
89        return $this->currentGenerator->key();
90    }
91
92    /**
93     * イテレータを次の要素に進めます。
94     */
95    public function next(): void
96    {
97        $this->currentGenerator->next();
98    }
99
100    /**
101     * 現在の要素が子要素を持っているかどうかをチェックします。
102     * このサンプルではシンプルなイテレータのため、常に false を返します。
103     *
104     * @return bool 常に false。
105     */
106    public function hasChildren(): bool
107    {
108        return false;
109    }
110
111    /**
112     * 現在の要素の子イテレータを返します。
113     * hasChildren() が false を返す場合、通常このメソッドは呼び出されません。
114     *
115     * @return RecursiveIterator|null 常に null。
116     */
117    public function getChildren(): ?RecursiveIterator
118    {
119        return null;
120    }
121}
122
123// --- 使用例 ---
124$dataItems = ['apple', 'banana', 'cherry', 'date'];
125
126// RewindableGeneratorIterator のインスタンスを作成
127$iterator = new RewindableGeneratorIterator($dataItems);
128
129echo "--- 1回目のイテレーション ---\n";
130foreach ($iterator as $key => $value) {
131    echo "Key: {$key}, Value: {$value}\n";
132}
133
134echo "\n--- 2回目のイテレーション（自動的な rewind を含む）---\n";
135// foreach ループはイテレーション開始前に自動的に rewind() を呼び出します。
136// そのため、再度最初の要素から処理が開始されます。
137foreach ($iterator as $key => $value) {
138    echo "Key: {$key}, Value: {$value}\n";
139}
140
141echo "\n--- 3回目のイテレーション（手動で rewind を呼び出した後）---\n";
142// 明示的に rewind() を呼び出すこともできます。
143$iterator->rewind();
144while ($iterator->valid()) {
145    echo "Key: {$iterator->key()}, Value: {$iterator->current()}\n";
146    $iterator->next();
147}
148
149?>

PHP 8のRecursiveIteratorインターフェースに定義されているrewindメソッドは、イテレータの内部ポインタを最初の要素に戻す役割を持ちます。このメソッドは引数を取らず、戻り値もありません。Iteratorインターフェースから継承されており、foreachループなどでイテレーションを開始する際や、途中でリセットして最初から処理し直したい場合に呼び出されます。

PHPの標準的なジェネレータは一度開始すると巻き戻すことができない特性があります。そのため、同じデータを複数回イテレーションしたい場合、通常はジェネレータを再度生成し直す必要があります。提示されたサンプルコードのRewindableGeneratorIteratorクラスは、この課題を解決するためにrewindable generatorという概念を実装しています。具体的には、rewindメソッドが呼ばれるたびに、データソースから新しいジェネレータインスタンスを生成し直すことで、イテレータを巻き戻し可能な状態にしています。これにより、foreachループを再度実行する際や、明示的に$iterator->rewind();と呼び出すことで、いつでもイテレータを最初の状態に戻し、繰り返しデータ処理を行えるようになります。

Copy
1<?php
2
3/**
4 * RecursiveIterator::rewind メソッドの動作を示すサンプルコード。
5 *
6 * このコードは、入れ子になった配列を再帰的に反復処理する際に、
7 * イテレータを初期位置にリセットする `rewind()` メソッドの働きを実演します。
8 * `RecursiveArrayIterator` は `RecursiveIterator` インターフェースを実装しており、
9 * その `rewind()` メソッドを呼び出すことでイテレータを巻き戻すことができます。
10 * 通常、`RecursiveIteratorIterator` を介して間接的に使用されます。
11 */
12
13// サンプルデータとして、入れ子になった配列を準備します。
14$data = [
15    'fruits' => ['apple', 'banana', 'orange'],
16    'vegetables' => ['carrot', 'spinach', 'potato'],
17    'dairy' => ['milk', 'cheese'],
18];
19
20// RecursiveArrayIterator を使用して、配列をイテレータとして扱えるようにします。
21// RecursiveArrayIterator は RecursiveIterator インターフェースを実装しています。
22$recursiveArrayIterator = new RecursiveArrayIterator($data);
23
24// RecursiveIteratorIterator は、再帰的なイテレータ（例: RecursiveArrayIterator）を
25// フラットに反復処理するためのクラスです。
26$iterator = new RecursiveIteratorIterator($recursiveArrayIterator);
27
28echo "--- 1回目のイテレーション ---" . PHP_EOL;
29// 最初のイテレーションで全ての要素を表示します。
30foreach ($iterator as $key => $value) {
31    echo "Key: {$key}, Value: {$value}" . PHP_EOL;
32}
33echo PHP_EOL;
34
35// イテレータを初期位置にリセットします。
36// RecursiveIteratorIterator の rewind() メソッドを呼び出すと、
37// 内部で RecursiveArrayIterator の rewind() も呼び出され、
38// イテレータがデータ構造の先頭に戻ります。
39echo "イテレータをリセットします (rewind() メソッドを呼び出し)..." . PHP_EOL;
40$iterator->rewind();
41echo PHP_EOL;
42
43echo "--- 2回目のイテレーション (rewind() 後の再開) ---" . PHP_EOL;
44// rewind() 後、再度イテレーションを開始すると、最初から要素が取得されます。
45foreach ($iterator as $key => $value) {
46    echo "Key: {$key}, Value: {$value}" . PHP_EOL;
47}
48echo PHP_EOL;
49
50echo "rewind() メソッドがイテレータをリセットし、" . PHP_EOL;
51echo "最初から再度データを読み込めることを示しました。" . PHP_EOL;
52
53?>

PHP 8のRecursiveIteratorインターフェースに定義されているrewindメソッドは、イテレータを初期位置にリセットします。このメソッドは引数を取らず、戻り値もありません。

イテレータの内部ポインタをデータ構造の先頭に巻き戻し、既に反復処理を終えたイテレータを再度最初から利用できるようにします。これにより、同じデータを何度も繰り返し処理したい場合に有効です。

サンプルコードでは、入れ子配列を扱うRecursiveArrayIteratorと、それを反復するRecursiveIteratorIteratorの例でrewind()の動作を示しています。最初のforeachループで全要素を表示した後、$iterator->rewind()を呼び出すことでイテレータがリセットされます。その結果、二度目のforeachループでは、再び配列の最初から要素を取得できることが実演されています。

rewind()メソッドは、イテレータの再利用を可能にする重要な機能です。