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

Copy
1<?php
2
3/**
4 * 現在のディレクトリから、指定された正規表現にマッチするファイルを検索し、そのファイル名を表示します。
5 * RegexIterator::current() メソッドの使用例を示します。
6 *
7 * この関数は、DirectoryIterator と RegexIterator を組み合わせて使用し、
8 * 現在のディレクトリ内のファイルをフィルタリングして表示します。
9 */
10function listFilteredDirectoryFiles(): void
11{
12    // 現在のスクリプトがあるディレクトリの絶対パスを取得します。
13    // '__DIR__' マジック定数は、ファイルパスがスクリプト内でハードコードされるのを防ぎます。
14    $currentDirectory = __DIR__;
15
16    echo "現在のディレクトリ ($currentDirectory) 内の、PHPまたはテキストファイル:\n";
17
18    try {
19        // 1. DirectoryIterator を使用して、現在のディレクトリ内のファイルをイテレートします。
20        //    これにより、各ファイルは SplFileInfo オブジェクトとして扱われます。
21        $directoryIterator = new DirectoryIterator($currentDirectory);
22
23        // 2. RegexIterator で DirectoryIterator をラップし、ファイル名をフィルタリングします。
24        //    ここでは、ファイル名が '.php' または '.txt' で終わるファイルにマッチする正規表現を指定します。
25        $regexPattern = '/\.(php|txt)$/i'; // 大文字小文字を区別しない (.php または .txt)
26
27        $regexIterator = new RegexIterator(
28            $directoryIterator,
29            $regexPattern,
30            RegexIterator::MATCH // 正規表現にマッチする要素のみを返すモード
31        );
32
33        $foundCount = 0;
34        // 3. RegexIterator をループし、フィルタリングされたファイルを表示します。
35        //    foreach ループでは、内部的に current() メソッドが呼び出されて要素が取得されます。
36        foreach ($regexIterator as $file) {
37            // RegexIterator::current() メソッドは、現在のイテレータ要素の値を返します。
38            // DirectoryIterator をラップしているため、ここでは SplFileInfo オブジェクトが返されます。
39            // （リファレンスの戻り値は string|array|null ですが、SplFileInfo は文字列として扱えます。）
40            $currentElement = $regexIterator->current();
41
42            // SplFileInfo オブジェクトからファイル名を取得するために getFilename() を使用します。
43            echo "- " . $currentElement->getFilename() . "\n";
44            $foundCount++;
45        }
46
47        if ($foundCount === 0) {
48            echo "  (該当するファイルは見つかりませんでした。)\n";
49        }
50
51    } catch (UnexpectedValueException $e) {
52        // ディレクトリが存在しない、またはアクセス権がない場合に発生する例外をキャッチします。
53        echo "エラー: ディレクトリの読み込み中に問題が発生しました。 (" . $e->getMessage() . ")\n";
54    }
55}
56
57// 関数を実行して動作を確認します。
58listFilteredDirectoryFiles();

このPHPサンプルコードは、RegexIteratorクラスを利用して、現在のディレクトリにあるファイルの中から、指定された正規表現にマッチするファイル名（具体的にはPHPファイルとテキストファイル）をフィルタリングして一覧表示する方法を示しています。

コードではまずDirectoryIteratorを使って現在のディレクトリ内のすべてのファイルを走査できるようにし、そのDirectoryIteratorをRegexIteratorでラップしています。これにより、ファイル名が.phpまたは.txtで終わるファイルのみを抽出する正規表現/\\.(php|txt)$/iを適用し、条件に合うファイルだけが後続の処理に進むようフィルタリングしています。

RegexIterator::current()メソッドは、引数を取らずに、イテレータの現在位置にある要素の値を返します。このメソッドの戻り値はリファレンス上ではstring|array|nullとされていますが、本サンプルコードのようにDirectoryIteratorをラップしている場合は、ファイルのメタデータを含むSplFileInfoオブジェクトが返されます。foreachループでは通常、このcurrent()メソッドが内部的に呼び出されて要素が取得されますが、サンプルコードでは明示的に呼び出すことでその挙動を具体的に示しています。取得したSplFileInfoオブジェクトからは、getFilename()メソッドを使って実際にファイル名を取り出し、画面に表示しています。この仕組みにより、大量のファイルから特定の条件に合うものだけを効率的に探し出すことができます。

Copy
1<?php
2
3/**
4 * RegexIterator::current() メソッドのデモンストレーションを行います。
5 * この関数は、ログエントリの配列から正規表現で特定の条件（現在のタイムスタンプに関連する日付と「ERROR」）に
6 * マッチする行をフィルタリングし、RegexIterator::current() を使ってその要素を取得する方法を示します。
7 *
8 * PHPの現在のタイムスタンプを直接生成するのではなく、それをフィルター条件の一部として利用し、
9 * RegexIterator::current() がどのようにフィルタリングされた要素を返すかを示します。
10 */
11function demonstrateRegexIteratorCurrentWithTimestampContext(): void
12{
13    // 1. サンプルデータの準備: ログエントリの配列
14    // これらのエントリには、異なる日付のタイムスタンプ情報が含まれています。
15    $logEntries = [
16        'INFO: Application started at 2023-01-15 10:00:00.',
17        'DEBUG: User "test" logged in.',
18        'WARNING: High CPU usage on 2023-01-16 10:05:30. Check status.',
19        'ERROR: Database connection failed at 2023-01-15 10:07:15. Retrying...',
20        'INFO: Background task completed.',
21        'ERROR: Unexpected data format at 2023-01-16 10:10:05. Data: {...}',
22        'WARNING: Disk space low on 2023-01-17 10:12:00.',
23    ];
24
25    // 2. キーワード「php current timestamp」に関連付ける部分:
26    // 現在の日付を「YYYY-MM-DD」形式で取得し、これをフィルター条件の一部として利用します。
27    // DateTimeオブジェクトは、現在のタイムスタンプ（日時）を扱うための推奨される方法です。
28    // 例として、ここでは特定の固定日付を使用し、それを含むログエントリをフィルタリングします。
29    // (実際の「現在」の日付を使いたい場合は、コメントアウトされた行を使用してください)
30    $filterDate = '2023-01-16'; // 例として固定の日付を設定
31    // $filterDate = (new DateTime())->format('Y-m-d'); // 実行時の現在の日付を使う場合
32
33    echo "フィルター対象の日付: {$filterDate}\n\n";
34
35    // 3. RegexIteratorの準備:
36    // ArrayIteratorで元の配列をイテレート可能にします。
37    $arrayIterator = new ArrayIterator($logEntries);
38
39    // RegexIteratorで、特定のパターン（$filterDate と "ERROR" を含む行）に
40    // マッチする要素のみをフィルターします。
41    // RegexIterator::MATCH は、マッチした要素を返すように指定します。
42    // preg_quote() は正規表現の特殊文字をエスケープするために使われます。
43    $regexPattern = '/^ERROR:.*?' . preg_quote($filterDate, '/') . '.*?$/';
44    $regexIterator = new RegexIterator($arrayIterator, $regexPattern, RegexIterator::MATCH);
45
46    echo "--- 日付 ({$filterDate}) に発生した 'ERROR' エントリをフィルタリング ---\n";
47
48    // 4. RegexIterator::current() の使用例1: foreach ループ内での利用
49    // フィルターされた要素を1つずつ処理し、RegexIterator::current() で現在の要素を取得します。
50    foreach ($regexIterator as $key => $value) {
51        // foreach ループでは、$value に既に current() で取得された値が格納されていますが、
52        // ここでは RegexIterator::current() を明示的に呼び出してその機能を示します。
53        $currentLogEntry = $regexIterator->current();
54        echo "マッチしたエントリ (キー {$key}): " . $currentLogEntry . "\n";
55    }
56
57    // フィルター結果が空だった場合のメッセージ
58    if (!$regexIterator->valid()) {
59        echo "指定された日付にマッチする 'ERROR' エントリは見つかりませんでした。\n";
60    }
61    echo "\n";
62
63    // 5. RegexIterator::current() の使用例2: ループの外での直接取得
64    echo "--- current() を使ってフィルターされた先頭の要素を直接取得する例 ---\n";
65    $regexIterator->rewind(); // イテレータをリセットして最初の要素に戻します。
66
67    if ($regexIterator->valid()) {
68        // current() メソッドは、イテレータの現在の位置にある要素を返します。
69        // ここでは、フィルターされた最初の要素を取得します。
70        $firstFilteredEntry = $regexIterator->current();
71        echo "フィルターされた最初の要素: " . $firstFilteredEntry . "\n";
72    } else {
73        echo "フィルターされた要素が見つかりませんでした。\n";
74    }
75}
76
77// デモンストレーション関数を実行
78demonstrateRegexIteratorCurrentWithTimestampContext();
79
80?>

PHPのRegexIterator::current()メソッドは、正規表現によってフィルタリングされたコレクション（イテレータ）の中から、「現在」の位置にある要素を取得するために使われます。このメソッドは引数を必要とせず、現在の要素を文字列 (string)、配列 (array)、または要素がない場合に null として返します。

このサンプルコードは、ログエントリの配列から、特定の日付とキーワードを含む行を抽出する方法を示します。「php current timestamp」というキーワードは、現在のタイムスタンプから得られる日付（例: 2023-01-16）をフィルター条件の一部として利用し、ログの中からその日付に関連する「ERROR」メッセージを検索する際に使われています。

具体的には、まずログエントリをArrayIteratorで処理可能な形にし、次にRegexIteratorを使って、先ほどの日付と「ERROR」を含む行にマッチするようフィルターをかけます。RegexIterator::current()は、このフィルターを通過した要素のうち、現在イテレータが指している位置にある要素を返します。foreachループでフィルターされた各要素を順に処理する際も、current()メソッドが内部的に呼び出されて値が取り出されます。また、イテレータをrewind()でリセットした後、current()を直接呼び出すことで、フィルターされた最初の要素を単独で取得することも可能です。このように、current()はイテレータの現在位置の要素を取得する基本的な役割を担います。