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

Copy
1<?php
2
3/**
4 * プロジェクトディレクトリ内のPHPファイルから、特定のパターンに一致するファイル名を抽出する関数。
5 * RecursiveRegexIterator を使用して、ファイルシステムを再帰的に探索し、
6 * 正規表現に一致する要素のみをフィルタリングします。
7 *
8 * RecursiveRegexIterator::accept() メソッドは、このクラスの内部で呼び出され、
9 * 現在の要素（この場合はファイルパス）が指定された正規表現に一致するかどうかを判定するために使用されます。
10 * ユーザーがこのメソッドを直接呼び出すことは通常ありませんが、フィルタリングロジックの核となります。
11 *
12 * @param string $directoryPath 探索を開始するディレクトリのパス
13 * @param string $regexPattern  ファイル名をフィルタリングするための正規表現パターン
14 * @return array<string> 見つかったファイルのパスの配列
15 */
16function findMatchingPhpFiles(string $directoryPath, string $regexPattern): array
17{
18    $foundFiles = [];
19
20    // ディレクトリが存在しない場合は空の配列を返す
21    if (!is_dir($directoryPath)) {
22        return $foundFiles;
23    }
24
25    // ディレクトリを再帰的に走査するためのイテレータを作成
26    // RecursiveDirectoryIterator::SKIP_DOTS は "." と ".." をスキップします。
27    $directoryIterator = new RecursiveDirectoryIterator(
28        $directoryPath,
29        RecursiveDirectoryIterator::SKIP_DOTS
30    );
31    // サブディレクトリも走査するためのイテレータ
32    $recursiveIterator = new RecursiveIteratorIterator($directoryIterator);
33
34    // 正規表現に一致するファイルのみをフィルタリングするイテレータ
35    // RecursiveRegexIterator::GET_MATCH モードは、マッチした文字列の配列を返します。
36    // RecursiveRegexIterator::accept() は、ここで指定された $regexPattern を各要素に適用し、
37    // マッチすれば true を、しなければ false を返します。
38    $regexIterator = new RecursiveRegexIterator(
39        $recursiveIterator,
40        $regexPattern,
41        RecursiveRegexIterator::GET_MATCH
42    );
43
44    foreach ($regexIterator as $match) {
45        // GET_MATCH モードでは、$match は正規表現のマッチ結果の配列になります。
46        // $match[0] には、パターン全体に一致した文字列が含まれます。
47        if (isset($match[0]) && is_string($match[0])) {
48            $foundFiles[] = $match[0];
49        }
50    }
51
52    return $foundFiles;
53}
54
55// --- サンプルコードの実行部分 ---
56
57// テスト用のディレクトリ構造を作成します。
58// 実際の使用では、既存のプロジェクトディレクトリを指定します。
59$baseDir = sys_get_temp_dir() . DIRECTORY_SEPARATOR . 'my_project_example_' . uniqid();
60mkdir($baseDir);
61mkdir($baseDir . DIRECTORY_SEPARATOR . 'src');
62mkdir($baseDir . DIRECTORY_SEPARATOR . 'tests');
63
64// サンプルファイルを作成します。
65file_put_contents($baseDir . DIRECTORY_SEPARATOR . 'src' . DIRECTORY_SEPARATOR . 'UserService.php', '<?php // UserService');
66file_put_contents($baseDir . DIRECTORY_SEPARATOR . 'src' . DIRECTORY_SEPARATOR . 'UserRepository.php', '<?php // UserRepository');
67file_put_contents($baseDir . DIRECTORY_SEPARATOR . 'src' . DIRECTORY_SEPARATOR . 'SomeTest.php', '<?php // SomeTest');
68file_put_contents($baseDir . DIRECTORY_SEPARATOR . 'tests' . DIRECTORY_SEPARATOR . 'FeatureTest.php', '<?php // FeatureTest');
69file_put_contents($baseDir . DIRECTORY_SEPARATOR . 'index.php', '<?php // index');
70file_put_contents($baseDir . DIRECTORY_SEPARATOR . 'README.md', '# README');
71
72// プロジェクトのルートディレクトリを指定
73$projectRoot = $baseDir;
74
75// "Test" または "Service" を含むPHPファイル名を探します。
76// これは、ユニットテストファイルやサービス層のファイルを探すシナリオを模倣しています。
77// "php acceptance testing" の文脈では、テストファイルを効率的に見つける際に役立つことがあります。
78$pattern = '/(Test|Service)\.php$/i';
79
80echo "Searching for PHP files matching pattern '{$pattern}' in '{$projectRoot}'...\n";
81$matchingFiles = findMatchingPhpFiles($projectRoot, $pattern);
82
83if (!empty($matchingFiles)) {
84    echo "Found files:\n";
85    foreach ($matchingFiles as $file) {
86        echo "- " . $file . "\n";
87    }
88} else {
89    echo "No matching files found.\n";
90}
91
92// 作成した一時ディレクトリとファイルをクリーンアップするヘルパー関数
93function rrmdir(string $dir): void
94{
95    if (!is_dir($dir)) {
96        return;
97    }
98    $files = array_diff(scandir($dir), array('.', '..'));
99    foreach ($files as $file) {
100        (is_dir("$dir/$file")) ? rrmdir("$dir/$file") : unlink("$dir/$file");
101    }
102    rmdir($dir);
103}
104
105// サンプルデータとして作成した一時ディレクトリをクリーンアップします。
106rrmdir($baseDir);
107
108?>

RecursiveRegexIterator::accept()メソッドは、PHP 8で提供されるRecursiveRegexIteratorクラスに属する内部的なメソッドです。このメソッドは引数を取らず、戻り値として真偽値（bool）を返します。その役割は、イテレータが処理している現在の要素が、RecursiveRegexIteratorの初期化時に指定された正規表現パターンに一致するかどうかを判定することです。

開発者がこのaccept()メソッドを直接呼び出すことは通常ありません。RecursiveRegexIteratorは、ファイルシステムなどの構造を再帰的に走査しながら、指定した正規表現パターンに一致する要素だけをフィルタリングして抽出するために利用されます。accept()メソッドは、このフィルタリング処理の内部で自動的に呼び出され、各要素が正規表現に合致するかどうかの判断を行います。一致すればtrueを返し、その要素は結果として扱われますが、一致しなければfalseを返し、その要素はスキップされます。

提供されたサンプルコードでは、findMatchingPhpFiles関数内でRecursiveRegexIteratorを利用し、指定されたプロジェクトディレクトリ内のPHPファイルから、正規表現パターンに合致するファイル名だけを効率的に抽出しています。例えば、「Test」または「Service」という文字列を含むPHPファイルを探すといったシナリオです。このような用途では、RecursiveRegexIteratorは大量のファイルの中から特定の条件を満たすファイルを効率的に見つけ出す強力なツールとなり、「php acceptance testing」の文脈でテストファイルを特定する際など、ファイル選択のフィルタリングの中核を担っています。

Copy
1<?php
2
3/**
4 * JsonPostFileFilterIterator クラス
5 * RecursiveRegexIterator を継承し、ファイルシステム内のJSONファイルを
6 * ファイル名と内容の両方に基づいてフィルタリングします。
7 *
8 * このクラスは、HTTP POSTで受け取られたJSONデータがファイルとして保存され、
9 * その後特定の条件（ファイル名や内容のキーワード）で検索・処理される
10 * シナリオを想定しています。
11 */
12class JsonPostFileFilterIterator extends RecursiveRegexIterator
13{
14    /**
15     * @var string[] JSONファイルの内容に含まれるべき必須キーワードのリスト
16     */
17    private array $requiredContentKeywords;
18
19    /**
20     * コンストラクタ
21     *
22     * @param RecursiveIterator $iterator              ベースとなるイテレータ（例: RecursiveDirectoryIterator）
23     * @param string            $regex                 ファイル名またはディレクトリ名に適用する正規表現
24     * @param int               $mode                  RegexIterator のマッチモード（例: RecursiveRegexIterator::MATCH）
25     * @param int               $flags                 正規表現フラグ（例: RegexIterator::CASE_INSENSITIVE）
26     * @param array             $requiredContentKeywords JSONファイルの内容に含まれるべきキーワードの配列
27     */
28    public function __construct(
29        RecursiveIterator $iterator,
30        string $regex,
31        int $mode = RecursiveRegexIterator::MATCH,
32        int $flags = 0,
33        array $requiredContentKeywords = []
34    ) {
35        parent::__construct($iterator, $regex, $mode, $flags);
36        $this->requiredContentKeywords = $requiredContentKeywords;
37    }
38
39    /**
40     * 現在の要素がフィルタリング条件を満たすかどうかを判定します。
41     * このメソッドは、RecursiveIteratorIterator によって内部的に呼び出されます。
42     *
43     * @return bool 要素が受け入れられる場合は true、そうでない場合は false
44     */
45    public function accept(): bool
46    {
47        // まず、親クラス (RecursiveRegexIterator) の正規表現フィルタリングを実行します。
48        // これにより、ファイル名がコンストラクタで指定された正規表現にマッチするか確認します。
49        if (!parent::accept()) {
50            return false;
51        }
52
53        /** @var SplFileInfo $currentFile */
54        $currentFile = $this->current();
55
56        // ディレクトリは常に受け入れます（再帰的な走査を継続するため）。
57        if ($currentFile->isDir()) {
58            return true;
59        }
60
61        // ファイルの場合のみ、追加のフィルタリングロジックを適用します。
62        if ($currentFile->isFile()) {
63            $filePath = $currentFile->getPathname();
64            $fileExtension = strtolower($currentFile->getExtension());
65
66            // 1. ファイル拡張子が "json" であることを確認します。
67            if ($fileExtension !== 'json') {
68                return false;
69            }
70
71            // 2. ファイルの内容を読み込みます。
72            $fileContent = file_get_contents($filePath);
73            if ($fileContent === false) {
74                // ファイルが読み取れない場合はスキップします。
75                return false;
76            }
77
78            // 3. 内容が有効なJSON形式であるかを確認します。
79            json_decode($fileContent);
80            if (json_last_error() !== JSON_ERROR_NONE) {
81                // 無効なJSONはスキップします。
82                return false;
83            }
84
85            // 4. 指定されたキーワードがJSON内容に含まれているかを確認します。
86            //    これは、特定の「POST」データ（例：ブログ投稿）を識別するのに役立ちます。
87            foreach ($this->requiredContentKeywords as $keyword) {
88                // 大文字小文字を区別せず、マルチバイトセーフな検索を行います。
89                if (mb_stripos($fileContent, $keyword) === false) {
90                    // 必須キーワードのいずれかが含まれていない場合はスキップします。
91                    return false;
92                }
93            }
94
95            // 上記すべての条件を満たすファイルは受け入れます。
96            return true;
97        }
98
99        // その他の要素（例: シンボリックリンクなど）は親のロジックに従います。
100        return true;
101    }
102}
103
104// --- 単体で動作可能なサンプルコード部分 ---
105
106// テスト用のディレクトリを作成
107$baseDir = __DIR__ . '/json_data_posts';
108if (!is_dir($baseDir)) {
109    mkdir($baseDir);
110}
111
112// ダミーのJSONファイルと非JSONファイルを作成
113file_put_contents($baseDir . '/post_article_1.json', json_encode(['id' => 1, 'type' => 'blog_post', 'title' => 'First Blog Post']));
114file_put_contents($baseDir . '/user_profile_1.json', json_encode(['id' => 10, 'username' => 'alice', 'status' => 'active']));
115file_put_contents($baseDir . '/invalid_data.json', 'This is not valid JSON content.');
116file_put_contents($baseDir . '/some_report.txt', 'Just a text file.');
117file_put_contents($baseDir . '/post_comment_2.json', json_encode(['id' => 2, 'type' => 'comment', 'content' => 'Great post!', 'author' => 'Bob']));
118
119echo "--- JSONデータファイルをフィルタリング開始 ---" . PHP_EOL . PHP_EOL;
120
121try {
122    // RecursiveDirectoryIterator を使って指定ディレクトリを再帰的に走査します。
123    $directoryIterator = new RecursiveDirectoryIterator($baseDir, FilesystemIterator::SKIP_DOTS);
124
125    // JsonPostFileFilterIterator を使用して、以下の条件でファイルをフィルタリングします。
126    // 1. ファイル名が 'post_' で始まり、'.json' で終わるもの (正規表現: /^post_.*\.json$/i)
127    // 2. ファイル内容が有効なJSONであるもの
128    // 3. ファイル内容に 'post' というキーワードが含まれるもの (大文字小文字を区別しない)
129    $filteredIterator = new JsonPostFileFilterIterator(
130        $directoryIterator,
131        '/^post_.*\.json$/i', // ファイル名フィルタリングの正規表現
132        RecursiveRegexIterator::MATCH,
133        0,
134        ['post'] // JSON内容に含まれるべきキーワード
135    );
136
137    // RecursiveIteratorIterator でフィルタリングされた要素を平坦化して反復処理します。
138    // LEAVES_ONLY は、ディレクトリではなくファイル（葉）のみを処理対象とします。
139    $iterator = new RecursiveIteratorIterator($filteredIterator, RecursiveIteratorIterator::LEAVES_ONLY);
140
141    // フィルタリング結果を表示
142    foreach ($iterator as $name => $fileInfo) {
143        if ($fileInfo->isFile()) {
144            echo "フィルタリングされたファイル: " . $fileInfo->getPathname() . PHP_EOL;
145            echo "内容: " . file_get_contents($fileInfo->getPathname()) . PHP_EOL . PHP_EOL;
146        }
147    }
148} catch (UnexpectedValueException $e) {
149    echo "エラーが発生しました: " . $e->getMessage() . PHP_EOL;
150} finally {
151    // テスト用のディレクトリとファイルをクリーンアップ
152    foreach (glob($baseDir . '/*') as $file) {
153        unlink($file);
154    }
155    rmdir($baseDir);
156    echo "--- クリーンアップ完了 ---" . PHP_EOL;
157}

このサンプルコードは、PHP 8のRecursiveRegexIteratorクラスのacceptメソッドを、JsonPostFileFilterIteratorというカスタムクラスでオーバーライドして利用する方法を示しています。acceptメソッドは引数を持たず、イテレータが現在処理している要素（ファイルやディレクトリ）が、定義されたフィルタリング条件を満たすかどうかをtrueまたはfalseで返します。

この例では、acceptメソッドをカスタマイズすることで、HTTP POSTで送られたJSONデータを想定したファイルを検索・処理するシナリオを実現しています。具体的には、まず親クラスの機能を使ってファイル名が特定の正規表現に一致するかを確認します。その上で、ディレクトリであれば常に受け入れ、ファイルであれば、それが.json拡張子であるか、内容が有効なJSON形式であるか、さらにコンストラクタで指定されたキーワード（例えば「post」）がJSON内容に含まれているかを検証します。これらのすべての条件を満たすファイルのみがフィルタリング結果として「受け入れられる」ように動作します。