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

『rewindメソッドは、RecursiveIteratorIteratorオブジェクトにおけるイテレータの内部ポインタを最初の要素に巻き戻す処理を実行するメソッドです。このメソッドは、PHPのIteratorインターフェースで定められた要件の一つであり、繰り返し処理を開始点にリセットする役割を担います。foreach構文でイテレータを処理する場合、ループの開始時にPHPエンジンによってこのメソッドが暗黙的に呼び出されるため、通常は開発者が意識して呼び出す必要はありません。しかし、一度ループ処理を終えたイテレータを、再度最初から処理したいといった特定の状況下で明示的に使用することがあります。RecursiveIteratorIteratorの文脈では、このメソッドを呼び出すことで、再帰的な構造を持つデータセット全体の走査を、再び一番最初の要素から開始できる状態にリセットします。このメソッドに引数はなく、戻り値もありません。

Copy
1<?php
2// public RecursiveIteratorIterator::rewind(): void
3
4// RecursiveIteratorIterator のインスタンスを作成します
5$arrayIterator = new RecursiveArrayIterator(['a', ['b', 'c']]);
6$iterator = new RecursiveIteratorIterator($arrayIterator);
7
8// イテレータを最初の要素に巻き戻します
9$iterator->rewind();

引数なし

引数はありません

戻り値なし

戻り値はありません