【PHP8.x】getModeメソッドの使い方

『getModeメソッドは、RegexIteratorの現在の動作モードを取得するメソッドです』 RegexIteratorクラスは、配列などの繰り返し可能なデータの中から、指定した正規表現に一致する要素だけをフィルタリングして取り出す機能を提供します。その際に、正規表現に一致した要素をどのような形式で返すかを「動作モード」として設定します。この動作モードは、RegexIteratorのインスタンスを生成する際のコンストラクタで指定され、getModeメソッドを使用することで、現在設定されているモードを確認できます。このメソッドは、動作モードを表す整数値の定数を返します。返される値には、一致した値をそのまま返すデフォルトのRegexIterator::MATCH、一致したすべての結果を配列で返すRegexIterator::GET_MATCH、正規表現で文字列を分割した結果を返すRegexIterator::SPLITなどがあります。プログラムの実行中に、イテレータがどのようなルールでデータを処理しているかを動的に確認したい場合などに利用されます。

Copy
1<?php
2$arrayIterator = new ArrayIterator(['test1', 'test2', 'another test']);
3
4// RegexIterator を作成する際に動作モードを指定します
5$regexIterator = new RegexIterator($arrayIterator, '/^test/', RegexIterator::GET_MATCH);
6
7// getMode() メソッドで現在の動作モードを取得します
8$mode = $regexIterator->getMode();
9
10// 取得したモード（この場合は RegexIterator::GET_MATCH の定数値である 1）を出力します
11var_dump($mode);
12?>

引数なし

引数はありません

int

getModeメソッドは、RegexIteratorが現在使用しているモードを示す整数値を返します。