【PHP8.x】RegexIterator::rewind()メソッドの使い方
rewindメソッドの使い方について、初心者にもわかりやすく解説します。
基本的な使い方
rewindメソッドは、イテレータを最初の要素に巻き戻す処理を実行するメソッドです。このメソッドは、PHPの標準インターフェースである Iterator インターフェースの一部として定義されており、オブジェクトを foreach ループなどで反復処理するために不可欠な機能です。RegexIterator クラスもこのインターフェースを実装しています。foreach ループなどで RegexIterator オブジェクトの反復処理が開始される際、PHPのエンジンはまず内部的にこの rewind メソッドを呼び出します。これにより、イテレータの内部ポインタがコレクションの先頭にリセットされ、常に最初の要素から処理が開始されることが保証されます。RegexIterator の場合、このメソッドはコンストラクタで渡された内部イテレータ自身の rewind メソッドを呼び出し、正規表現によるフィルタリング処理を最初から行えるように準備を整えます。通常、開発者がこのメソッドを明示的に呼び出す必要はなく、PHPの反復処理の仕組みの中で自動的に利用されます。このメソッドは値を返しません。
構文(syntax)
1<?php 2// イテレート対象の配列 3$fruits = new ArrayIterator(['apple', 'banana', 'apricot', 'cherry']); 4 5// 'ap'で始まる文字列にマッチするイテレータ 6$regexIterator = new RegexIterator($fruits, '/^ap/'); 7 8// 1回目のループ 9foreach ($regexIterator as $value) { 10 // このループでイテレータは最後まで進む 11} 12 13// rewind() を呼び出してイテレータを先頭に戻す 14$regexIterator->rewind(); 15 16// rewind() 後、current() は最初の要素を指す 17echo $regexIterator->current(); // "apple" が出力される 18?>
引数(parameters)
引数なし
引数はありません
戻り値(return)
戻り値なし
戻り値はありません
サンプルコード
RegexIterator::rewind() による複数回走査
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()が正しく機能していることが確認できます。これにより、一度処理したデータを繰り返し利用するシナリオで、効率的なデータ操作が可能になります。
RegexIterator::rewind()メソッドは、イテレータをデータの先頭に巻き戻し、複数回のデータ走査を可能にするために使用します。このメソッドは引数も戻り値もありません。
重要な注意点として、rewind()が正しく機能するのは、RegexIteratorが内部でラップしている基盤イテレータ（今回のサンプルコードにおけるArrayIteratorのように）が「巻き戻し可能」な場合に限られます。PHPのネイティブなジェネレータは通常巻き戻し可能ではないため、ジェネレータをRegexIteratorに渡した場合は、rewind()が期待通りに動作しない可能性があります。常に基盤イテレータの特性を理解し、適切に利用することが大切です。