【PHP8.x】RegexIterator::USE_KEY定数の使い方

Copy
1<?php
2
3/**
4 * 連想配列のキーを正規表現でフィルタリングし、結果をクロージャで加工します。
5 *
6 * RegexIterator::USE_KEY を使用して、正規表現をイテレータのキーに適用します。
7 * クロージャの `use` キーワードを使って、外部変数をクロージャ内で利用する方法も示します。
8 *
9 * @param array<string, mixed> $data フィルタリングする元の連想配列。
10 * @param string $regexPattern キーに適用する正規表現パターン。
11 * @return array<int, string> フィルタリングされ、加工された結果の配列。
12 */
13function filterAndProcessWithRegexKeyAndClosure(array $data, string $regexPattern): array
14{
15    // 1. ArrayIterator を使用して、配列をイテレータとして扱います。
16    $arrayIterator = new ArrayIterator($data);
17
18    // 2. RegexIterator を作成し、キーに対して正規表現を適用するように設定します。
19    //    RegexIterator::USE_KEY は、正規表現を値ではなくキーに適用することを指示します。
20    //    これにより、正規表現パターン $regexPattern が配列のキーに対して評価されます。
21    $regexIterator = new RegexIterator(
22        $arrayIterator,
23        $regexPattern,
24        RegexIterator::MATCH,
25        RegexIterator::USE_KEY
26    );
27
28    // クロージャ内で利用する外部変数を定義します。
29    $prefix = "PROCESSED_ITEM: ";
30
31    // 3. フィルタリングされた各要素をクロージャで加工します。
32    //    このクロージャは、外部変数 $prefix を `use` キーワードでスコープに取り込みます。
33    $itemProcessor = function (string $key, mixed $value) use ($prefix): string {
34        // キーと値を結合し、`$prefix` を前置して返します。
35        return $prefix . strtoupper($key) . " -> " . $value;
36    };
37
38    $processedResults = [];
39    foreach ($regexIterator as $key => $value) {
40        $processedResults[] = $itemProcessor($key, $value);
41    }
42
43    return $processedResults;
44}
45
46// サンプルデータ
47$sampleData = [
48    "apple" => 100,
49    "banana" => 150,
50    "apricot" => 200,
51    "orange" => 120,
52    "grape" => 180,
53    "pineapple" => 250,
54];
55
56// キーが "ap" で始まる要素をフィルタリングする正規表現パターン
57$pattern = '/^ap/';
58
59// 関数を呼び出して結果を取得
60$filteredAndProcessedItems = filterAndProcessWithRegexKeyAndClosure($sampleData, $pattern);
61
62// 結果を表示
63echo "--- キーが \"ap\" で始まるアイテム ---" . PHP_EOL;
64foreach ($filteredAndProcessedItems as $item) {
65    echo $item . PHP_EOL;
66}
67echo "-------------------------------------" . PHP_EOL;
68
69// 別のパターンで試す (キーに "grape" を含むもの)
70$pattern2 = '/grape/';
71$filteredAndProcessedItems2 = filterAndProcessWithRegexKeyAndClosure($sampleData, $pattern2);
72
73echo "--- キーに \"grape\" を含むアイテム ---" . PHP_EOL;
74foreach ($filteredAndProcessedItems2 as $item) {
75    echo $item . PHP_EOL;
76}
77echo "---------------------------------------" . PHP_EOL;
78
79?>

このサンプルコードは、PHPのRegexIterator::USE_KEY定数とクロージャにおけるuseキーワードの利用方法を組み合わせて、連想配列のキーを正規表現でフィルタリングし、さらに加工する方法を示しています。

RegexIterator::USE_KEYは、RegexIteratorのコンストラクタに渡される定数で、正規表現の適用対象をイテレータの「値」ではなく「キー」に切り替える役割を持ちます。これにより、配列のキーに対して正規表現パターンが評価され、特定のキーを持つ要素のみを効率的に抽出することが可能になります。

filterAndProcessWithRegexKeyAndClosure関数は、元の連想配列$dataとキーに適用する正規表現パターン$regexPatternを引数に取ります。関数内では、まずArrayIteratorで$dataをイテレータ化し、その後にRegexIteratorに渡して$regexPatternとRegexIterator::USE_KEYを指定することで、キーによるフィルタリングを行います。

抽出された各要素の加工にはクロージャ（無名関数）が使用されています。このクロージャは、外部で定義された$prefix変数をuseキーワードでスコープに取り込んでいます。useキーワードを用いることで、クロージャの外部にある変数の値を、クロージャの内部で利用できるようになります。結果として、フィルタリングされた各要素のキーと値は、$prefixを含めて特定の形式に加工され、文字列の配列として戻り値として返されます。この機能は、特定の条件でデータを抽出し、柔軟に変換したい場合に非常に役立ちます。

Copy
1<?php
2
3/**
4 * 連想配列のキーに正規表現を適用してフィルタリングする関数。
5 * RegexIterator::USE_KEY を使用して、正規表現を値ではなくキーに適用する方法を示す。
6 *
7 * @param array $data フィルタリングする元の連想配列。
8 * @param string $pattern キーに適用する正規表現パターン。
9 * @return void
10 */
11function filterArrayByKeysRegex(array $data, string $pattern): void
12{
13    // 1. 元の配列をイテレータに変換
14    $arrayIterator = new ArrayIterator($data);
15
16    // 2. RegexIterator を作成し、キーに対して正規表現を適用するよう設定
17    $regexIterator = new RegexIterator(
18        $arrayIterator,
19        $pattern,
20        RegexIterator::MATCH,         // マッチした要素を返すモード
21        RegexIterator::USE_KEY        // ★ここが重要: 正規表現を「キー」に適用する
22    );
23
24    echo "--- キーがパターン '{$pattern}' にマッチする要素 ---" . PHP_EOL;
25
26    // フィルタリングされた要素をループ表示
27    $found = false;
28    foreach ($regexIterator as $key => $value) {
29        echo "  キー: {$key}, 値: {$value}" . PHP_EOL;
30        $found = true;
31    }
32
33    if (!$found) {
34        echo "  マッチする要素は見つかりませんでした。" . PHP_EOL;
35    }
36    echo "--------------------------------------------------" . PHP_EOL . PHP_EOL;
37}
38
39// サンプルデータ
40$products = [
41    'product_id_101' => 'ノートPC (Core i7)',
42    'item_code_A23'  => 'ワイヤレスマウス',
43    'product_id_102' => 'ゲーミングキーボード',
44    'service_name_X' => 'クラウドストレージ',
45    'product_id_203' => '外付けSSD 1TB',
46];
47
48// 関数の使用例1: キーが 'product_id_' で始まる要素をフィルタリング
49filterArrayByKeysRegex($products, '/^product_id_/');
50
51// 関数の使用例2: キーに '_A23' が含まれる要素をフィルタリング
52filterArrayByKeysRegex($products, '/_A23/');
53
54// 関数の使用例3: マッチしないパターンを試す
55filterArrayByKeysRegex($products, '/^software_/');

このPHPコードは、連想配列のキーに対して正規表現を適用し、指定されたパターンにマッチする要素のみを抽出する方法を示しています。filterArrayByKeysRegex関数は、フィルタリング対象の連想配列と正規表現パターンを引数として受け取ります。この関数は、マッチした要素を画面に出力するだけで、特定の値を返さないため、戻り値はvoidと定義されています。

このコードの重要な点は、RegexIterator::USE_KEY定数の利用です。通常、PHPのRegexIteratorは配列の「値」に対して正規表現によるマッチングを行いますが、RegexIterator::USE_KEYをコンストラクタの引数に含めることで、正規表現の適用対象を「値」から「キー」へと変更することができます。これにより、まずArrayIteratorで元の配列をイテレータに変換し、そのイテレータをRegexIteratorに渡すことで、配列のキーに基づいた柔軟なフィルタリングが可能になります。

サンプルでは、$productsという連想配列に対して、キーが「product_id_」で始まるものや「_A23」を含むものを抽出する例が示されています。これにより、複雑な命名規則を持つキーを持つデータから、特定の条件に合致する情報を効率的に検索・抽出する技術を学ぶことができます。