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

Copy
1<?php
2
3/**
4 * 偶数のみをフィルタリングするカスタムイテレータ。
5 *
6 * FilterIteratorを継承し、accept()メソッドでフィルタリングの条件を定義します。
7 */
8class EvenNumberFilter extends FilterIterator
9{
10    /**
11     * 現在の要素が受け入れ可能かどうかを判定します。
12     *
13     * @return bool 現在の要素が偶数の場合はtrue、それ以外はfalseを返します。
14     */
15    public function accept(): bool
16    {
17        // current()メソッドで内部イテレータの現在の値を取得し、偶数かどうかを判定
18        return $this->current() % 2 === 0;
19    }
20}
21
22/**
23 * FilterIteratorとrewind()メソッドの動作を確認する関数。
24 *
25 * ジェネレータは通常、一度しか走査できません（巻き戻し不可）。
26 * しかし、ArrayIteratorのような巻き戻し可能なイテレータをFilterIteratorでラップすると、
27 * rewind()メソッドによってイテレータが先頭に戻され、何度も走査できます。
28 */
29function demonstrateRewindableFilterIterator(): void
30{
31    // 1. 元となるデータと、巻き戻し可能なArrayIteratorを作成
32    $numbers = [1, 2, 3, 4, 5, 6, 7, 8, 9, 10];
33    $iterator = new ArrayIterator($numbers);
34
35    // 2. 作成したイテレータをEvenNumberFilterでラップ
36    $evenFilter = new EvenNumberFilter($iterator);
37
38    echo "1回目の走査（偶数のみ表示）:\n";
39    // foreachループは内部で自動的にrewind()を呼び出してから処理を開始します
40    foreach ($evenFilter as $number) {
41        echo $number . ' ';
42    }
43    echo "\n\n";
44
45    echo "2回目の走査（rewind()呼び出し後）:\n";
46    // 3. rewind()を明示的に呼び出し、イテレータを先頭に戻す
47    $evenFilter->rewind();
48
49    // もう一度ループを実行しても、正しく先頭から処理が再開されることを確認
50    foreach ($evenFilter as $number) {
51        echo $number . ' ';
52    }
53    echo "\n";
54}
55
56// 関数を実行して動作を確認
57demonstrateRewindableFilterIterator();
58
59?>

FilterIteratorクラスのrewindメソッドは、イテレータを最初の要素に巻き戻すために使用されます。このメソッドは引数を取らず、戻り値もありません。その役割は、イテレータの内部的な現在位置を示すポインタを、コレクションの先頭に戻すことです。

サンプルコードでは、数値の配列を元にしたArrayIteratorを、偶数のみを通過させるEvenNumberFilterで包んでいます。foreachループでイテレータを処理する際、ループの開始時にPHPが内部で自動的にrewindメソッドを呼び出します。これにより、イテレータは必ず先頭から走査を開始し、結果として偶数「2 4 6 8 10」が出力されます。

次に、コード中で明示的に$evenFilter->rewind()を呼び出しています。この操作により、一度最後まで処理が進んだイテレータが、再び強制的に先頭の状態に戻されます。そのため、2回目のforeachループを実行した際も、もう一度最初から走査が始まり、同じ偶数の結果が出力されます。このようにrewindメソッドは、一度フィルタリングした結果を再利用したり、繰り返し処理したりする場合に不可欠な機能です。

Copy
1<?php
2
3/**
4 * 偶数のみを通過させるカスタムフィルタクラス
5 *
6 * FilterIteratorを継承し、accept()メソッドでフィルタリングの条件を定義します。
7 * rewind()メソッドは、このイテレータがforeachなどで使われる際に、
8 * 内部で自動的に呼び出され、イテレータを最初の位置に戻します。
9 */
10class EvenNumberFilter extends FilterIterator
11{
12    /**
13     * 現在の要素が受け入れられるかどうかを判定します。
14     *
15     * @return bool 現在の要素が偶数の場合はtrue、それ以外はfalseを返します。
16     */
17    public function accept(): bool
18    {
19        // current()メソッドでイテレータの現在の値を取得し、偶数かどうかをチェックします。
20        return $this->current() % 2 === 0;
21    }
22}
23
24// フィルタリング対象のデータとなる配列
25$numbers = [1, 2, 3, 4, 5, 6, 7, 8, 9, 10];
26
27// 配列からイテレータオブジェクトを作成します
28$arrayIterator = new ArrayIterator($numbers);
29
30// 作成したイテレータをカスタムフィルタでラップします
31$iterator = new EvenNumberFilter($arrayIterator);
32
33echo "1回目のループ処理:\n";
34// foreachループは、最初に内部でrewind()を呼び出し、イテレータを先頭から処理します。
35foreach ($iterator as $key => $value) {
36    echo "{$key} => {$value}\n";
37}
38// 出力:
39// 1 => 2
40// 3 => 4
41// 5 => 6
42// 7 => 8
43// 9 => 10
44
45echo "\n";
46
47// rewind()メソッドを明示的に呼び出し、イテレータを最初の位置に戻します。
48echo "rewind() を呼び出しました。\n";
49$iterator->rewind();
50
51echo "\n";
52
53echo "2回目のループ処理:\n";
54// rewind()によってイテレータが先頭に戻っているため、もう一度同じ結果をループで取得できます。
55foreach ($iterator as $key => $value) {
56    echo "{$key} => {$value}\n";
57}
58// 出力:
59// 1 => 2
60// 3 => 4
61// 5 => 6
62// 7 => 8
63// 9 => 10
64

PHPのFilterIterator::rewind()メソッドは、イテレータを最初の位置、つまり先頭に巻き戻すための機能を提供します。このメソッドは、データの集まりを最初からもう一度繰り返し処理したい場合などに使用されます。

このメソッドは引数を取らず、戻り値もありません。その役割は、イテレータの内部的な状態を「先頭に戻す」という操作そのものです。

foreachループでイテレータを処理する場合、ループが開始される際にPHPが内部で自動的にrewind()メソッドを呼び出します。そのため、普段は意識しなくても、イテレータは常にデータの先頭から処理されます。サンプルコードの1回目のループは、この自動的な呼び出しによって偶数だけを順番に出力しています。

一度ループ処理が完了したイテレータは、通常はデータの終端を指しています。しかし、サンプルコードのように$iterator->rewind()と明示的に呼び出すことで、その位置を強制的に先頭に戻すことができます。その結果、2回目のforeachループでも、1回目と全く同じデータを先頭から取得することが可能になります。このようにrewind()は、イテレータを再利用する際に重要な役割を果たします。