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

nextElementメソッドは、再帰イテレータの内部ポインタを次の要素へ移動させる処理を実行するメソッドです。このメソッドが所属するRecursiveIteratorIteratorクラスは、多次元配列やディレクトリ構造といった入れ子になったデータを、foreachループなどで直線的に扱えるようにするための仕組みを提供します。通常のforeachループでは、イテレータは自動的に次の有効な要素へ移動しますが、この移動には現在の要素が子を持つ場合の深掘りや、階層の終端に達した場合に親へ戻るといった複雑な制御が含まれています。nextElementメソッドは、こうした再帰的な移動ロジックを考慮せず、現在操作しているイテレータのポインタを単純に一つ先へ進めるという、より基本的な操作を行います。そのため、RecursiveIteratorIteratorの標準的な動作をカスタマイズして、イテレータの位置を意図的に制御したいといった高度なケースで使用されます。一般的な用途ではforeachがイテレータを適切に管理するため、このメソッドを直接呼び出す機会は少ないです。

Copy
1<?php
2
3$data = [
4    'A',
5    'B',
6    [
7        'C',
8        'D',
9    ],
10    'E',
11];
12
13$iterator = new RecursiveIteratorIterator(
14    new RecursiveArrayIterator($data)
15);
16
17$iterator->rewind();
18while ($iterator->valid()) {
19    echo $iterator->current() . PHP_EOL;
20
21    // イテレータを次の要素に進めます。
22    $iterator->nextElement();
23}

引数なし

引数はありません

戻り値なし

戻り値はありません