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

rewindメソッドは、RecursiveArrayIteratorが指し示す内部ポインタを、対象となる配列の最初の要素に巻き戻す処理を実行するメソッドです。イテレータは、配列のような集合データ構造の要素を一つずつ順番に処理するための仕組みであり、rewindメソッドはその処理の開始点を先頭に設定する重要な役割を担います。PHPのforeachループでRecursiveArrayIteratorのインスタンスを処理する際、ループが始まる前にこのrewindメソッドが自動的に呼び出されます。これにより、常に配列の最初の要素からループが開始されることが保証されます。また、開発者が手動でこのメソッドを呼び出すことも可能です。例えば、一度最後まで走査したイテレータを、何らかの理由で再度、最初から処理し直したい場合に利用できます。このメソッドは操作を行うだけで、何も値を返しません（返り値の型はvoidです）。RecursiveArrayIteratorを用いて多次元配列などを再帰的に走査する際に、その処理の開始点を制御するための基本的な操作として利用されます。

Copy
1<?php
2
3$data = [
4    "first" => "Apple",
5    "second" => "Banana",
6    "third" => "Cherry"
7];
8
9// RecursiveArrayIteratorのインスタンスを生成します
10$iterator = new RecursiveArrayIterator($data);
11
12// イテレータのポインタを次の要素に進めます
13$iterator->next();
14
15// rewind()メソッドを呼び出し、イテレータを最初の要素に戻します
16$iterator->rewind();
17
18?>

引数なし

引数はありません

戻り値なし

戻り値はありません