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

rewindメソッドは、ArrayIteratorオブジェクトの内部ポインタを最初の要素に巻き戻す処理を実行するメソッドです。ArrayIteratorは、配列のように振る舞いながら、要素を一つずつ順番に処理するためのイテレータ機能を提供します。例えば、foreachループでArrayIteratorオブジェクトを反復処理する場合、ループが開始されるたびに、必ず先頭の要素から処理が始まるように内部ポインタをリセットする必要があります。この重要な役割を担っているのがrewindメソッドです。このメソッドは、PHPの組み込みインターフェースであるIteratorインターフェースで定められたメソッドの一つであり、ArrayIteratorクラスで実装されています。rewindメソッドを呼び出すと、次にcurrentメソッドで値を取得する際にはコレクションの最初の要素が返され、コレクションが空でなければvalidメソッドはtrueを返す状態になります。このメソッドは引数を取らず、戻り値もありません。その目的は、イテレータの内部状態を初期化することに特化しており、反復処理を常に予測可能な状態から開始できるように保証します。

Copy
1<?php
2$array = ['a', 'b', 'c'];
3$iterator = new ArrayIterator($array);
4
5// ポインタを2番目の要素に進める
6$iterator->next();
7
8// rewind() を呼び出して、ポインタを最初の要素に戻す
9$iterator->rewind();
10
11// 現在の要素を出力（'a' が表示される）
12echo $iterator->current();
13?>

引数なし

引数はありません

戻り値なし

戻り値はありません