【PHP8.x】RecursiveRegexIterator::REPLACE定数の使い方

REPLACE定数の使い方について、初心者にもわかりやすく解説します。

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

基本的な使い方

REPLACE定数は、RecursiveRegexIteratorクラスの動作モードを「置換モード」に設定するために使用される定数です。RecursiveRegexIteratorは、再帰的なデータ構造（例えばディレクトリツリーなど）をたどりながら、各要素が指定された正規表現パターンにマッチするかを判定するクラスです。このREPLACE定数をコンストラクタの$mode引数に指定することで、イテレータのcurrent()メソッドが返す値の挙動が変わります。通常、current()は現在の要素そのものを返しますが、REPLACEモードでは、元の値に対してpreg_replace()関数による置換処理を実行した後の文字列を返します。これにより、イテレーションを行いながら、正規表現にマッチした部分を動的に置換した結果を効率的に取得できます。例えば、多くのファイル名から特定の接頭辞を削除した結果のリストを作成するような場合に役立ちます。

構文(syntax)


1<?php
2
3$data = new RecursiveArrayIterator([
4    'file_version_1.log',
5    'image.jpg',
6    'logs' => [
7        'system_debug.log',
8        'error_report.log',
9    ],
10    'data.csv'
11]);
12
13$iterator = new RecursiveIteratorIterator($data);
14
15$regexIterator = new RecursiveRegexIterator(
16    $iterator,
17    '/\.log$/',
18    RecursiveRegexIterator::REPLACE
19);
20
21$regexIterator->replacement = '.txt';
22
23foreach ($regexIterator as $item) {
24    echo $item . PHP_EOL;
25}

引数(parameters)

引数なし

引数はありません

戻り値(return)

int

RecursiveRegexIterator::REPLACE は、再帰的な正規表現イテレータがパターンにマッチした部分を置換することを指定する整数定数です。

サンプルコード

PHP RecursiveRegexIterator::REPLACE で正規表現置換


1<?php
2
3/**
4 * RecursiveRegexIterator::REPLACE 定数を使用して、再帰的なデータ構造内で正規表現による置換を行う例。
5 *
6 * この定数は、RecursiveRegexIterator がイテレート中に正規表現にマッチした文字列を
7 * 指定された置換文字列で置き換えるモードを指定します。
8 * イテレータは置換後の値を返しますが、元のデータ構造は変更されません。
9 */
10
11// 1. サンプルとなる再帰的なデータ構造を準備します。
12$data = [
13    'category_a' => [
14        'item_1' => 'apple pie recipe',
15        'item_2' => 'banana smoothie recipe',
16    ],
17    'category_b' => 'carrot cake recipe',
18    'category_c' => [
19        'sub_category_c' => 'apple juice concentrate',
20        'item_3' => 'grape jelly',
21    ],
22    'item_without_match' => 'no_apple_here',
23];
24
25echo "--- 元のデータ ---\n";
26print_r($data);
27
28// 2. RecursiveArrayIterator を作成し、元のデータを再帰的にイテレートできるようにします。
29$recursiveIterator = new RecursiveArrayIterator($data);
30
31// 3. RecursiveRegexIterator を作成し、REPLACE モードで正規表現置換を適用します。
32//    - 第1引数: 基になる再帰イテレータ ($recursiveIterator)
33//    - 第2引数: 正規表現パターン ('/apple/' にマッチ)
34//    - 第3引数: モードとして RecursiveRegexIterator::REPLACE を指定
35//    - 第4引数: (オプション) 正規表現フラグ。ここでは0 (デフォルト)
36//    - 第5引数: (REPLACE モードの場合必須) マッチした部分を置き換える文字列 ('orange')
37$regexIterator = new RecursiveRegexIterator(
38    $recursiveIterator,
39    '/apple/', // 'apple' にマッチする正規表現パターン
40    RecursiveRegexIterator::REPLACE, // マッチした部分を置換するモード
41    0, // 正規表現フラグ (例: PREG_OFFSET_CAPTURE など。ここでは指定なし)
42    'orange' // 置換文字列
43);
44
45echo "\n--- RecursiveRegexIterator::REPLACE を使用した置換結果 ---\n";
46echo "(イテレータが返す値は置換されますが、元のデータ配列は変更されません)\n";
47
48// RecursiveIteratorIterator を使用して、ネストされた要素もフラットにイテレートします。
49foreach (new RecursiveIteratorIterator($regexIterator) as $key => $value) {
50    // $value は正規表現によって置換された文字列になります。
51    // マッチしない要素はそのままの値が返されます。
52    echo "キー: " . $key . ", 置換後の値: " . $value . "\n";
53}
54
55echo "\n--- 元のデータ (変更されていないことを確認) ---\n";
56print_r($data);
57

PHP 8のRecursiveRegexIterator::REPLACE定数は、RecursiveRegexIteratorクラスで使用されるモードの一つです。この定数を指定すると、再帰的なデータ構造をイテレートする際に、正規表現にマッチした文字列を指定された置換文字列で置き換える挙動が適用されます。この定数自体は引数を持たず、その値は整数型です。

サンプルコードでは、ネストされた配列をRecursiveArrayIteratorでラップし、さらにRecursiveRegexIteratorで加工しています。RecursiveRegexIteratorのコンストラクタに、基になるイテレータ、正規表現パターン（例: '/apple/'）、そしてモードとしてRecursiveRegexIterator::REPLACE、置換文字列（例: 'orange'）を渡して使用します。これにより、イテレータが反復処理を行う際、パターンにマッチした「apple」という部分が「orange」に置き換えられた値が返されます。

特に重要な点は、この置換処理はイテレータが返す値にのみ適用されることです。元のデータ構造自体は変更されません。サンプルコードの出力では、RecursiveIteratorIteratorを使ってイテレータの各要素を処理し、置換された値が表示されることが確認できます。最後に元の配列を出力することで、データが変更されていないことも示されており、元のデータを保持したまま、特定の条件で加工したデータにアクセスできる柔軟な処理が実現可能です。

この定数は、ネストされたデータ構造内で正規表現にマッチした文字列を、指定した置換文字列で置き換えるモードを指定します。最も重要な注意点は、イテレータが返す値は置換されますが、元のデータ構造（配列など）自体は一切変更されないことです。そのため、変更後のデータが必要な場合は、イテレータから得られた値を新しい変数に格納する必要があります。また、RecursiveRegexIteratorをREPLACEモードで使用する際は、コンストラクタの第5引数に必ず置換文字列を指定してください。正規表現にマッチしない要素は、元の値がそのまま返されます。この機能は、データ変換や特定の文字列のマスキングなどに役立ちます。