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

Copy
1<?php
2
3/**
4 * RegexIterator::rewind() メソッドの動作を示すサンプルコード。
5 *
6 * RegexIterator は内部のイテレータ（ここでは ArrayIterator）をラップし、
7 * 正規表現に基づいて要素をフィルタリングします。
8 * rewind() メソッドを呼び出すことで、イテレータをデータの先頭に巻き戻し、
9 * 複数回にわたるデータ走査を可能にします。
10 *
11 * PHPのネイティブなジェネレータは通常巻き戻し可能ではありませんが、
12 * RegexIterator が巻き戻し可能なイテレータ（ArrayIteratorなど）を基盤とすることで、
13 * その rewind() メソッドが機能します。
14 */
15
16// サンプルデータとして文字列の配列を用意します
17$data = [
18    'apple pie',
19    'banana split',
20    'cherry bomb',
21    'apple juice',
22    'orange crush',
23    'apricot jam',
24];
25
26// ArrayIterator は巻き戻し可能なイテレータの一例です。
27// これを RegexIterator の基盤イテレータとして使用します。
28$arrayIterator = new ArrayIterator($data);
29
30// 'apple' または 'apricot' で始まる単語をフィルタリングする RegexIterator を作成します。
31// RegexIterator::MATCH モードは、マッチした要素（キーと値）を返します。
32$regexIterator = new RegexIterator(
33    $arrayIterator,
34    '/^(apple|apricot)/', // 正規表現パターン
35    RegexIterator::MATCH, // マッチした要素を返す
36    RegexIterator::USE_KEY // キーも保持する
37);
38
39echo "--- 1回目のイテレーション ---\n";
40// 最初のイテレーションで、フィルタリングされた要素を表示します
41foreach ($regexIterator as $key => $value) {
42    // $value はRegexIterator::MATCHモードの場合、マッチ全体とキャプチャグループを含む配列になります
43    echo "キー: $key, 元の値: " . $arrayIterator[$key] . ", マッチ: " . $value[0] . "\n";
44}
45
46// RegexIterator の rewind() メソッドを呼び出し、イテレータを先頭に巻き戻します。
47// これにより、もう一度最初からイテレーションを開始できるようになります。
48// 引数なし、戻り値なしのメソッドです。
49$regexIterator->rewind();
50
51echo "\n--- 2回目のイテレーション（rewind()後）---\n";
52// rewind() 後の2回目のイテレーションで、再び同じ要素が表示されることを確認します
53foreach ($regexIterator as $key => $value) {
54    echo "キー: $key, 元の値: " . $arrayIterator[$key] . ", マッチ: " . $value[0] . "\n";
55}

RegexIterator::rewind()メソッドは、イテレータをデータの先頭に巻き戻すために使用されます。RegexIteratorは、内部のイテレータ（ここではArrayIterator）をラップし、正規表現を用いて要素をフィルタリングしながらデータを走査します。通常、イテレータは一度最後まで走査すると、それ以上要素を処理できなくなりますが、rewind()メソッドを呼び出すことで、イテレータの状態がリセットされ、再度最初からデータの走査を開始できるようになります。

PHPの標準的なジェネレータは通常巻き戻しができませんが、RegexIteratorはArrayIteratorのような巻き戻し可能なイテレータを基盤とすることで、このrewind()機能を提供します。サンプルコードでは、まず文字列の配列をArrayIteratorでラップし、特定の正規表現にマッチする要素をRegexIteratorでフィルタリングします。1回目のイテレーションでフィルタリングされたデータが表示された後、$regexIterator->rewind()が呼び出されます。このメソッドには引数がなく、戻り値もありませんが、内部状態がリセットされます。その結果、2回目のイテレーションでも1回目と同じデータが再び最初から表示され、rewind()が正しく機能していることが確認できます。これにより、一度処理したデータを繰り返し利用するシナリオで、効率的なデータ操作が可能になります。

Copy
1<?php
2
3/**
4 * RegexIterator::rewind() メソッドの動作を示すサンプルコード。
5 *
6 * この関数は、RegexIterator を使用して配列から特定のパターンに一致する要素をフィルタリングし、
7 * イテレータを一度進めた後に rewind() メソッドで先頭に戻し、再イテレーションします。
8 *
9 * @return void
10 */
11function demonstrateRegexIteratorRewind(): void
12{
13    // フィルタリング対象となる文字列の配列
14    $fruits = [
15        'apple',
16        'banana',
17        'apricot',
18        'grape',
19        'avocado',
20        'orange',
21        'kiwi',
22    ];
23
24    // ArrayIterator を作成し、配列をイテラブルにする
25    $arrayIterator = new ArrayIterator($fruits);
26
27    // RegexIterator を作成し、'a' (大文字・小文字を区別しない) で始まる要素をフィルタリング
28    // RegexIterator::MATCH フラグは、パターンに一致する要素のみを返します
29    $regexIterator = new RegexIterator(
30        $arrayIterator,
31        '/^a/i', // 'a' または 'A' で始まるパターン
32        RegexIterator::MATCH
33    );
34
35    echo "--- 最初のイテレーション (イテレータが進みます) ---\n";
36    foreach ($regexIterator as $key => $value) {
37        echo "キー: " . $key . ", 値: " . $value . "\n";
38    }
39    // この時点で $regexIterator はイテレーションの終端に達しています。
40
41    echo "\n--- rewind() メソッドの呼び出し ---\n";
42    // rewind() を呼び出すことで、RegexIterator とその内部の ArrayIterator は
43    // 最初の要素にリセットされます。
44    $regexIterator->rewind();
45    echo "RegexIterator::rewind() が呼び出されました。イテレータは先頭に戻りました。\n";
46
47    echo "\n--- 2回目のイテレーション (rewind() 後) ---\n";
48    // rewind() 後、もう一度イテレーションが可能になります。
49    foreach ($regexIterator as $key => $value) {
50        echo "キー: " . $key . ", 値: " . $value . "\n";
51    }
52
53    echo "\n--- 動作確認完了 ---\n";
54}
55
56// 関数の実行
57demonstrateRegexIteratorRewind();
58

PHP 8のRegexIterator::rewind()メソッドは、イテレータの現在位置を先頭に戻すために使われます。このメソッドは引数を受け取らず、戻り値もありませんが、イテレータを初期状態にリセットする重要な役割があります。

サンプルコードでは、まず文字列の配列をArrayIteratorとRegexIteratorで処理し、「a」で始まる要素のみをフィルタリングしています。最初のforeachループでイテレータを最後まで進めると、条件に一致する「apple」「apricot」「avocado」が出力され、イテレータは終端に達します。この状態では、再度ループを実行しても何も表示されません。

ここで$regexIterator->rewind();を呼び出すと、RegexIteratorは内部のArrayIteratorを含め、現在位置を最初の要素にリセットします。これにより、イテレータは再び最初から要素を処理できるようになります。rewind()後の2回目のforeachループでは、初回と同じ要素が再度出力され、イテレータが先頭に戻ったことが確認できます。

rewind()メソッドは、一度データ処理が終わったイテレータを再利用し、複数回データセットを走査したい場合に非常に有用です。

Copy
1<?php
2
3/**
4 * RegexIterator::rewind の動作を示すサンプルコード。
5 *
6 * このコードは一時ファイルを作成し、RegexIterator を使用してその内容を読み込みます。
7 * RegexIterator::rewind() メソッドを呼び出すことで、イテレータ（およびラップされたファイルイテレータ）が
8 * データの先頭に戻る様子を示します。
9 *
10 * キーワード「php rewind file」に関連付けて、SplFileObject をラップする例を採用しています。
11 */
12
13// 1. 一時ファイルを作成し、テストデータを書き込む
14$filename = 'sample_data.txt';
15$fileContent = "Line 1: Apple\nLine 2: Banana\nLine 3: Cherry\nLine 4: Date\nLine 5: Elderberry\n";
16
17// ファイルが存在する場合は上書き、存在しない場合は新規作成
18file_put_contents($filename, $fileContent);
19
20try {
21    // 2. SplFileObject を作成し、ファイルを開く
22    // 'r' モードで読み込み専用として開く
23    $file = new SplFileObject($filename, 'r');
24
25    // 3. SplFileObject をラップする RegexIterator を作成
26    // ここでは「Line」で始まる行のみをフィルタリングする正規表現を使用します
27    $iterator = new RegexIterator($file, '/^Line/', RegexIterator::MATCH);
28
29    echo "--- 最初のイテレーション（途中で停止）---\n";
30    $count = 0;
31    foreach ($iterator as $key => $line) {
32        echo "  " . trim($line) . " (キー: $key)\n";
33        $count++;
34        // 最初の2つの要素だけを処理し、イテレータが途中の位置にある状態を作る
35        if ($count >= 2) {
36            break;
37        }
38    }
39    echo "現在のイテレータは途中の位置にあります。\n\n";
40
41    // 4. RegexIterator::rewind() メソッドを呼び出す
42    // これにより、イテレータはデータの先頭に戻ります
43    // ラップされている SplFileObject のファイルポインタも先頭に戻されます
44    echo "--- RegexIterator::rewind() を呼び出します ---\n\n";
45    $iterator->rewind();
46
47    echo "--- 巻き戻し後のイテレーション（最初から再開）---\n";
48    foreach ($iterator as $key => $line) {
49        // イテレータが先頭から再開したことを確認するため、全ての行を表示
50        echo "  " . trim($line) . " (キー: $key)\n";
51    }
52    echo "\nイテレータは先頭から再開しました。\n";
53
54} catch (Exception $e) {
55    // ファイル操作やイテレータ処理中にエラーが発生した場合の処理
56    echo "エラーが発生しました: " . $e->getMessage() . "\n";
57} finally {
58    // 5. 後処理として、作成した一時ファイルを削除
59    if (file_exists($filename)) {
60        unlink($filename);
61        echo "\n一時ファイル '{$filename}' を削除しました。\n";
62    }
63}
64
65?>

PHP 8のRegexIterator::rewindメソッドは、イテレータの現在位置をデータソースの先頭に巻き戻します。このメソッドは引数を取らず、戻り値もありません。一度イテレーション（繰り返し処理）を開始したイテレータを、再び最初から処理したい場合に利用されます。

サンプルコードでは、まず一時的なテキストファイルを作成し、複数の行を書き込みます。次に、このファイルをSplFileObjectで開いてRegexIteratorでラップし、特定の正規表現（「Line」で始まる行）にマッチする行のみをフィルタリングします。

コードの最初のイテレーションでは、途中でループを中断させ、イテレータがデータの途中の位置にある状態を作ります。その後で$iterator->rewind();を呼び出すと、RegexIteratorはラップしているSplFileObjectのファイルポインタを含め、その位置をデータソースの先頭に戻します。これにより、2回目のイテレーションでは、フィルタリングされたデータが再び最初から全て表示されることが確認できます。これは「php rewind file」というキーワードが示すように、ファイルの内容を最初から読み直す際にも特に役立つ挙動です。処理の最後には、作成した一時ファイルを削除しています。