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

Copy
1<?php
2
3/**
4 * テスト用の一時ディレクトリとファイルを作成します。
5 * この関数は、サンプルコードが単体で動作するために必要なファイルシステム構造を準備します。
6 *
7 * @param string $baseDir 作成するディレクトリのパス
8 */
9function createRecursiveTestFiles(string $baseDir): void
10{
11    if (!is_dir($baseDir)) {
12        mkdir($baseDir, 0777, true);
13    }
14    file_put_contents($baseDir . '/document.txt', 'PHP is great!');
15    file_put_contents($baseDir . '/image.jpg', 'Binary data...');
16    mkdir($baseDir . '/subfolder');
17    file_put_contents($baseDir . '/subfolder/report.txt', 'Important report.');
18    file_put_contents($baseDir . '/subfolder/log.log', 'Log entry.');
19    file_put_contents($baseDir . '/subfolder/another_document.txt', 'More text.');
20}
21
22/**
23 * テスト用の一時ディレクトリとファイルをクリーンアップします。
24 * サンプルコードの実行後に作成されたファイルを削除し、環境をきれいに保ちます。
25 *
26 * @param string $baseDir 削除するディレクトリのパス
27 */
28function cleanupRecursiveTestFiles(string $baseDir): void
29{
30    if (is_dir($baseDir)) {
31        $iterator = new RecursiveIteratorIterator(
32            new RecursiveDirectoryIterator($baseDir, RecursiveDirectoryIterator::SKIP_DOTS),
33            RecursiveIteratorIterator::CHILD_FIRST
34        );
35        foreach ($iterator as $path) {
36            if ($path->isDir() && !$path->isLink()) {
37                rmdir($path->getPathname());
38            } else {
39                unlink($path->getPathname());
40            }
41        }
42        rmdir($baseDir);
43    }
44}
45
46/**
47 * RecursiveRegexIterator を使用して、指定された正規表現パターンにマッチするファイル
48 * （つまり「有効な」ファイル）を再帰的に検索し、表示します。
49 *
50 * システムエンジニアを目指す初心者向けに、このメソッドがどのようにファイルのフィルタリングと
51 * 「有効性チェック」に利用されるかを示します。RecursiveRegexIterator::valid() は、
52 * 現在のイテレータ位置の要素が正規表現にマッチするかどうかを内部的に判断します。
53 *
54 * @param string $regexPattern 検索するファイル名に適用する正規表現パターン (例: '/\.txt$/i')
55 */
56function findAndValidateFilesByRegex(string $regexPattern): void
57{
58    $testDir = __DIR__ . '/recursive_regex_test_data';
59    
60    // 検索を行う前に、テスト用のディレクトリとファイルを作成します。
61    createRecursiveTestFiles($testDir);
62
63    echo "--- ディレクトリ '{$testDir}' 内で正規表現 '{$regexPattern}' にマッチするファイルを検索 ---\n";
64
65    try {
66        // (1) ディレクトリを再帰的に走査するためのイテレータを作成します。
67        //     RecursiveDirectoryIterator はディレクトリ内のエントリ（ファイルやサブディレクトリ）を一つずつ取得します。
68        //     SKIP_DOTS フラグは "." (カレントディレクトリ) と ".." (親ディレクトリ) をスキップします。
69        $directoryIterator = new RecursiveDirectoryIterator($testDir, RecursiveDirectoryIterator::SKIP_DOTS);
70
71        // (2) RecursiveRegexIterator は、RecursiveDirectoryIterator から渡される各要素を
72        //     指定された正規表現パターン ($regexPattern) でフィルタリングします。
73        //     このイテレータは、正規表現にマッチする要素のみを「有効な要素」として次のイテレータに渡します。
74        //     RecursiveRegexIterator::valid() メソッドは、内部的にこの正規表現マッチングの結果を判断し、
75        //     現在の要素が有効（true）か無効（false）かを決定します。
76        $regexIterator = new RecursiveRegexIterator($directoryIterator, $regexPattern);
77
78        // (3) RecursiveIteratorIterator は、ネストされたイテレータ（ここではRecursiveRegexIterator）を平坦化し、
79        //     再帰的なディレクトリ構造全体を foreach ループで簡単に走査できるようにします。
80        $iterator = new RecursiveIteratorIterator($regexIterator);
81
82        $foundFiles = [];
83        foreach ($iterator as $fileInfo) {
84            // foreach ループは、イテレータの `valid()` メソッドが true を返す限り続行します。
85            // RecursiveRegexIterator の場合、`valid()` が true を返すのは、現在の要素が
86            // コンストラクタで指定された正規表現パターンにマッチするときです。
87            // つまり、このループに入ってくるすべての $fileInfo は、指定された正規表現によって
88            // 「有効である」と判断されたファイルです。
89            
90            // $fileInfo は SplFileInfo オブジェクトであり、ファイルに関する情報を提供します。
91            $foundFiles[] = $fileInfo->getPathname();
92        }
93
94        if (empty($foundFiles)) {
95            echo "  指定されたパターンにマッチする有効なファイルは見つかりませんでした。\n";
96        } else {
97            echo "  見つかった有効なファイル:\n";
98            foreach ($foundFiles as $path) {
99                echo "  - " . $path . "\n";
100            }
101        }
102
103    } catch (UnexpectedValueException $e) {
104        echo "エラー: パス '{$testDir}' はディレクトリではありませんでした。 (" . $e->getMessage() . ")\n";
105    } catch (RuntimeException $e) {
106        echo "エラー: その他のランタイムエラーが発生しました。 (" . $e->getMessage() . ")\n";
107    } finally {
108        // 検索が完了した後、作成したテストデータをクリーンアップします。
109        cleanupRecursiveTestFiles($testDir);
110    }
111    echo "--------------------------------------------------------------------------\n\n";
112}
113
114// === サンプルコードの実行例 ===
115
116// 実行例1: ".txt" 拡張子のファイルを「有効なファイル」として検索します。
117findAndValidateFilesByRegex('/\.txt$/i');
118
119// 実行例2: ファイル名に "report" を含むファイルを「有効なファイル」として検索します。
120findAndValidateFilesByRegex('/report/i');
121
122// 実行例3: ".jpg" または ".log" 拡張子のファイルを「有効なファイル」として検索します。
123findAndValidateFilesByRegex('/(\.jpg|\.log)$/i');
124
125// 実行例4: 存在しないパターン（".php"）で検索します。有効なファイルは見つかりません。
126findAndValidateFilesByRegex('/\.php$/i');
127

RecursiveRegexIterator::valid()メソッドは、PHPのイテレータ機能の一部で、現在のイテレータ位置にある要素が、オブジェクト生成時に指定された正規表現パターンにマッチするかどうかを判断するために内部的に使用されます。このメソッドは引数を持たず、正規表現にマッチすれば真（true）、マッチしなければ偽（false）をブール値として返します。

システムエンジニアを目指す初心者の方にとって、これは特定の条件を満たすファイルをディレクトリから効率的に「選び出す」仕組みと考えると分かりやすいでしょう。例えば、特定の拡張子を持つファイルや、ファイル名に特定のキーワードを含むファイルのみを対象としたい場合に利用します。

サンプルコードでは、RecursiveRegexIteratorを用いて、ディレクトリを再帰的に走査しながら、与えられた正規表現パターン（例: .txtファイル、reportを含むファイルなど）に合致するファイルをフィルタリングして抽出しています。このフィルタリングの裏側でvalid()メソッドが各要素の「有効性」を判断しており、これにより、多数のファイルの中から必要なファイルのみを選び出すファイルパスの検証（php validation）処理を実現できます。

Copy
1<?php
2
3// PHP 8
4// RecursiveRegexIterator::valid() メソッドのサンプルコード
5
6/**
7 * 一時的なディレクトリとテストファイルを再帰的に作成します。
8 * @param string $baseDir ベースディレクトリ
9 * @return string 作成された一時ディレクトリのパス
10 */
11function createTempTestDirectory(string $baseDir): string
12{
13    $tempDir = $baseDir . '/recursive_regex_test_' . uniqid();
14    mkdir($tempDir);
15    file_put_contents($tempDir . '/document.txt', 'This is a text document.');
16    file_put_contents($tempDir . '/image.jpg', 'This is an image.');
17    mkdir($tempDir . '/logs');
18    file_put_contents($tempDir . '/logs/error.log', 'Error log entry.');
19    file_put_contents($tempDir . '/logs/access.log', 'Access log entry.');
20    mkdir($tempDir . '/data');
21    file_put_contents($tempDir . '/data/config.json', '{"key": "value"}');
22    return $tempDir;
23}
24
25/**
26 * 一時的なディレクトリとその内容を再帰的に削除します。
27 * @param string $dir 削除するディレクトリのパス
28 */
29function removeTempTestDirectory(string $dir): void
30{
31    if (!is_dir($dir)) {
32        return;
33    }
34    $objects = scandir($dir);
35    foreach ($objects as $object) {
36        if ($object !== "." && $object !== "..") {
37            if (is_dir($dir . "/" . $object) && !is_link($dir . "/" . $object)) {
38                removeTempTestDirectory($dir . "/" . $object);
39            } else {
40                unlink($dir . "/" . $object);
41            }
42        }
43    }
44    rmdir($dir);
45}
46
47/**
48 * RecursiveRegexIterator::valid() メソッドの使用例。
49 *
50 * この関数は、指定されたディレクトリを再帰的に走査し、
51 * 正規表現にマッチするファイルやディレクトリを検索します。
52 *
53 * valid() メソッドは、現在のイテレータ要素が正規表現フィルタリングの条件を満たし、
54 * かつイテレータが有効な状態にあるかを判断し、その結果を bool で返します。
55 * これにより、ループが継続されるかどうかが制御されます。
56 *
57 * @param string $directoryPath 検索対象のディレクトリパス
58 * @param string $regexPattern パス名に適用する正規表現パターン
59 */
60function demonstrateRecursiveRegexIteratorValid(string $directoryPath, string $regexPattern): void
61{
62    echo "--- 検索開始: '" . $directoryPath . "' 内でパターン '" . $regexPattern . "' にマッチする要素 ---" . PHP_EOL;
63
64    try {
65        // 1. ディレクトリを再帰的に走査するイテレータを準備
66        $directoryIterator = new RecursiveDirectoryIterator(
67            $directoryPath,
68            RecursiveDirectoryIterator::SKIP_DOTS // '.' と '..' をスキップ
69        );
70
71        // 2. ディレクトリ構造を平坦化し、再帰的に処理するためのイテレータ
72        // RecursiveIteratorIterator::SELF_FIRST は、ファイルとディレクトリの両方を処理対象とします。
73        $recursiveIterator = new RecursiveIteratorIterator(
74            $directoryIterator,
75            RecursiveIteratorIterator::SELF_FIRST
76        );
77
78        // 3. 正規表現で要素をフィルタリングするイテレータ
79        // valid() メソッドは、このフィルタリングロジックに基づいて要素の有効性を判断します。
80        // ここでは、パス名が指定された正規表現にマッチする要素のみが「有効」とされます。
81        $regexIterator = new RecursiveRegexIterator(
82            $recursiveIterator,
83            $regexPattern,
84            RecursiveRegexIterator::MATCH // 正規表現にマッチする要素のみを返します
85        );
86
87        $foundCount = 0;
88        // valid() メソッドが true を返す間、ループは継続され、有効な要素が処理されます。
89        // valid() の戻り値が false になると、ループは終了します。
90        while ($regexIterator->valid()) {
91            // valid() が true の場合、現在の要素は正規表現にマッチし、かつ有効です。
92            echo "  [有効な要素]: " . $regexIterator->getPathname() . PHP_EOL;
93            $foundCount++;
94
95            // 次の要素に進みます。
96            $regexIterator->next();
97        }
98
99        if ($foundCount === 0) {
100            echo "  マッチする有効な要素は見つかりませんでした。" . PHP_EOL;
101        }
102
103        echo "--- 検索終了 ---" . PHP_EOL;
104
105    } catch (UnexpectedValueException $e) {
106        // 例外処理：ディレクトリが見つからないなどのエラー
107        echo "エラーが発生しました: " . $e->getMessage() . PHP_EOL;
108    }
109}
110
111// スクリプトの実行開始
112$tempBaseDir = sys_get_temp_dir();
113$testDir = createTempTestDirectory($tempBaseDir);
114
115// デモンストレーションの実行: パス名に 'log' を含むファイルまたはディレクトリを検索
116// RecursiveRegexIterator::valid() がこの条件に基づいて要素を「有効」と判断します。
117demonstrateRecursiveRegexIteratorValid($testDir, '/log/');
118
119// 後処理: 作成した一時ディレクトリを削除
120removeTempTestDirectory($testDir);
121
122?>

PHP 8のRecursiveRegexIterator::valid()メソッドは、イテレータの現在の要素が有効であるかを判断するために使用されるメソッドです。このメソッドは引数を受け取らず、真偽値（bool）を返します。trueが返された場合、現在の要素は正規表現のフィルタリング条件を満たしており、イテレータが有効な状態にあることを示します。一方、falseが返された場合は、条件を満たさないか、イテレータの終端に達していることを意味します。

このサンプルコードでは、指定されたディレクトリを再帰的に走査し、パス名が特定の正規表現にマッチするファイルやディレクトリを検索する処理を通して、valid()メソッドの働きを解説しています。まず、RecursiveDirectoryIteratorとRecursiveIteratorIteratorでディレクトリ構造を深く探索するイテレータを作成し、次にRecursiveRegexIteratorで正規表現によるフィルタリングを適用しています。

while ($regexIterator->valid())というループの中で、valid()メソッドは中心的な役割を果たします。このメソッドがtrueを返す間は、現在の要素が正規表現にマッチする「有効な」要素として判断され、ループ内でそのパス名が表示されます。そしてvalid()がfalseを返すと、有効な要素がこれ以上存在しないと判断され、ループが終了します。このように、valid()メソッドは、正規表現によるフィルタリングの結果が有効であるかを検証し、イテレータのループ処理を制御する重要な役割を担っています。