Webエンジニア向けプログラミング解説動画をYouTubeで配信中!
▶ チャンネル登録はこちら

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

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

作成日: 更新日:

基本的な使い方

getModeメソッドは、RecursiveRegexIteratorオブジェクトの現在の動作モードを取得するために実行するメソッドです。RecursiveRegexIteratorは、再帰的なイテレータが返す値に対して正規表現によるフィルタリングを行うためのクラスです。その際の動作は、インスタンス作成時に「モード」と呼ばれる設定値によって決定されます。このモードには、正規表現にマッチしたすべての結果を返す ALL_MATCHES、マッチした最初の部分文字列のみを返す GET_MATCH、あるいは正規表現を区切り文字として文字列を分割する SPLIT など、複数の定数が定義されています。getModeメソッドを呼び出すと、コンストラクタで指定されたこれらのモードに対応する整数値が返されます。これにより、開発者はプログラムの実行中にイテレータが現在どのモードで動作しているかを確認でき、その結果に応じて処理を条件分岐させるなど、より柔軟な制御を実装することが可能になります。

構文(syntax)

1public RecursiveRegexIterator::getMode(): int

引数(parameters)

引数なし

引数はありません

戻り値(return)

int

このメソッドは、イテレータが現在選択している正規表現マッチモードを表す整数を返します。

サンプルコード

PHP RecursiveRegexIterator getMode() 動作モード確認

1<?php
2
3/**
4 * RecursiveRegexIterator の動作モード定数を人間が読める文字列に変換するヘルパー関数。
5 * システムエンジニアを目指す初心者がモードの意味を理解しやすくするために提供しています。
6 *
7 * @param int $mode RecursiveRegexIterator::getMode() から返される整数値
8 * @return string モードの名前と簡単な説明
9 */
10function getRegexIteratorModeName(int $mode): string
11{
12    switch ($mode) {
13        case RecursiveRegexIterator::MODE_MATCH:
14            return 'MODE_MATCH (マッチする元の項目を返す)';
15        case RecursiveRegexIterator::MODE_GET_MATCH:
16            return 'MODE_GET_MATCH (マッチした結果の配列を返す)';
17        case RecursiveRegexIterator::MODE_ALL_MATCHES:
18            return 'MODE_ALL_MATCHES (正規表現の全マッチ結果の配列を返す)';
19        case RecursiveRegexIterator::MODE_KEY_PREFIX:
20            return 'MODE_KEY_PREFIX (キーが正規表現にマッチする項目を返す)';
21        default:
22            return '不明なモード';
23    }
24}
25
26// ----------------------------------------------------------------------------------------------------
27// RecursiveRegexIterator::getMode() の使用例
28// このコードは、一時的なディレクトリとファイルを作成し、それらに対してRecursiveRegexIteratorを適用します。
29// getMode() メソッドがどのように現在の動作モードを返すかを示します。
30// ----------------------------------------------------------------------------------------------------
31
32echo "--- RecursiveRegexIterator::getMode() の使用例 ---\n";
33echo "この例では、ファイルシステムを再帰的に走査し、正規表現でファイルをフィルタリングするイテレータの動作モードを確認します。\n\n";
34
35// 練習用のディレクトリとファイルを作成します。
36// このコードを単体で動作させるために必要な準備です。
37$tempDir = __DIR__ . '/temp_regex_files';
38if (!is_dir($tempDir)) {
39    mkdir($tempDir);
40}
41file_put_contents($tempDir . '/document_report.txt', 'This is a report.');
42file_put_contents($tempDir . '/image_photo.png', 'This is a photo.');
43file_put_contents($tempDir . '/document_plan.pdf', 'This is a plan.');
44file_put_contents($tempDir . '/memo_notes.txt', 'Some notes.');
45file_put_contents($tempDir . '/backup.log~', 'Backup log.'); // 正規表現で除外される可能性のあるファイル
46
47try {
48    // 1. RecursiveDirectoryIterator を使ってディレクトリを再帰的に走査します。
49    // FilesystemIterator::SKIP_DOTS フラグで '.' と '..' をスキップします。
50    $directoryIterator = new RecursiveDirectoryIterator(
51        $tempDir,
52        FilesystemIterator::SKIP_DOTS
53    );
54
55    // 2. RecursiveIteratorIterator を使って、再帰的な構造をフラットに扱えるようにします。
56    $recursiveIterator = new RecursiveIteratorIterator($directoryIterator);
57
58    // 3. RecursiveRegexIterator を使って、特定のファイル名パターンにマッチする項目のみをフィルタリングします。
59    // ここでは、'.txt' または '.pdf' で終わるファイルのみを対象とします。
60    $regexIterator = new RecursiveRegexIterator(
61        $recursiveIterator,
62        '/(\.txt|\.pdf)$/i' // 大文字小文字を区別せず、.txt または .pdf で終わるファイル
63    );
64
65    // 4. イテレータの現在の動作モードを取得します。
66    // デフォルトモードは RecursiveRegexIterator::MODE_MATCH です。
67    $currentMode = $regexIterator->getMode();
68    echo "初期のRecursiveRegexIteratorの動作モード: " . getRegexIteratorModeName($currentMode) . " (値: {$currentMode})\n\n";
69
70    echo "--- モードを変更して getMode() で確認します ---\n";
71
72    // 5. モードを RecursiveRegexIterator::MODE_GET_MATCH に設定します。
73    // このモードでは、イテレータは正規表現にマッチした結果の配列を返します。
74    $regexIterator->setMode(RecursiveRegexIterator::MODE_GET_MATCH);
75    $newMode = $regexIterator->getMode();
76    echo "MODE_GET_MATCH に変更後の動作モード: " . getRegexIteratorModeName($newMode) . " (値: {$newMode})\n\n";
77
78    echo "--- フィルタリングされたファイル一覧 (MODE_GET_MATCH の動作例) ---\n";
79    foreach ($regexIterator as $key => $value) {
80        // MODE_GET_MATCH では $value は正規表現のマッチ結果の配列になります。
81        // $key は元のイテレータのキー (ここではファイルパス)。
82        echo "ファイルパス (キー): {$key}\n";
83        echo "マッチ結果 (値): ";
84        print_r($value); // 例: Array ( [0] => .txt [1] => .txt )
85        echo "\n";
86    }
87
88    echo "\n--- モードを RecursiveRegexIterator::MODE_MATCH に戻して確認します ---\n";
89    // 6. モードを RecursiveRegexIterator::MODE_MATCH に戻します。
90    // このモードでは、元のイテレータの項目(ファイルオブジェクトなど)が正規表現にマッチした場合にその項目を返します。
91    $regexIterator->setMode(RecursiveRegexIterator::MODE_MATCH);
92    $anotherMode = $regexIterator->getMode();
93    echo "MODE_MATCH に変更後の動作モード: " . getRegexIteratorModeName($anotherMode) . " (値: {$anotherMode})\n\n";
94
95    echo "--- フィルタリングされたファイル一覧 (MODE_MATCH の動作例) ---\n";
96    foreach ($regexIterator as $filePath => $fileObject) {
97        // MODE_MATCH では $fileObject は SplFileInfo オブジェクトになります。
98        // $filePath はファイルパス。
99        echo "ファイルパス: {$filePath}\n";
100        echo "ファイル名: " . $fileObject->getFilename() . "\n";
101        echo "\n";
102    }
103
104} catch (UnexpectedValueException $e) {
105    echo "エラー: ディレクトリが存在しないか、アクセスできませんでした: " . $e->getMessage() . "\n";
106} finally {
107    // 後処理: 作成した一時ファイルとディレクトリを削除します。
108    if (is_dir($tempDir)) {
109        foreach (new FilesystemIterator($tempDir) as $file) {
110            unlink($file->getPathname());
111        }
112        rmdir($tempDir);
113    }
114}

RecursiveRegexIterator::getMode()は、PHPのRecursiveRegexIteratorオブジェクトが現在どのような「動作モード」で動いているかを取得するためのメソッドです。このメソッドは引数を一切取らず、戻り値として現在の動作モードを表す整数値(int)を返します。

RecursiveRegexIteratorは、正規表現を使ってイテレータから得られる項目をフィルタリングする際に使用され、その動作モードによって、マッチした際に「元のデータ項目」を返すのか、それとも「マッチした結果の配列」を返すのかといった、データの取得方法が変わります。getMode()で返される整数値は、RecursiveRegexIterator::MODE_MATCHやRecursiveRegexIterator::MODE_GET_MATCHといったクラス定数に対応しており、現在の設定を示します。

提供されたサンプルコードでは、一時的なファイル群に対しRecursiveDirectoryIteratorとRecursiveIteratorIteratorを組み合わせてディレクトリを走査し、RecursiveRegexIteratorで特定のファイル名パターン(.txtや.pdf)をフィルタリングしています。この例を通じて、まず初期状態でgetMode()が返すモードを確認し、次にsetMode()メソッドで動作モードを切り替えた後、再度getMode()を呼び出して変更が正しく反映されていることを検証しています。このように、getMode()はイテレータの現在の挙動を把握し、目的に応じて制御するための重要な手段となります。

RecursiveRegexIterator::getMode()は、イテレータの現在の動作モードを確認するために使用します。モードを変更するには必ずsetMode()メソッドを呼び出す必要があります。このクラスでは、設定されたモードによってforeachループで取得される値の形式が大きく異なりますので、特に注意が必要です。例えば、MODE_MATCHではフィルタリングされた元の項目(例: ファイルオブジェクト)が、MODE_GET_MATCHでは正規表現にマッチした結果の配列が返されます。デフォルトのモードはMODE_MATCHです。サンプルコードのように一時ファイルを扱う際は、実際のシステムで予期せぬ挙動を招かないよう、パスやアクセス権限の管理を徹底することが重要です。

PHP RecursiveRegexIterator getMode() を取得する

1<?php
2
3/**
4 * RecursiveRegexIterator の getMode() メソッドの使用例を示します。
5 *
6 * この関数は、指定されたディレクトリ内のファイルから、特定の正規表現に
7 * マッチするものをフィルタリングするイテレータを作成し、その設定された
8 * マッチングモードを取得して表示します。
9 *
10 * RecursiveRegexIterator は、RecursiveIterator (例: RecursiveDirectoryIterator) を
11 * 正規表現でフィルタリングするために使用されるイテレータです。
12 */
13function demonstrateRecursiveRegexIteratorGetMode(): void
14{
15    // 1. フィルタリング対象となるイテレータを準備します。
16    // RecursiveDirectoryIterator は、ディレクトリを再帰的に走査するためのイテレータです。
17    // ここでは、現在のスクリプトがあるディレクトリ(__DIR__)を対象とします。
18    // FilesystemIterator::SKIP_DOTS は '.' (カレントディレクトリ) と '..' (親ディレクトリ) をスキップします。
19    $directoryIterator = new RecursiveDirectoryIterator(
20        __DIR__,
21        FilesystemIterator::SKIP_DOTS
22    );
23
24    // 2. RecursiveIteratorIterator を使って、再帰的な走査を可能にします。
25    // RecursiveRegexIterator は RecursiveIterator を引数に取るため、
26    // 必要に応じて RecursiveIteratorIterator でラップします。
27    $recursiveIterator = new RecursiveIteratorIterator($directoryIterator);
28
29    // 3. RecursiveRegexIterator をインスタンス化します。
30    // 第1引数: フィルタリング対象のイテレータ ($recursiveIterator)
31    // 第2引数: 正規表現 (例: .php で終わるファイルを検索、大文字小文字を区別しない 'i' フラグ付き)
32    // 第3引数: マッチングモード (getMode() で取得できる値)
33    //
34    // RecursiveRegexIterator::GET_MATCH: 最初に見つかったマッチのみを配列で返すモード。
35    // その他の主要なモード:
36    //   - RecursiveRegexIterator::ALL_MATCHES: 正規表現にマッチした全ての結果を配列で返す。
37    //   - RecursiveRegexIterator::MATCH: マッチしたかどうか(真偽値: true/false)を返す。
38    $regexIterator = new RecursiveRegexIterator(
39        $recursiveIterator,
40        '/.*\.php$/i', // PHPファイルにマッチする正規表現
41        RecursiveRegexIterator::GET_MATCH
42    );
43
44    echo "--- RecursiveRegexIterator::getMode() の使用例 ---\n";
45
46    // 4. getMode() メソッドを呼び出し、イテレータの現在のマッチングモードを取得します。
47    $currentMode = $regexIterator->getMode();
48
49    echo "RecursiveRegexIterator に設定されたモードの値: " . $currentMode . "\n";
50
51    // 5. 取得したモードの値を人間が読める形式に変換して表示します。
52    echo "(モードの意味: ";
53    switch ($currentMode) {
54        case RecursiveRegexIterator::ALL_MATCHES:
55            echo "ALL_MATCHES - 正規表現にマッチした全ての結果を配列で返す";
56            break;
57        case RecursiveRegexIterator::GET_MATCH:
58            echo "GET_MATCH - 最初に見つかったマッチのみを配列で返す";
59            break;
60        case RecursiveRegexIterator::MATCH:
61            echo "MATCH - マッチしたかどうか(真偽値: true/false)を返す";
62            break;
63        default:
64            echo "不明なモード";
65            break;
66    }
67    echo ")\n";
68
69    // この例では getMode() の動作を示すのが目的のため、
70    // 実際にイテレータを走査する処理は省略しています。
71    // 必要であれば、以下のようにイテレータをループして結果を確認できます。
72    /*
73    echo "\n--- イテレータの走査例 (GET_MATCH モードの場合) ---\n";
74    foreach ($regexIterator as $path => $match) {
75        // $path はマッチしたファイルのフルパス
76        // $match は正規表現のマッチ結果(GET_MATCHモードの場合は最初のマッチを含む配列)
77        echo "マッチしたパス: " . $path . ", マッチ結果: " . var_export($match, true) . "\n";
78    }
79    */
80}
81
82// 関数を実行して、getMode() の動作を確認します。
83demonstrateRecursiveRegexIteratorGetMode();

RecursiveRegexIterator::getMode()メソッドは、PHPでファイルシステムを再帰的に走査し、正規表現を使って特定のファイルをフィルタリングする際に利用するRecursiveRegexIteratorオブジェクトに、現在設定されているマッチングモード(動作モード)を取得するためのメソッドです。

このメソッドは引数を一切取らず、戻り値として、現在のマッチングモードを示す整数値(int型)を返します。返される整数値は、例えばRecursiveRegexIterator::GET_MATCH、RecursiveRegexIterator::ALL_MATCHES、RecursiveRegexIterator::MATCHといったクラス定数に対応しており、それぞれ「最初に見つかったマッチのみを配列で返す」「正規表現にマッチした全ての結果を配列で返す」「マッチしたかどうかを真偽値で返す」という異なる動作モードを表します。

サンプルコードでは、現在のディレクトリにあるPHPファイルを検索するRecursiveRegexIteratorを、GET_MATCHモードで初期化しています。その後、getMode()メソッドを呼び出すことで、このイテレータに設定されているGET_MATCHモードの整数値を取得し、その値を表示しています。このように、getMode()を使用することで、イテレータがどのようなモードで動作するように設定されているかをプログラムから確認することができます。

getMode()は、イテレータが「どのようにマッチ結果を返すか」という現在の設定モードを整数値で取得するメソッドです。この整数値は、RecursiveRegexIterator::GET_MATCHなどのクラス定数と対応しており、コード内のswitch文のように具体的な意味を確認する必要があります。モードの実際の動作(例:マッチした全ての結果を返すか、最初の結果のみか)は、イテレータをforeachなどで走査した際に適用されます。getMode()を呼び出すだけではファイルシステムの走査やフィルタリングは行われません。また、モードはコンストラクタで一度設定されると、後から変更することはできません。

関連コンテンツ

関連IT用語

関連プログラミング言語