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

getModeメソッドは、RecursiveRegexIteratorオブジェクトの現在の動作モードを取得するために実行するメソッドです。RecursiveRegexIteratorは、再帰的なイテレータが返す値に対して正規表現によるフィルタリングを行うためのクラスです。その際の動作は、インスタンス作成時に「モード」と呼ばれる設定値によって決定されます。このモードには、正規表現にマッチしたすべての結果を返す ALL_MATCHES、マッチした最初の部分文字列のみを返す GET_MATCH、あるいは正規表現を区切り文字として文字列を分割する SPLIT など、複数の定数が定義されています。getModeメソッドを呼び出すと、コンストラクタで指定されたこれらのモードに対応する整数値が返されます。これにより、開発者はプログラムの実行中にイテレータが現在どのモードで動作しているかを確認でき、その結果に応じて処理を条件分岐させるなど、より柔軟な制御を実装することが可能になります。

Copy
1public RecursiveRegexIterator::getMode(): int

引数なし

引数はありません

int

このメソッドは、イテレータが現在選択している正規表現マッチモードを表す整数を返します。