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

Copy
1<?php
2
3// 一時ディレクトリのパスを生成
4$tempDir = sys_get_temp_dir() . DIRECTORY_SEPARATOR . uniqid('recursive_regex_');
5
6/**
7 * 指定されたディレクトリとその内容を再帰的に削除するクリーンアップ関数。
8 * スクリプト終了時に実行されるように登録されます。
9 *
10 * @param string $dir 削除するディレクトリのパス
11 */
12$cleanup = function (string $dir) {
13    if (!is_dir($dir)) {
14        return;
15    }
16
17    // RecursiveDirectoryIterator を使ってディレクトリ内のファイルやサブディレクトリを全て走査
18    $iterator = new RecursiveIteratorIterator(
19        new RecursiveDirectoryIterator($dir, RecursiveDirectoryIterator::SKIP_DOTS),
20        RecursiveIteratorIterator::CHILD_FIRST
21    );
22
23    foreach ($iterator as $fileinfo) {
24        if ($fileinfo->isDir()) {
25            rmdir($fileinfo->getRealPath()); // ディレクトリを削除
26        } else {
27            unlink($fileinfo->getRealPath()); // ファイルを削除
28        }
29    }
30    rmdir($dir); // 空になったルートディレクトリを削除
31};
32
33// スクリプトの実行終了時にクリーンアップ関数が自動的に実行されるように登録
34register_shutdown_function($cleanup, $tempDir);
35
36try {
37    // 一時ディレクトリを作成
38    if (!mkdir($tempDir, 0777, true)) {
39        throw new Exception("一時ディレクトリの作成に失敗しました: " . $tempDir);
40    }
41
42    // テスト用のファイルをいくつか作成
43    file_put_contents($tempDir . DIRECTORY_SEPARATOR . 'report_A.txt', 'Content for report A');
44    file_put_contents($tempDir . DIRECTORY_SEPARATOR . 'log_2023.log', 'Log entry line.');
45    file_put_contents($tempDir . DIRECTORY_SEPARATOR . 'document_B.pdf', 'PDF binary data.');
46    file_put_contents($tempDir . DIRECTORY_SEPARATOR . 'report_C.txt', 'Content for report C');
47
48    // サブディレクトリを作成し、中にファイルを作成
49    mkdir($tempDir . DIRECTORY_SEPARATOR . 'archive');
50    file_put_contents($tempDir . DIRECTORY_SEPARATOR . 'archive' . DIRECTORY_SEPARATOR . 'old_report.txt', 'Archived content.');
51    file_put_contents($tempDir . DIRECTORY_SEPARATOR . 'archive' . DIRECTORY_SEPARATOR . 'important.data', 'Binary data.');
52
53    echo "--- RecursiveRegexIterator::setFlags の使用例 ---\n\n";
54
55    // 1. ディレクトリを再帰的に走査するイテレータを作成
56    // RecursiveDirectoryIterator は、指定されたディレクトリ内のファイルやサブディレクトリを扱います。
57    // SKIP_DOTS フラグは '.' (カレントディレクトリ) と '..' (親ディレクトリ) を無視します。
58    $dirIterator = new RecursiveDirectoryIterator($tempDir, RecursiveDirectoryIterator::SKIP_DOTS);
59
60    // RecursiveIteratorIterator は、RecursiveDirectoryIterator と組み合わせて、
61    // ディレクトリツリー全体を再帰的に走査し、各要素を平坦なリストのように扱えるようにします。
62    $recursiveIterator = new RecursiveIteratorIterator($dirIterator);
63
64    // 2. RecursiveRegexIterator を作成し、ファイル名を正規表現でフィルタリング
65    // ここでは、ファイル名が '.txt' で終わるファイルを検索します。
66    // 初期フラグとして RecursiveRegexIterator::MATCH を設定します。
67    // これは、正規表現にマッチした要素のみを返すというデフォルトの動作です。
68    $regexIterator = new RecursiveRegexIterator(
69        $recursiveIterator,
70        '/^.+\.txt$/i', // 正規表現パターン: '.txt' で終わるファイル名 (大文字小文字を区別しない)
71        RecursiveRegexIterator::MATCH // 初期フラグ: マッチした要素のみを返す
72    );
73
74    echo "--- デフォルトの動作 (RecursiveRegexIterator::MATCH) ---\n";
75    echo "  ファイル名が '.txt' で終わるファイルパスを取得します。\n";
76    foreach ($regexIterator as $fileInfo) {
77        // RecursiveRegexIterator は通常、SplFileInfo オブジェクトを返します。
78        // SplFileInfo オブジェクトは、ファイルに関する様々な情報を提供します。
79        echo "マッチしたファイル: " . $fileInfo->getPathname() . "\n";
80    }
81    echo "\n";
82
83    // 3. setFlags() メソッドを使用して、イテレータの動作を変更
84    // RecursiveRegexIterator::GET_MATCH を設定すると、正規表現にマッチした部分が配列で返されます。
85    // この場合、イテレータが返す各要素は SplFileInfo オブジェクトではなく、
86    // 正規表現のマッチ結果を含む配列になります。
87    $regexIterator->setFlags(RecursiveRegexIterator::GET_MATCH);
88
89    echo "--- setFlags(RecursiveRegexIterator::GET_MATCH) 設定後の動作 ---\n";
90    echo "  ファイル名が '.txt' で終わるものの、正規表現マッチ結果を配列で取得します。\n";
91    foreach ($regexIterator as $matchResult) {
92        // $matchResult は正規表現のマッチ結果を含む配列です。
93        // $matchResult[0] は正規表現に完全にマッチした文字列（この場合はファイルパス）です。
94        echo "マッチ結果配列: [ " . implode(", ", $matchResult) . " ]\n";
95    }
96    echo "\n";
97
98    // 4. setFlags() を再度使用して、イテレータの動作をさらに変更
99    // RecursiveRegexIterator::NOT_MATCH を設定すると、正規表現にマッチしなかった要素のみを返します。
100    // この場合、イテレータは再び SplFileInfo オブジェクトを返します。
101    $regexIterator->setFlags(RecursiveRegexIterator::NOT_MATCH);
102
103    echo "--- setFlags(RecursiveRegexIterator::NOT_MATCH) 設定後の動作 ---\n";
104    echo "  ファイル名が '.txt' で終わらないファイルパスを取得します。\n";
105    foreach ($regexIterator as $fileInfo) {
106        echo "マッチしないファイル: " . $fileInfo->getPathname() . "\n";
107    }
108    echo "\n";
109
110} catch (Exception $e) {
111    echo "エラーが発生しました: " . $e->getMessage() . "\n";
112}
113
114// register_shutdown_function がクリーンアップ処理を行うため、ここでは追加の処理は不要です。

PHPのRecursiveRegexIterator::setFlagsメソッドは、正規表現を使って要素をフィルタリングするイテレータの動作モードを制御する機能を提供します。このメソッドはint型の$flags引数を一つ受け取りますが、戻り値はありません。$flags引数には、RecursiveRegexIteratorクラスに定義された定数を指定し、イテレータが正規表現とどのようにマッチするか、または何を取得するかを設定します。

サンプルコードでは、まず一時ディレクトリ内にいくつかのテストファイルを用意し、それらをRecursiveRegexIteratorで走査する準備をしています。最初はRecursiveRegexIterator::MATCHが適用され、ファイル名が.txtで終わるものだけをSplFileInfoオブジェクトとして取得します。次に、setFlags(RecursiveRegexIterator::GET_MATCH)を設定すると、イテレータはSplFileInfoオブジェクトではなく、正規表現のマッチ結果を含む配列を返します。さらに、setFlags(RecursiveRegexIterator::NOT_MATCH)を設定すると、正規表現にマッチしなかったファイル（.txtで終わらないファイル）のSplFileInfoオブジェクトが取得されるようになります。このように、setFlagsメソッドを使用することで、イテレータのフィルタリング条件や返されるデータの形式を柔軟に変更できるのが特徴です。