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

Copy
1<?php
2
3// PHPの正規表現（Regex）は、特定の文字列パターンを検索、置換、検証するために使われます。
4// RecursiveRegexIterator は、再帰的なデータ構造（例: ディレクトリツリー）を走査しながら、
5// 正規表現にマッチする要素をフィルタリングする際に利用されるイテレータです。
6// getRegex() メソッドは、このイテレータに設定されている正規表現文字列を取得します。
7
8// --- サンプルコードの準備 ---
9// テスト用に一時的なディレクトリとファイルを作成します。
10$tempDir = __DIR__ . '/temp_dir_for_regex_test';
11if (!is_dir($tempDir)) {
12    mkdir($tempDir);
13}
14file_put_contents($tempDir . '/document.txt', 'これはテキストファイルです。');
15file_put_contents($tempDir . '/image.jpg', 'これは画像ファイルです。');
16file_put_contents($tempDir . '/report.docx', 'これはWord文書です。');
17mkdir($tempDir . '/archive');
18file_put_contents($tempDir . '/archive/old_log.txt', '古いログファイル。');
19file_put_contents($tempDir . '/archive/backup.zip', 'バックアップファイル。');
20
21try {
22    // 1. RecursiveDirectoryIterator を作成し、指定したディレクトリを再帰的に走査できるようにします。
23    $directoryIterator = new RecursiveDirectoryIterator($tempDir);
24
25    // 2. RecursiveRegexIterator を作成し、フィルタリングしたい正規表現を指定します。
26    //    ここでは、ファイル名が '.txt' で終わる（大文字小文字を区別しない）ファイルを検索する正規表現を設定します。
27    //    i フラグは、大文字と小文字を区別しない検索を意味します。
28    $regex = '/\.txt$/i';
29    $regexIterator = new RecursiveRegexIterator(
30        $directoryIterator,
31        $regex,
32        RecursiveRegexIterator::GET_MATCH
33    );
34
35    // 3. getRegex() メソッドを呼び出して、このイテレータに設定されている正規表現文字列を取得し表示します。
36    echo "このイテレータに設定された正規表現: " . $regexIterator->getRegex() . "\n\n";
37
38    // 4. RecursiveIteratorIterator を使用して、RecursiveRegexIterator がフィルタリングした要素を実際に走査します。
39    echo "正規表現 '" . $regexIterator->getRegex() . "' にマッチするファイル:\n";
40    $iterator = new RecursiveIteratorIterator($regexIterator);
41    foreach ($iterator as $path => $fileInfo) {
42        // SplFileInfo オブジェクトからファイル名を取得し表示します。
43        echo "- " . $fileInfo->getFilename() . "\n";
44    }
45
46} catch (Exception $e) {
47    echo "エラーが発生しました: " . $e->getMessage() . "\n";
48} finally {
49    // --- 後処理 ---
50    // テスト用に作成したディレクトリとファイルを削除します。
51    function deleteDirectory($dir) {
52        if (!is_dir($dir)) {
53            return;
54        }
55        $files = array_diff(scandir($dir), array('.', '..'));
56        foreach ($files as $file) {
57            (is_dir("$dir/$file")) ? deleteDirectory("$dir/$file") : unlink("$dir/$file");
58        }
59        rmdir($dir);
60    }
61    deleteDirectory($tempDir);
62}

PHPのRecursiveRegexIterator::getRegexメソッドは、再帰的なデータ構造（例えば、フォルダとその中のサブフォルダにあるファイル群）を特定のパターンで絞り込むRecursiveRegexIteratorというクラスが、フィルタリングのために内部にどのような正規表現を設定しているかを取得するものです。PHPにおける正規表現（Regex）とは、文字列の中から特定のパターンを持つ部分を検索したり、置換したり、検証したりする際に用いる強力な記述方法です。

getRegex()メソッドは引数を必要とせず、呼び出すと、そのRecursiveRegexIteratorオブジェクトに設定されている正規表現の文字列をstring型でそのまま返します。

サンプルコードでは、まず一時的なファイル構造を作成し、RecursiveDirectoryIteratorとRecursiveRegexIteratorを使ってディレクトリ内のファイルを走査しています。このとき、ファイル名が.txtで終わるファイル（大文字小文字を区別しない/\.txt$/i）を対象とする正規表現を設定しています。getRegex()メソッドは、この設定された正規表現文字列を正確に取得し、表示するために利用されています。これにより、どの正規表現がイテレータに適用されているかを簡単に確認でき、後続の処理で実際に正規表現にマッチするファイルがリストアップされる様子が示されています。

Copy
1<?php
2
3/**
4 * RecursiveRegexIterator::getRegex() の使用例
5 *
6 * このスクリプトは、RecursiveRegexIterator が内部で使用している正規表現パターンを取得し、
7 * そのパターンに基づいてデータがどのようにフィルタリングされるかを示します。
8 * RecursiveRegexIterator は、再帰的なイテレータを正規表現でフィルタリングする際に使用されます。
9 */
10
11// フィルタリング対象となるデータの配列を準備します。
12$data = [
13    'apple',
14    'banana',
15    'orange',
16    'apricot',
17    'grape',
18    'avocado',
19];
20
21// 配列を再帰的なイテレータでラップします。
22// RecursiveArrayIterator は配列をRecursiveIteratorインターフェースとして扱えるようにします。
23$arrayIterator = new RecursiveArrayIterator($data);
24
25// RecursiveRegexIterator に渡す正規表現パターンを定義します。
26// この例では、「'a' で始まる文字列」にマッチするパターンを使用します。
27$regexPattern = '/^a/';
28
29// RecursiveRegexIterator を初期化します。
30// 第1引数にはフィルタリング対象のRecursiveIteratorを、
31// 第2引数には使用する正規表現パターンを指定します。
32$regexIterator = new RecursiveRegexIterator($arrayIterator, $regexPattern);
33
34// getRegex() メソッドを呼び出して、このイテレータが現在使用している
35// 正規表現パターンを取得し、表示します。
36$currentRegex = $regexIterator->getRegex();
37echo "このイテレータで使用されている正規表現パターン: " . $currentRegex . "\n\n";
38
39echo "正規表現 '" . $currentRegex . "' にマッチする要素:\n";
40// RecursiveRegexIterator を foreach でループすると、
41// 設定された正規表現パターンにマッチする要素のみが処理されます。
42foreach ($regexIterator as $value) {
43    echo "  - " . $value . "\n";
44}
45
46?>

PHP 8のRecursiveRegexIterator::getRegex()メソッドは、RecursiveRegexIteratorオブジェクトが現在フィルタリングに使用している正規表現パターンを取得する際に利用されます。このRecursiveRegexIteratorクラスは、配列などの再帰的なデータ構造を、指定された正規表現に基づいて効率的にフィルタリングするために設計されています。getRegex()メソッドは引数を一切受け取らず、string型の戻り値として、設定されている正規表現パターンそのものを返します。

サンプルコードでは、まず文字列の配列が用意され、これをRecursiveArrayIteratorでラップすることで、再帰的なイテレータとして扱えるようにしています。次に、RecursiveRegexIteratorのコンストラクタに、対象のイテレータと、データに対するフィルタリング基準となる正規表現パターン /^a/ （「a」で始まる文字列にマッチ）を渡して初期化します。

$regexIterator->getRegex()を呼び出すことにより、このRecursiveRegexIteratorが内部で利用している正規表現パターン /^a/ が正確に取得され、その内容が表示されます。その後、foreachループで$regexIteratorを処理すると、取得された正規表現パターン /^a/ に基づいて元の配列から「apple」、「apricot」、「avocado」といった「a」で始まる要素のみが抽出され、出力されることが示されています。このメソッドは、イテレータがどのようなフィルタリングルールで動作しているかを確認したい場合に役立ちます。