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

getRegexメソッドは、RecursiveRegexIteratorのインスタンスに現在設定されている正規表現パターンを取得するメソッドです。RecursiveRegexIteratorクラスは、ファイルシステムのような再帰的なデータ構造を扱うイテレータに対して、正規表現を用いたフィルタリングを適用するために利用されます。このクラスのインスタンスを生成する際には、コンストラクタにマッチングの基準となる正規表現パターンを指定します。getRegexメソッドを呼び出すと、そのコンストラクタで指定された正規表現パターンが文字列として返されます。このメソッドに引数は必要ありません。これにより、プログラムの実行中に、イテレータがどのようなルールで要素をフィルタリングしているかを動的に確認することが可能になります。例えば、デバッグ時に意図した正規表現が設定されているかを確認したり、取得したパターン文字列に基づいて処理を分岐させたりするような場面で役立ちます。戻り値は、現在フィルタリングに使用されている正規表現パターンを表す文字列です。

Copy
1<?php
2
3$arrayIterator = new RecursiveArrayIterator(['sample data']);
4$regex = '/^sample/';
5$regexIterator = new RecursiveRegexIterator($arrayIterator, $regex);
6
7$currentRegex = $regexIterator->getRegex();
8
9var_dump($currentRegex);
10
11?>

引数なし

引数はありません

string

このメソッドは、現在のイテレータが使用している正規表現パターンを文字列として返します。