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

rewindメソッドは、RecursiveRegexIteratorオブジェクトの処理対象となるイテレータを、その先頭要素に巻き戻す処理を実行するメソッドです。このメソッドは、PHPの標準インターフェースであるIteratorで定義されているもので、イテレータが持つ要素の集合を最初から順に処理できるようにするために不可欠な役割を担います。通常、foreachループでRecursiveRegexIteratorオブジェクトを処理する際に、ループの開始時にPHPエンジンによって内部的に自動で呼び出されます。これにより、ループは常にイテレータの先頭から開始されることが保証されます。開発者がこのメソッドを直接呼び出すことは稀ですが、何らかの理由で同じイテレータの処理をもう一度最初から実行したい場合には、手動で呼び出すことも可能です。このメソッドを実行すると、RecursiveRegexIteratorによる正規表現フィルタリングの状態もリセットされ、改めて先頭の要素から評価が開始されます。なお、このメソッドは値を返しません。

Copy
1<?php
2
3$arrayIterator = new RecursiveArrayIterator(['test1', 'test2', 'another']);
4$regexIterator = new RecursiveRegexIterator($arrayIterator, '/^test/');
5
6$regexIterator->rewind();

引数なし

引数はありません

void

RecursiveRegexIterator::rewindメソッドは、イテレータを最初の要素に戻します。戻り値はありません。