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

Copy
1<?php
2
3/**
4 * RecursiveRegexIterator::setMode() メソッドのデモンストレーションを行います。
5 * このメソッドは、RecursiveRegexIteratorが正規表現のマッチ結果をどのように返すかを設定します。
6 * (ただし、foreachでイテレートする際の $value に直接影響するわけではなく、getMatch() メソッドの戻り値に影響します。)
7 *
8 * システムエンジニアを目指す初心者の方へ:
9 * RecursiveRegexIteratorは、ディレクトリを再帰的に走査しながら、
10 * ファイルやディレクトリの名前を正規表現でフィルタリングするために使われます。
11 * setMode() メソッドを使うと、マッチした情報を取り出す際の形式を変更できます。
12 */
13function demonstrateRecursiveRegexIteratorSetMode(): void
14{
15    // テスト用のディレクトリとファイルを準備します。
16    // スクリプトが単体で動作するために必要です。
17    setupTestFiles();
18
19    try {
20        echo "RecursiveRegexIterator::setMode() のデモンストレーション:\n\n";
21
22        // 1. 検索対象のディレクトリを設定します。
23        $directoryIterator = new RecursiveDirectoryIterator(__DIR__ . '/data');
24        
25        // 2. ディレクトリを再帰的に走査するためのイテレータを作成します。
26        //    これにより、サブディレクトリ内のファイルも対象になります。
27        $recursiveIterator = new RecursiveIteratorIterator($directoryIterator);
28        
29        // 3. 正規表現でフィルタリングするイテレータを作成します。
30        //    ここでは、拡張子が ".txt" のファイルを検索し、ファイル名部分をキャプチャする正規表現を使用します。
31        $regexPattern = '/(file\d+)\.txt$/i';
32        $regexIterator = new RecursiveRegexIterator($recursiveIterator, $regexPattern);
33
34        // --- RecursiveRegexIterator::ALL_MATCHES モード (デフォルト) ---
35        echo "--- モード: RecursiveRegexIterator::ALL_MATCHES (デフォルト) ---\n";
36        // setMode() でモードを設定します。戻り値はありません。
37        // ALL_MATCHES モードでは、getMatch() はマッチしたすべてのキャプチャグループを含む配列を返します。
38        $regexIterator->setMode(RecursiveRegexIterator::ALL_MATCHES);
39        $regexIterator->rewind(); // モード変更後、イテレータをリセットして最初から走査し直します。
40
41        // イテレータを走査し、各要素の情報を表示します。
42        foreach ($regexIterator as $path => $fileInfo) {
43            echo "見つかったファイルパス: " . $path . "\n";
44            // getMatch() メソッドを使って、設定されたモードに応じたマッチ結果を取得します。
45            echo "  マッチ結果 (ALL_MATCHES): " . print_r($regexIterator->getMatch(), true) . "\n";
46            // $fileInfo は SPLFileInfo オブジェクトであり、setMode() の影響は受けません。
47            // setMode() は getMatch() の戻り値に影響を与えます。
48        }
49
50        echo "\n"; // 区切り
51
52        // --- RecursiveRegexIterator::GET_MATCH モード ---
53        echo "--- モード: RecursiveRegexIterator::GET_MATCH ---\n";
54        // GET_MATCH モードでは、getMatch() はマッチした文字列全体を返します。
55        $regexIterator->setMode(RecursiveRegexIterator::GET_MATCH);
56        $regexIterator->rewind(); // モード変更後、イテレータをリセットします。
57
58        foreach ($regexIterator as $path => $fileInfo) {
59            echo "見つかったファイルパス: " . $path . "\n";
60            echo "  マッチ結果 (GET_MATCH): " . print_r($regexIterator->getMatch(), true) . "\n";
61        }
62
63        echo "\n"; // 区切り
64
65        // --- RecursiveRegexIterator::GET_FLAGS モード ---
66        echo "--- モード: RecursiveRegexIterator::GET_FLAGS ---\n";
67        // GET_FLAGS モードでは、getMatch() はマッチした際に設定されたフラグの整数値を返します。
68        $regexIterator->setMode(RecursiveRegexIterator::GET_FLAGS);
69        $regexIterator->rewind(); // モード変更後、イテレータをリセットします。
70
71        foreach ($regexIterator as $path => $fileInfo) {
72            echo "見つかったファイルパス: " . $path . "\n";
73            echo "  マッチ結果 (GET_FLAGS): " . print_r($regexIterator->getMatch(), true) . "\n";
74        }
75
76        // RecursiveRegexIterator::REPLACE モードも存在しますが、
77        // setReplacement() と組み合わせて使うため、初心者向けには複雑すぎるのでここでは割愛します。
78
79    } finally {
80        // デモンストレーション後に作成したテストファイルをクリーンアップします。
81        cleanupTestFiles();
82    }
83}
84
85/**
86 * テスト用のディレクトリとファイルを準備するヘルパー関数です。
87 * このスクリプトが単体で動作するために使用されます。
88 */
89function setupTestFiles(): void
90{
91    $baseDir = __DIR__ . '/data';
92    if (!is_dir($baseDir)) {
93        mkdir($baseDir, 0777, true);
94    }
95    file_put_contents($baseDir . '/file1.txt', 'これはファイル1の内容です。');
96    file_put_contents($baseDir . '/another.log', 'ログエントリです。');
97    mkdir($baseDir . '/subdir', 0777, true);
98    file_put_contents($baseDir . '/subdir/file2.txt', 'これはファイル2の内容です。');
99    file_put_contents($baseDir . '/subdir/test.php', '<?php echo "Hello, PHP!";');
100    file_put_contents($baseDir . '/README.md', 'READMEファイルの内容です。');
101    echo "テストファイルが 'data/' ディレクトリに作成されました。\n\n";
102}
103
104/**
105 * 作成したテストファイルをクリーンアップするヘルパー関数です。
106 * スクリプトの実行後にテストデータを削除します。
107 */
108function cleanupTestFiles(): void
109{
110    $baseDir = __DIR__ . '/data';
111    if (is_dir($baseDir)) {
112        // RecursiveDirectoryIterator と RecursiveIteratorIterator を使って、
113        // サブディレクトリを含めて全てのファイルを削除します。
114        $iterator = new RecursiveDirectoryIterator($baseDir, FilesystemIterator::SKIP_DOTS);
115        $recursiveIterator = new RecursiveIteratorIterator($iterator, RecursiveIteratorIterator::CHILD_FIRST);
116        foreach ($recursiveIterator as $file) {
117            if ($file->isDir()) {
118                rmdir($file->getPathname());
119            } else {
120                unlink($file->getPathname());
121            }
122        }
123        rmdir($baseDir);
124        echo "\nテストファイルと 'data/' ディレクトリがクリーンアップされました。\n";
125    }
126}
127
128// スクリプトを実行します。
129demonstrateRecursiveRegexIteratorSetMode();
130

RecursiveRegexIterator::setMode()メソッドは、PHPのRecursiveRegexIteratorクラスにおいて、正規表現のマッチ結果をどのように取得するかを設定するために使用されます。このクラスは、ディレクトリを再帰的に走査しながら、ファイルやディレクトリの名前を正規表現でフィルタリングする際に役立ちます。

このメソッドはint $modeという整数型の引数を一つ取ります。この引数によって、RecursiveRegexIteratorが内部的に保持するマッチ情報のうち、getMatch()メソッドを呼び出した際にどの形式で結果を返すかが決まります。

例えば、RecursiveRegexIterator::ALL_MATCHESを指定すると、正規表現にマッチした文字列全体とそのキャプチャグループの全てを含む配列がgetMatch()から返されます。RecursiveRegexIterator::GET_MATCHを設定した場合は、マッチした文字列全体のみが返されます。さらに、RecursiveRegexIterator::GET_FLAGSを指定すると、マッチした際に設定されたフラグの整数値が返されるようになります。

setMode()メソッド自体には戻り値がありません。この設定は、イテレータをforeachで走査する際の$value（ファイル情報オブジェクトなど）に直接影響を与えるものではなく、あくまでgetMatch()メソッドの呼び出し結果に影響を与える点に注意が必要です。サンプルコードでは、異なるモードを設定することでgetMatch()の出力がどのように変化するかを示しており、これにより正規表現によるフィルタリング結果を柔軟に利用できます。

Copy
1<?php
2
3// RecursiveRegexIterator::setMode() メソッドのサンプルコード
4// このメソッドは、RecursiveRegexIterator が正規表現マッチングの結果をどのように返すかを制御します。
5// システムエンジニアを目指す初心者の方にも理解しやすいように、ファイルシステムを模倣した例を使います。
6
7// 例として、ネストされた配列（ディレクトリ構造を模倣）を用意します。
8$directoryStructure = [
9    'application' => [
10        'controllers' => [
11            'UserController.php',
12            'ProductController.php',
13            'BaseController.php.bak', // マッチしない例
14        ],
15        'models' => [
16            'User.php',
17            'Product.php',
18            'Config.json', // マッチしない例
19        ],
20        'views' => [
21            'user_list.html',
22            'product_detail.html',
23        ],
24        'utils' => [
25            'Helper.php',
26        ],
27    ],
28    'tests' => [
29        'unit' => [
30            'UserTest.php',
31        ],
32    ],
33    'README.md', // マッチしない例
34    'index.php',
35];
36
37// 1. RecursiveArrayIterator を使って、用意した配列を再帰的に反復処理可能なイテレータに変換します。
38$arrayIterator = new RecursiveArrayIterator($directoryStructure);
39
40// 2. RecursiveRegexIterator を作成し、.php ファイルを検索する正規表現を設定します。
41//    最初の引数には RecursiveIterator オブジェクト（ここでは $arrayIterator）を渡します。
42//    初期モードとして RecursiveRegexIterator::MATCH を使用します。
43//    このモードでは、正規表現にマッチした元の要素がそのまま返されます。
44$regexIterator = new RecursiveRegexIterator(
45    $arrayIterator,
46    '/\.php$/i', // 大文字小文字を区別せず、'.php' で終わる文字列を検索
47    RecursiveRegexIterator::MATCH // 初期モード：マッチする元の要素を返す
48);
49
50echo "--- 1. RecursiveRegexIterator::MATCH モードでの検索結果 ---\n";
51echo "（マッチする元の要素がそのまま返されます。）\n";
52// RecursiveIteratorIterator を使って、ネストされた全ての要素を平坦化し、処理します。
53foreach (new RecursiveIteratorIterator($regexIterator) as $file) {
54    echo "見つかったファイル: " . $file . "\n";
55}
56echo "\n";
57
58// 3. setMode() メソッドを使って、イテレータのモードを変更します。
59//    RecursiveRegexIterator::ALL_MATCHES モードに設定すると、
60//    正規表現にマッチしたすべての部分文字列が配列として返されます。
61//    今回の正規表現ではファイル名全体がマッチするため、そのファイル名が要素一つだけ含まれる配列として返されます。
62$regexIterator->setMode(RecursiveRegexIterator::ALL_MATCHES);
63
64echo "--- 2. RecursiveRegexIterator::ALL_MATCHES モードでの検索結果 ---\n";
65echo "（マッチした部分文字列が配列として返されます。例: ['FileName.php']）\n";
66foreach (new RecursiveIteratorIterator($regexIterator) as $matches) {
67    // $matches は配列であり、[0] に正規表現全体のマッチ結果が含まれます。
68    echo "見つかったファイル (ALL_MATCHES): " . $matches[0] . "\n";
69}
70echo "\n";
71
72// 4. 再び setMode() メソッドを使って、別のモードに変更します。
73//    RecursiveRegexIterator::GET_MATCH モードに設定すると、
74//    正規表現全体のマッチ結果が文字列として直接返されます。
75$regexIterator->setMode(RecursiveRegexIterator::GET_MATCH);
76
77echo "--- 3. RecursiveRegexIterator::GET_MATCH モードでの検索結果 ---\n";
78echo "（マッチした全体が文字列として直接返されます。）\n";
79foreach (new RecursiveIteratorIterator($regexIterator) as $matchString) {
80    echo "見つかったファイル (GET_MATCH): " . $matchString . "\n";
81}
82echo "\n";
83
84?>

PHPのRecursiveRegexIterator::setMode()メソッドは、RecursiveRegexIteratorが正規表現で要素をフィルタリングする際に、その結果をどのような形式で返すかを制御します。このメソッドは、int $modeという引数を一つ受け取ります。$modeには、RecursiveRegexIteratorクラスが提供する特定の定数を指定し、イテレータの出力形式を切り替えることができます。

サンプルコードでは、.phpファイルを探す例を通してモードの違いを示しています。 初期設定のRecursiveRegexIterator::MATCHモードでは、正規表現にマッチした元の要素（ファイル名そのもの）がそのまま返されます。 次にsetMode()を使いRecursiveRegexIterator::ALL_MATCHESモードに変更すると、正規表現にマッチしたすべての部分文字列が配列として返されるようになります。今回の例では、マッチしたファイル名が['ファイル名.php']のように配列の要素として出力されます。 さらにRecursiveRegexIterator::GET_MATCHモードに設定し直すと、正規表現全体のマッチ結果が文字列として直接返されるようになります。結果としてファイル名.phpという文字列がそのまま出力されます。

このメソッドには戻り値はありません。一度モードを設定すると、RecursiveRegexIteratorは以降そのモードで結果を返します。setMode()を使うことで、正規表現による検索で得られる情報を、用途に応じて最適な形式で受け取ることが可能になります。