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

Copy
1<?php
2
3/**
4 * MultipleIterator::rewind() の使用例を示します。
5 *
6 * この関数は、複数のイテレータを同時に処理し、
7 * その後、イテレータのポインタを先頭に戻して再処理する方法をデモンストレーションします。
8 *
9 * PHPのジェネレータは通常rewind可能ではありませんが、MultipleIteratorは
10 * 内部に格納されたrewind可能なイテレータ（例: ArrayIterator）に対してrewindを実行できます。
11 * この例では、MultipleIteratorが複数のイテレータの処理を先頭からやり直せることを示します。
12 */
13function demonstrateMultipleIteratorRewind(): void
14{
15    echo "--- MultipleIterator::rewind() のデモンストレーション開始 ---\n";
16
17    // 複数のイテレータを格納し、同時に反復処理するための MultipleIterator を作成します。
18    // MIT_NEED_ALL は、すべての内部イテレータに要素がある場合にのみ現在の反復処理を進めます。
19    // MIT_KEYS_ASSOC は、attachIteratorで指定したキーを結果のキーとして使用します。
20    $multiIterator = new MultipleIterator(MultipleIterator::MIT_NEED_ALL | MultipleIterator::MIT_KEYS_ASSOC);
21
22    // デモンストレーション用のデータとして配列を準備します。
23    $data1 = ['Apple', 'Banana', 'Cherry'];
24    $data2 = [100, 200, 300];
25
26    // rewind可能なArrayIteratorを2つ作成し、MultipleIteratorにアタッチします。
27    // 各イテレータには分かりやすいように「Fruits」と「Numbers」という名前のキーを割り当てます。
28    $multiIterator->attachIterator(new ArrayIterator($data1), 'Fruits');
29    $multiIterator->attachIterator(new ArrayIterator($data2), 'Numbers');
30
31    echo "\n--- 最初の反復処理 ---\n";
32    $iterationCount = 0;
33    foreach ($multiIterator as $key => $value) {
34        echo "イテレーション " . (++$iterationCount) . ": ";
35        // $value は配列で、アタッチしたイテレータの現在の値を含みます。
36        // 例えば ['Fruits' => 'Apple', 'Numbers' => 100] のようになります。
37        foreach ($value as $innerKey => $innerValue) {
38            echo "[$innerKey: $innerValue] ";
39        }
40        echo "\n";
41    }
42    echo "最初の反復処理が完了しました。\n";
43
44    // MultipleIterator::rewind() を呼び出して、すべての内部イテレータのポインタを先頭に戻します。
45    // これにより、イテレータを最初から再度反復処理できるようになります。
46    echo "\nMultipleIterator::rewind() を呼び出しています...\n";
47    $multiIterator->rewind();
48    echo "イテレータのポインタが先頭に戻されました。\n";
49
50    echo "\n--- 2回目の反復処理 (rewind() 呼び出し後) ---\n";
51    $iterationCount = 0;
52    foreach ($multiIterator as $key => $value) {
53        echo "イテレーション " . (++$iterationCount) . ": ";
54        foreach ($value as $innerKey => $innerValue) {
55            echo "[$innerKey: $innerValue] ";
56        }
57        echo "\n";
58    }
59    echo "2回目の反復処理が完了しました。\n";
60
61    echo "\n--- デモンストレーション終了 ---\n";
62}
63
64// 上記のデモンストレーション関数を実行します。
65demonstrateMultipleIteratorRewind();

PHPのMultipleIterator::rewind()メソッドは、複数のイテレータをまとめて扱うMultipleIteratorオブジェクトにアタッチされたすべての内部イテレータのポインタを、それぞれの先頭位置に戻す役割を持つメソッドです。このメソッドは引数を必要とせず、特別な戻り値もありません。

通常、PHPのジェネレータは一度反復処理を終えると巻き戻して再度最初から処理することはできませんが、MultipleIteratorはArrayIteratorのようなrewind（巻き戻し）が可能なイテレータを内部に持つことで、それらを制御し、複数回の反復処理を可能にします。

提供されたサンプルコードでは、まず二つのArrayIterator（果物と数字）をMultipleIteratorにアタッチし、最初のforeachループでこれらを同期的に反復処理します。一度すべてのデータが処理された後、$multiIterator->rewind()を呼び出すことで、内部の各イテレータの現在位置がそれぞれのデータの先頭に戻されます。その結果、二度目のforeachループを実行すると、最初のループと同じ順序で、最初から再度データの反復処理が行われることを確認できます。この機能は、複数の関連するデータソースを繰り返し処理する必要がある場合に役立ちます。

Copy
1<?php
2
3/**
4 * MultipleIterator::rewind() メソッドの動作をデモンストレーションします。
5 *
6 * MultipleIterator は、複数のイテレータを同時に処理するためのクラスです。
7 * rewind() メソッドは、MultipleIterator とそれにアタッチされたすべてのイテレータを、
8 * それぞれの初期位置（先頭）にリセットするために使用されます。
9 */
10function demonstrateMultipleIteratorRewind(): void
11{
12    echo "--- MultipleIterator::rewind() メソッドのデモンストレーション ---" . PHP_EOL;
13    echo "複数のイテレータを同時に管理するMultipleIteratorが、rewind()によって先頭にリセットされる様子を示します。" . PHP_EOL;
14
15    // 1. 2つの独立したイテレータのためのデータを用意します。
16    // ArrayIterator は、配列の要素を一つずつ順番に処理するための基本的なイテレータです。
17    $fruitNames = ['Apple', 'Banana', 'Cherry'];
18    $fruitIterator = new ArrayIterator($fruitNames);
19
20    $quantities = [100, 200, 300];
21    $quantityIterator = new ArrayIterator($quantities);
22
23    // 2. MultipleIterator のインスタンスを作成します。
24    // MIT_NEED_ALL: 全てのアタッチされたイテレータが有効な場合にのみ、MultipleIteratorも有効と判断します。
25    // MIT_KEYS_ASSOC: アタッチ時に指定したエイリアス（'fruit', 'quantity'）をキーとして使用します。
26    $multiIterator = new MultipleIterator(MultipleIterator::MIT_NEED_ALL | MultipleIterator::MIT_KEYS_ASSOC);
27
28    // 3. 独立したイテレータを MultipleIterator にアタッチ（紐付け）します。
29    // それぞれにエイリアス（別名）を付けて、後でアクセスしやすくします。
30    $multiIterator->attachIterator($fruitIterator, 'fruit');
31    $multiIterator->attachIterator($quantityIterator, 'quantity');
32
33    echo "\n--- 1回目のイテレーション (途中で停止) ---" . PHP_EOL;
34    echo "イテレータの内部ポインタを先頭から少し進めます。" . PHP_EOL;
35    $count = 0;
36    foreach ($multiIterator as $key => $value) {
37        // $value はアタッチしたイテレータからの値を含む連想配列になります。
38        // 例: ['fruit' => 'Apple', 'quantity' => 100]
39        echo "現在の要素: " . $value['fruit'] . " (数量: " . $value['quantity'] . ")" . PHP_EOL;
40        $count++;
41        // 2つ目の要素を処理した後にループを中断し、ポインタが途中に留まることを示します。
42        if ($count >= 2) {
43            echo "2つ目の要素を処理後、イテレーションを途中で停止しました。" . PHP_EOL;
44            break;
45        }
46    }
47
48    // この時点で、MultipleIterator の内部ポインタは先頭ではありません。
49
50    echo "\n--- MultipleIterator::rewind() の呼び出し ---" . PHP_EOL;
51    // rewind() メソッドを呼び出すと、MultipleIterator とそれにアタッチされた
52    // 全てのイテレータが、それぞれの最初の位置（先頭）にリセットされます。
53    // このメソッドは引数を取らず、戻り値もありません。
54    $multiIterator->rewind();
55    echo "MultipleIterator が正常に先頭にリセットされました (rewound)。" . PHP_EOL;
56
57    echo "\n--- 2回目のイテレーション (rewind() 後) ---" . PHP_EOL;
58    echo "rewind() 後は、イテレーションが再び最初から開始されることを確認してください。" . PHP_EOL;
59    // 再度イテレーションを行い、rewind() が正常に機能したことを確認します。
60    foreach ($multiIterator as $key => $value) {
61        echo "リセット後の要素: " . $value['fruit'] . " (数量: " . $value['quantity'] . ")" . PHP_EOL;
62    }
63    echo "--------------------------------------------------------" . PHP_EOL;
64    echo "デモンストレーションが完了しました。" . PHP_EOL;
65}
66
67// 上記で定義したデモンストレーション関数を実行します。
68demonstrateMultipleIteratorRewind();
69
70?>

このサンプルコードは、PHP 8のMultipleIteratorクラスが提供するrewind()メソッドの動作を説明します。MultipleIteratorは、複数のイテレータ（データのコレクションを順番にたどる仕組み）を同時に管理し、連携して処理したい場合に利用されるクラスです。

rewind()メソッドは、MultipleIterator自体と、それにアタッチ（紐付け）されたすべてのイテレータの現在位置を、それぞれの初期位置（先頭）にリセットするために使用されます。このメソッドは引数を一切取らず、戻り値もありません。

コードでは、まず果物の名前と数量という2つのArrayIteratorを作成し、それをMultipleIteratorにアタッチしています。最初のループでは意図的に処理を途中で停止させ、イテレータの現在位置が先頭ではない状態を作り出します。その後、$multiIterator->rewind()を呼び出すことで、アタッチされたすべてのイテレータの内部ポインタが先頭にリセットされます。これにより、2回目のループでは、データが再び最初から処理される様子が確認でき、rewind()の機能が明確に示されています。