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

currentメソッドの使い方について、初心者にもわかりやすく解説します。

作成日: 2025年09月11日更新日: 2025年12月24日

基本的な使い方

『currentメソッドは、イテレータの現在の要素に対して正規表現を適用し、その結果を返すメソッドです』

このメソッドは、RecursiveRegexIteratorが反復処理を行う際に、現在指し示している要素を取得するために使用されます。しかし、単に元の値をそのまま返すわけではありません。RecursiveRegexIteratorのインスタンスを作成する際にコンストラクタで指定された動作モードと正規表現パターンに基づいて、現在の要素を処理した結果を返します。例えば、動作モードがRecursiveRegexIterator::GET_MATCHに設定されている場合、currentメソッドは元の値から正規表現に最初に一致した部分文字列を配列として返します。同様に、SPLITモードでは正規表現で文字列を分割した配列を、REPLACEモードでは一致箇所を置換した後の文字列を返します。このように、currentメソッドはforeachループなどでイテレータから値を取り出す際に、設定に応じた加工済みのデータを動的に提供する重要な役割を担っています。

構文(syntax)


1<?php
2
3$dataSource = new RecursiveArrayIterator([
4    'moduleA.php',
5    'config.xml',
6    'components' => [
7        'ComponentX.php',
8        'style.css',
9        'ComponentY.php'
10    ],
11    'README.md'
12]);
13
14$regexIterator = new RecursiveRegexIterator($dataSource, '/\.php$/');
15
16// RecursiveIteratorIterator を使って再帰的なイテレータをフラットに処理
17$iterator = new RecursiveIteratorIterator($regexIterator);
18
19// イテレータのポインタを先頭に戻す
20$iterator->rewind();
21
22// ポインタが有効な間、ループを続ける
23while ($iterator->valid()) {
24    // 現在の要素（マッチした値）を取得します
25    $currentValue = $iterator->current();
26
27    echo $currentValue . PHP_EOL;
28
29    // ポインタを次の要素に進める
30    $iterator->next();
31}

引数(parameters)

引数なし

引数はありません

戻り値(return)

string|array|null

RecursiveRegexIterator::current() メソッドは、現在位置にある要素の正規表現マッチ結果を文字列または配列で返します。マッチしなかった場合は null を返します。

サンプルコード

PHP RecursiveRegexIterator::current() でPHPファイル検索


1<?php
2
3/**
4 * テストファイルを作成およびクリーンアップするためのヘルパー関数。
5 * (メインのデモンストレーションとは直接関係ないため、簡潔にまとめています)
6 */
7function manage_test_files(string $action = 'setup'): void
8{
9    $baseDir = __DIR__ . '/test_dir';
10
11    if ($action === 'setup') {
12        if (!is_dir($baseDir)) {
13            mkdir($baseDir);
14        }
15        if (!is_dir($baseDir . '/sub_dir')) {
16            mkdir($baseDir . '/sub_dir');
17        }
18
19        // テスト用のPHPファイルを作成
20        file_put_contents($baseDir . '/example1.php', '<?php echo "Example PHP 1";');
21        file_put_contents($baseDir . '/sub_dir/example2.txt', 'This is a text file.');
22        file_put_contents($baseDir . '/example3.php', '<?php echo "Example PHP 3";');
23        file_put_contents($baseDir . '/example4.html', '<html><body>Example HTML</body></html>');
24        file_put_contents($baseDir . '/AnotherScript.php', '<?php echo "Another PHP Script";');
25
26        echo "テストディレクトリとファイルを作成しました。\n";
27    } elseif ($action === 'cleanup') {
28        if (is_dir($baseDir)) {
29            $files = new RecursiveIteratorIterator(
30                new RecursiveDirectoryIterator($baseDir, RecursiveDirectoryIterator::SKIP_DOTS),
31                RecursiveIteratorIterator::CHILD_FIRST
32            );
33
34            foreach ($files as $fileinfo) {
35                if ($fileinfo->isDir()) {
36                    rmdir($fileinfo->getRealPath());
37                } else {
38                    unlink($fileinfo->getRealPath());
39                }
40            }
41            rmdir($baseDir);
42            echo "テストディレクトリとファイルをクリーンアップしました。\n";
43        }
44    }
45}
46
47/**
48 * 現在のディレクトリからPHPファイルを再帰的に検索し、
49 * RecursiveRegexIterator::current() メソッドの動作を示します。
50 */
51function findPhpFilesInCurrentDirectory(): void
52{
53    // 検索デモンストレーションのために、一時的なテストファイルを作成します
54    manage_test_files('setup');
55
56    echo "\n現在のディレクトリからPHPファイルを再帰的に検索し、情報を表示します。\n";
57    echo "------------------------------------------------------------------\n";
58
59    try {
60        // 1. 指定したディレクトリを再帰的に走査するためのイテレータを作成
61        //    __DIR__ は現在のスクリプトがあるディレクトリを指します。
62        //    RecursiveDirectoryIterator::SKIP_DOTS は '.' と '..' ディレクトリをスキップします。
63        $directoryIterator = new RecursiveDirectoryIterator(
64            __DIR__ . '/test_dir',
65            RecursiveDirectoryIterator::SKIP_DOTS
66        );
67
68        // 2. RecursiveDirectoryIterator をラップし、サブディレクトリも再帰的に処理できるようにします。
69        $recursiveIterator = new RecursiveIteratorIterator($directoryIterator);
70
71        // 3. RecursiveRegexIterator を使用して、正規表現にマッチするファイルのみをフィルタリングします。
72        //    '/.*\.php$/i' は、'.php' で終わるファイル名にマッチします（大文字小文字を区別しない）。
73        //    RecursiveRegexIterator::GET_MATCH モードは、current() メソッドが正規表現のマッチ結果の配列を返すようにします。
74        $regexIterator = new RecursiveRegexIterator(
75            $recursiveIterator,
76            '/.*\.php$/i',
77            RecursiveRegexIterator::GET_MATCH
78        );
79
80        $foundCount = 0;
81        // フィルタリングされた各要素について処理
82        foreach ($regexIterator as $path => $matchResult) {
83            $foundCount++;
84            echo "見つかったファイルパス: " . $path . "\n";
85
86            // RecursiveRegexIterator::current() メソッドを明示的に呼び出し、現在の要素を取得します。
87            // GET_MATCH モードの場合、これは正規表現のマッチ結果（配列）を返します。
88            // 配列の最初の要素 ($currentValue[0]) は、正規表現全体にマッチした文字列です。
89            $currentValue = $regexIterator->current();
90
91            if (is_array($currentValue) && isset($currentValue[0])) {
92                echo "  current() の戻り値 (配列): " . $currentValue[0] . "\n";
93            } else {
94                // その他のモードやエラーの場合、別の形式で表示
95                echo "  current() の戻り値 (不明な型): " . (string)$currentValue . "\n";
96            }
97            echo "------------------------------------------------------------------\n";
98        }
99
100        if ($foundCount === 0) {
101            echo "PHPファイルは見つかりませんでした。\n";
102            echo "------------------------------------------------------------------\n";
103        }
104
105    } catch (UnexpectedValueException $e) {
106        // 指定されたパスが存在しないなどのエラーを捕捉
107        echo "エラーが発生しました: " . $e->getMessage() . "\n";
108    } finally {
109        // 処理の最後にテストファイルをクリーンアップします
110        manage_test_files('cleanup');
111    }
112}
113
114// 関数を実行してデモンストレーションを開始します
115findPhpFilesInCurrentDirectory();

PHPのRecursiveRegexIterator::current()メソッドは、ディレクトリを再帰的に走査し、正規表現に一致するファイルやディレクトリをフィルタリングする際に、現在位置の要素を取得するために使用されます。このメソッドは引数を持ちません。戻り値は、RecursiveRegexIteratorの動作モードによって異なり、string、array、またはnullとなります。

特に、コンストラクタでRecursiveRegexIterator::GET_MATCHモードを指定した場合、current()は正規表現のマッチ結果を格納した配列を返します。この配列の最初の要素には、正規表現全体にマッチした文字列（例えばファイルパス）が含まれます。

サンプルコードでは、現在のスクリプトがあるディレクトリ（__DIR__）のサブディレクトリから、.phpで終わるファイルを再帰的に検索しています。RecursiveDirectoryIteratorとRecursiveIteratorIteratorでディレクトリを走査し、RecursiveRegexIteratorでファイル名をフィルタリングします。foreachループ内で各要素についてcurrent()メソッドを明示的に呼び出し、それが正規表現にマッチしたファイルパスを配列として返していることを示しています。これにより、ファイルシステム内で特定の条件を満たす要素を効率的に特定し、その情報をプログラムで利用できるようになります。

RecursiveRegexIterator::current() メソッドは、コンストラクタで指定するモードによって戻り値の型が異なります。サンプルコードでは RecursiveRegexIterator::GET_MATCH モードを使用しており、この場合 current() は正規表現のマッチ結果を配列として返します。配列の最初の要素 $currentValue[0] が正規表現全体に一致した文字列です。他のモードではファイルパスの文字列や null を返すことがありますので、利用する際はモードとリファレンスの戻り値の型を必ず確認してください。foreach ループで要素を取得している場合でも、current() メソッドはイテレータが現在指している要素を明示的に取得する際に使用します。

PHPでmonth.txtファイルを取得する


1<?php
2
3/**
4 * RecursiveRegexIterator::current() のサンプルコード
5 *
6 * このスクリプトは、RecursiveRegexIterator を使用してファイルシステムを走査し、
7 * 特定の正規表現にマッチするファイルのパスを取得する方法を示します。
8 * RecursiveRegexIterator::current() メソッドが、現在のイテレータ要素（ファイルパスの文字列）を
9 * どのように返すかを具体的な例で確認できます。
10 *
11 * キーワード「php current month」に対応するため、ファイル名に「month」という単語を含み、
12 * 拡張子が「.txt」であるファイルを検索する例を提示します。
13 */
14
15// 一時的なディレクトリとファイルを生成します。
16// スクリプトの実行ディレクトリ内に一時的なフォルダが作成されます。
17$tempDir = __DIR__ . DIRECTORY_SEPARATOR . 'temp_data_' . uniqid();
18if (!mkdir($tempDir) && !is_dir($tempDir)) {
19    echo "Error: Failed to create temporary directory '{$tempDir}'.\n";
20    exit(1);
21}
22
23// テスト用のファイルをいくつか作成します。
24// 'month' を含む .txt ファイルとそうでないファイルを含めます。
25file_put_contents($tempDir . DIRECTORY_SEPARATOR . 'report_this_month.txt', 'Monthly report data');
26file_put_contents($tempDir . DIRECTORY_SEPARATOR . 'yearly_summary.csv', 'Yearly summary data');
27file_put_contents($tempDir . DIRECTORY_SEPARATOR . 'another_month_file.log', 'Log data for another month');
28// サブディレクトリも作成し、その中にもテストファイルを作成します。
29if (!mkdir($tempDir . DIRECTORY_SEPARATOR . 'subdir') && !is_dir($tempDir . DIRECTORY_SEPARATOR . 'subdir')) {
30    echo "Error: Failed to create temporary subdirectory.\n";
31    exit(1);
32}
33file_put_contents($tempDir . DIRECTORY_SEPARATOR . 'subdir' . DIRECTORY_SEPARATOR . 'monthly_sales.txt', 'Monthly sales data');
34file_put_contents($tempDir . DIRECTORY_SEPARATOR . 'subdir' . DIRECTORY_SEPARATOR . 'weekly_report.txt', 'Weekly report data');
35
36echo "--- Searching for files containing 'month' in their filename and ending with '.txt' ---\n";
37
38try {
39    // 1. RecursiveDirectoryIterator: 指定されたディレクトリ内のファイルとサブディレクトリを走査します。
40    //    RecursiveDirectoryIterator::SKIP_DOTS を指定すると、'.' と '..' エントリがスキップされます。
41    $directoryIterator = new RecursiveDirectoryIterator(
42        $tempDir,
43        RecursiveDirectoryIterator::SKIP_DOTS
44    );
45
46    // 2. RecursiveIteratorIterator: RecursiveDirectoryIterator をラップして、
47    //    ネストされたディレクトリ構造を再帰的に（フラットに）走査できるようにします。
48    $recursiveIterator = new RecursiveIteratorIterator($directoryIterator);
49
50    // 3. RecursiveRegexIterator: RecursiveIteratorIterator をさらにラップして、
51    //    正規表現にマッチするファイルのみをフィルタリングします。
52    //
53    //    - '/month.*\.txt$/i': 正規表現パターン。
54    //      'month'という文字列を含み、その後任意の文字が続き、'.txt'で終わるファイル名にマッチします。
55    //      'i' フラグは、大文字小文字を区別せずにマッチすることを示します。
56    //    - RecursiveRegexIterator::GET_FILENAME: current() メソッドが、
57    //      正規表現が照合されたファイル名（完全なパスを含む文字列）を返すように指定します。
58    //      これにより、リファレンスで示されている戻り値の型 'string' が得られます。
59    $regexIterator = new RecursiveRegexIterator(
60        $recursiveIterator,
61        '/month.*\.txt$/i',
62        RecursiveRegexIterator::GET_FILENAME
63    );
64
65    // フィルタリングされたファイルについて反復処理（ループ）を行います。
66    // foreach ループは、イテレータの要素を一つずつ取り出します。
67    foreach ($regexIterator as $filePath => $fileInfo) {
68        // RecursiveRegexIterator::current() メソッドは、現在のイテレータ要素を返します。
69        // この例では RecursiveRegexIterator::GET_FILENAME フラグを使用しているため、
70        // マッチしたファイルの完全なパス（文字列）が返されます。
71        $currentFile = $regexIterator->current();
72
73        echo "Found file: " . $currentFile . "\n";
74    }
75
76} catch (UnexpectedValueException $e) {
77    // ディレクトリが見つからない場合などに発生する例外を捕捉します。
78    echo "Error processing directory: " . $e->getMessage() . "\n";
79} finally {
80    // スクリプトの実行後、生成した一時ディレクトリとファイルをクリーンアップします。
81    if (is_dir($tempDir)) {
82        // RecursiveIteratorIterator を使用して、一時ディレクトリ内のすべてのファイルとサブディレクトリを走査します。
83        // RecursiveDirectoryIterator::SKIP_DOTS: '.' と '..' をスキップします。
84        // RecursiveIteratorIterator::CHILD_FIRST: 子要素（ファイル）から削除し、その後親（ディレクトリ）を削除します。
85        $files = new RecursiveIteratorIterator(
86            new RecursiveDirectoryIterator($tempDir, RecursiveDirectoryIterator::SKIP_DOTS),
87            RecursiveIteratorIterator::CHILD_FIRST
88        );
89
90        foreach ($files as $fileinfo) {
91            // ファイルかディレクトリかによって削除方法を切り替えます。
92            $todo = ($fileinfo->isDir() ? 'rmdir' : 'unlink');
93            $todo($fileinfo->getRealPath()); // ファイルまたはディレクトリを削除します。
94        }
95        // 最後にルートの一時ディレクトリを削除します。
96        rmdir($tempDir);
97    }
98    echo "\n--- Cleanup complete ---\n";
99}

PHP 8のRecursiveRegexIterator::current()メソッドは、正規表現にマッチする要素を再帰的に走査するイテレータにおいて、現在の要素を返すために使用されます。このメソッドは引数を取りません。戻り値は、イテレータが保持する現在の要素の形式によってstring、array、またはnullとなります。

提供されたサンプルコードは、ファイルシステムを再帰的に検索し、「month」という単語を含み「.txt」で終わるファイルを正規表現でフィルタリングする例を示しています。RecursiveRegexIteratorは、RecursiveDirectoryIteratorとRecursiveIteratorIteratorを組み合わせることで、指定ディレクトリ内のサブディレクトリを含めたファイルを効率的に走査し、正規表現による絞り込みを可能にします。

このコードではRecursiveRegexIterator::GET_FILENAMEフラグが設定されているため、current()メソッドはマッチしたファイルの完全なパスを文字列として返します。したがって、foreachループ内で$regexIterator->current()を呼び出すと、発見されたファイルの絶対パスが取得され、ファイル名に「month」というキーワードを含む「.txt」ファイルを特定できます。このように、current()はイテレータの現在の位置にある具体的なデータを簡単に取り出すための重要な役割を担っています。

RecursiveRegexIterator::current()の戻り値は、コンストラクタで指定するフラグによって型が変わる点に注意が必要です。サンプルコードではファイルパスの文字列（string）が返されますが、正規表現のキャプチャ結果など（array）を返す設定も可能です。このクラスは複数のイテレータを組み合わせることで複雑なファイル操作を実現しますので、各イテレータの役割（ディレクトリ走査、再帰処理、正規表現フィルタリング）を理解することが重要です。正規表現のパターンは慎重に記述し、意図したファイルのみにマッチするかを事前に確認してください。また、一時ディレクトリやファイル操作を含むコードは、実行環境への影響を考慮し、必ずクリーンアップ処理を適切に記述することが安全利用の鍵です。