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

Copy
1<?php
2
3/**
4 * Demonstrates the use of RecursiveArrayIterator and its rewind() method.
5 *
6 * This class provides a mechanism to iterate over nested arrays multiple times from the beginning,
7 * offering a "rewindable" way to process data, which is a desired characteristic often
8 * sought after when working with non-rewindable PHP generators.
9 */
10class RewindableArrayProcessor
11{
12    private array $nestedData;
13    private RecursiveArrayIterator $baseIterator;
14    private RecursiveIteratorIterator $recursiveIterator;
15
16    /**
17     * Constructor initializes the processor with a nested array.
18     *
19     * @param array $nestedData The multi-dimensional array to be processed.
20     */
21    public function __construct(array $nestedData)
22    {
23        $this->nestedData = $nestedData;
24        // RecursiveArrayIterator allows iterating over nested arrays.
25        $this->baseIterator = new RecursiveArrayIterator($this->nestedData);
26        // RecursiveIteratorIterator flattens the iteration to access all leaf values.
27        // RecursiveIteratorIterator::LEAVES_ONLY ensures only the innermost values are returned.
28        $this->recursiveIterator = new RecursiveIteratorIterator($this->baseIterator, RecursiveIteratorIterator::LEAVES_ONLY);
29    }
30
31    /**
32     * Processes the data by iterating over it, stopping partially,
33     * then rewinding the iterator and iterating through all data again from the start.
34     */
35    public function processDataAndRewind(): void
36    {
37        echo "--- First Iteration (Partial) ---" . PHP_EOL;
38        $itemCount = 0;
39        foreach ($this->recursiveIterator as $key => $value) {
40            echo "Key: {$key}, Value: {$value}" . PHP_EOL;
41            $itemCount++;
42            if ($itemCount >= 3) {
43                // Stop after a few elements to demonstrate partial consumption.
44                echo "(Stopped after {$itemCount} items to show partial iteration.)" . PHP_EOL;
45                break;
46            }
47        }
48
49        echo PHP_EOL . "--- Rewinding Iterator and Second Iteration (Full) ---" . PHP_EOL;
50
51        // The rewind() method of RecursiveIteratorIterator (or RecursiveArrayIterator)
52        // resets the internal pointer to the beginning of the data structure.
53        // Calling rewind() on the RecursiveIteratorIterator effectively rewinds
54        // the underlying RecursiveArrayIterator as well, ensuring a full restart.
55        $this->recursiveIterator->rewind();
56
57        // Now, iterate through the data again from the very beginning.
58        foreach ($this->recursiveIterator as $key => $value) {
59            echo "Key: {$key}, Value: {$value}" . PHP_EOL;
60        }
61
62        echo PHP_EOL . "--- Processing Complete ---" . PHP_EOL;
63    }
64}
65
66// --- Example Usage ---
67$sampleMultiDimensionalArray = [
68    'categories' => [
69        'electronics' => [
70            'item1' => 'Laptop',
71            'item2' => 'Smartphone',
72        ],
73        'books' => [
74            'fiction' => 'Novel A',
75            'non-fiction' => 'Guide B',
76        ],
77    ],
78    'misc' => 'Gift Card',
79    'status' => 'active',
80];
81
82$processor = new RewindableArrayProcessor($sampleMultiDimensionalArray);
83$processor->processDataAndRewind();

PHP 8のRecursiveArrayIterator::rewindメソッドは、多次元配列を反復処理するためのイテレータの内部ポインタを、データの先頭に戻す役割を持ちます。このメソッドは引数を必要とせず、特別な戻り値もありません。

提示されたサンプルコードでは、RecursiveArrayIteratorとそれをラップするRecursiveIteratorIteratorを使って多次元配列を扱います。processDataAndRewindメソッドの最初の処理では、イテレータを使って配列の一部だけを処理し、途中で反復を中断しています。その後、$this->recursiveIterator->rewind()を呼び出すことで、イテレータの内部状態がリセットされ、データの開始位置に戻ります。これにより、再度foreachループを実行すると、配列の最初から全ての要素をもう一度漏れなく処理できるようになります。

このrewind()メソッドの機能は、「rewindable（巻き戻し可能）」なイテレータを実現する上で非常に重要です。一度しか反復できないPHPのジェネレータとは異なり、RecursiveArrayIteratorのようなrewind()を持つイテレータは、必要に応じて何度でも最初からデータを再処理できるため、複雑なデータ構造の解析や複数回の処理が必要な場面で柔軟なプログラムを構築するのに役立ちます。

Copy
1<?php
2
3/**
4 * RecursiveArrayIterator::rewind() メソッドの動作を示すサンプルコード。
5 * イテレータの内部ポインタを先頭に戻す方法を理解します。
6 */
7function demonstrateRecursiveArrayIteratorRewind(): void
8{
9    // 入れ子になった配列を準備します。
10    $data = [
11        'fruits' => ['apple', 'banana', 'cherry'],
12        'vegetables' => ['carrot', 'daikon'],
13        'grains' => ['rice', 'wheat'],
14    ];
15
16    // RecursiveArrayIterator のインスタンスを作成します。
17    // これにより、配列をイテレータとして扱えるようになります。
18    $rai = new RecursiveArrayIterator($data);
19
20    // RecursiveIteratorIterator のインスタンスを作成します。
21    // これは RecursiveArrayIterator のサブイテレータを処理し、
22    // 入れ子の構造をフラットにイテレートするのに役立ちます。
23    $rii = new RecursiveIteratorIterator($rai, RecursiveIteratorIterator::LEAVES_ONLY);
24
25    echo "--- 最初のイテレーション ---" . PHP_EOL;
26    // イテレータを使って配列の要素を順番に処理します。
27    // next() メソッドが内部で呼び出され、ポインタが進んでいきます。
28    foreach ($rii as $key => $value) {
29        echo "Key: " . $key . ", Value: " . $value . PHP_EOL;
30    }
31
32    echo PHP_EOL . "イテレーションが終了しました。ポインタは終端にあります。" . PHP_EOL;
33
34    // rewind() メソッドを呼び出して、イテレータのポインタを先頭に戻します。
35    // このメソッドは引数を受け取らず、何も返しませんが、イテレータの状態をリセットします。
36    $rii->rewind();
37    echo "rewind() を呼び出してポインタを先頭に戻しました。" . PHP_EOL . PHP_EOL;
38
39    echo "--- 2回目のイテレーション ---" . PHP_EOL;
40    // ポインタが先頭に戻ったため、もう一度最初から要素を処理できます。
41    foreach ($rii as $key => $value) {
42        echo "Key: " . $key . ", Value: " . $value . PHP_EOL;
43    }
44
45    echo PHP_EOL . "2回目のイテレーションも終了しました。" . PHP_EOL;
46}
47
48// 関数を実行して動作を確認します。
49demonstrateRecursiveArrayIteratorRewind();
50
51?>

PHPのRecursiveArrayIterator::rewind()メソッドは、イテレータの内部ポインタをデータの先頭に戻すために使用されます。イテレータは配列やオブジェクトの要素を順番に処理する際に、現在どの要素を指しているかを示す内部ポインタを持っています。一度イテレーションが完了し、ポインタが終端に達すると、通常はそれ以上要素を処理できません。

このメソッドを呼び出すことで、ポインタが初期状態、つまりデータの最初の要素を指す位置に戻ります。引数は一切受け取らず、戻り値もありません。ただイテレータの内部状態をリセットする役割を果たします。

サンプルコードでは、まず入れ子配列をRecursiveIteratorIteratorで繰り返し処理し、ポインタが終端に進む様子を示しています。その後にrewind()メソッドを呼び出すと、ポインタが先頭に戻され、再度同じループで最初からすべての要素を処理できることが確認できます。これにより、一度使用したイテレータを再利用して、複数回データの走査を行うことが可能になります。