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

Copy
1<?php
2
3/**
4 * RecursiveRegexIterator::key() メソッドのサンプルコード
5 *
6 * このコードは、一時的なディレクトリとファイルを作成し、
7 * RecursiveRegexIterator を使用して特定のパターンにマッチするファイルのパス（キー）を列挙します。
8 * RecursiveRegexIterator::key() メソッドが現在のイテレータ要素のキーを返す様子を示します。
9 * 「php key exists」というキーワードに対し、フィルタリングされた有効な要素のキーが存在することを示します。
10 */
11function demonstrateRecursiveRegexIteratorKey(): void
12{
13    // 一時的なディレクトリとファイルを作成し、テスト環境をセットアップ
14    $tempDir = sys_get_temp_dir() . DIRECTORY_SEPARATOR . 'regex_iterator_test_' . uniqid();
15    if (!mkdir($tempDir) && !is_dir($tempDir)) {
16        throw new \RuntimeException(sprintf('Directory "%s" was not created', $tempDir));
17    }
18    file_put_contents($tempDir . DIRECTORY_SEPARATOR . 'document.txt', 'This is a text file.');
19    file_put_contents($tempDir . DIRECTORY_SEPARATOR . 'image.jpg', 'This is an image file.');
20    mkdir($tempDir . DIRECTORY_SEPARATOR . 'subdir');
21    file_put_contents($tempDir . DIRECTORY_SEPARATOR . 'subdir' . DIRECTORY_SEPARATOR . 'report.txt', 'This is another text file.');
22    file_put_contents($tempDir . DIRECTORY_SEPARATOR . 'subdir' . DIRECTORY_SEPARATOR . 'config.ini', 'Configuration data.');
23
24    echo "--- フィルタリング対象のキー（パス）の列挙 ---\n";
25
26    try {
27        // 1. RecursiveDirectoryIterator を作成し、指定されたディレクトリを再帰的に走査
28        $directoryIterator = new RecursiveDirectoryIterator(
29            $tempDir,
30            FilesystemIterator::SKIP_DOTS // '.' と '..' をスキップ
31        );
32
33        // 2. RecursiveRegexIterator を作成し、RecursiveDirectoryIterator をフィルタリング
34        //    ここでは、正規表現 '/\.txt$/i' (末尾が .txt のファイル、大文字小文字を区別しない) に
35        //    マッチするキー（ファイルパス）のみを通過させます。
36        //    RecursiveRegexIterator::MATCH はデフォルトなので省略可能
37        $regexIterator = new RecursiveRegexIterator(
38            $directoryIterator,
39            '/\.txt$/i'
40        );
41
42        // 3. RecursiveIteratorIterator を作成し、再帰的なイテレータを平坦化
43        //    これにより、再帰的なディレクトリ構造を単一の foreach ループで処理できます。
44        $iterator = new RecursiveIteratorIterator($regexIterator);
45
46        echo "正規表現 '/\\.txt$/i' にマッチしたファイルパス:\n";
47
48        // 4. イテレータをループし、各要素のキーを取得して表示
49        foreach ($iterator as $item) {
50            // RecursiveRegexIterator::key() メソッドは、現在のイテレータ要素のキーを返します。
51            // RecursiveDirectoryIterator の場合、キーはファイルまたはディレクトリの完全なパスです。
52            // foreach ループは有効な要素のみを処理するため、ここで key() が呼び出されるとき、
53            // そのキーは「存在する」と言えます。
54            $key = $iterator->key();
55            echo "  キー: " . $key . "\n";
56        }
57    } finally {
58        // テスト後に一時ディレクトリとファイルをクリーンアップ
59        echo "\n--- クリーンアップ ---\n";
60        $files = new RecursiveIteratorIterator(
61            new RecursiveDirectoryIterator($tempDir, FilesystemIterator::SKIP_DOTS),
62            RecursiveIteratorIterator::CHILD_FIRST
63        );
64
65        foreach ($files as $fileinfo) {
66            if ($fileinfo->isDir()) {
67                rmdir($fileinfo->getRealPath());
68            } else {
69                unlink($fileinfo->getRealPath());
70            }
71        }
72        rmdir($tempDir);
73        echo "一時ディレクトリ '" . $tempDir . "' を削除しました。\n";
74    }
75}
76
77// サンプル関数の実行
78demonstrateRecursiveRegexIteratorKey();

RecursiveRegexIterator::key() メソッドは、PHPのイテレータが現在指している要素の「キー」を返します。このメソッドに引数はなく、戻り値はmixed型ですが、多くの場合、フィルタリングされたファイルやディレクトリの完全なパス（文字列）として返されます。

このサンプルコードでは、まず一時的なディレクトリと複数のファイルを準備し、テスト環境を構築しています。次に、RecursiveDirectoryIteratorでそのディレクトリを再帰的に走査し、さらにRecursiveRegexIteratorを用いて、正規表現'/\.txt$/i'（末尾が.txtのファイル）にマッチする要素のみをフィルタリングしています。

その後、RecursiveIteratorIteratorでこのイテレータを平坦化し、foreachループで処理しています。ループ内で$iterator->key()を呼び出すと、正規表現フィルタを通過した有効な.txtファイルのパスがキーとして取得され、画面に表示されます。「php key exists」というキーワードが示すように、このメソッドはフィルタリング条件を満たし、実際に存在する要素のキーを正確に取得できることを示しています。ファイルシステム内を探索し、特定の条件に合致するファイルのパスを効率的に取得する際に役立つメソッドです。

Copy
1<?php
2
3/**
4 * RecursiveRegexIterator::key() メソッドの使用例を示します。
5 * RecursiveRegexIterator は、再帰的なイテレータを正規表現でフィルタリングするために使用されます。
6 * key() メソッドは、フィルタリング後の現在の要素のキーを返します。
7 */
8function demonstrateRecursiveRegexIteratorKey(): void
9{
10    // 複数の階層を持つ配列データを用意します。
11    $data = [
12        'fruits' => [
13            'apple' => 'red',
14            'banana' => 'yellow',
15        ],
16        'vegetables' => [
17            'carrot' => 'orange',
18            'potato' => 'brown',
19            'leafy' => [
20                'spinach' => 'green',
21                'lettuce' => 'light green',
22            ],
23        ],
24        'dairy' => 'milk',
25    ];
26
27    echo "--- フィルタリング前のデータ構造 (部分表示) ---\n";
28    // データの全体像を理解しやすくするため、一部を表示します。
29    echo "例: fruits => [ apple => red, banana => yellow ], ...\n\n";
30
31    // 1. RecursiveArrayIterator で配列を再帰可能なイテレータとしてラップします。
32    $arrayIterator = new RecursiveArrayIterator($data);
33
34    // 2. RecursiveIteratorIterator で再帰的なイテレータをフラット化し、
35    //    全ての階層の要素を順にイテレートできるようにします。
36    $recursiveIterator = new RecursiveIteratorIterator($arrayIterator);
37
38    // 3. RecursiveRegexIterator で、正規表現にマッチするキーを持つ要素のみをフィルタリングします。
39    //    ここでは、キーに 'a' または 'o' を含む要素を検索します。
40    $regexIterator = new RecursiveRegexIterator(
41        $recursiveIterator,
42        '/(a|o)/i', // キーに 'a' または 'o' が含まれるかを大文字小文字を区別せずマッチ
43        RecursiveRegexIterator::MODE_KEY // 正規表現をキーに対して適用するモード
44    );
45
46    echo "--- キーに 'a' または 'o' を含むフィルタリングされたデータ ---\n";
47    echo "形式: 現在のキー => 値\n";
48
49    // 4. foreach ループでフィルタリングされた要素をイテレートします。
50    foreach ($regexIterator as $key => $value) {
51        // $key 変数は、RecursiveRegexIterator::key() メソッドによって返される
52        // 現在イテレートしている要素のキーを表します。
53        echo "{$key} => {$value}\n";
54    }
55}
56
57// 上記のデモンストレーション関数を実行します。
58demonstrateRecursiveRegexIteratorKey();
59

PHPのRecursiveRegexIterator::key()メソッドは、多次元配列のような再帰的なデータ構造を正規表現でフィルタリングする際に、現在処理している要素の「キー」を取得するために使用されます。このメソッドは引数を取らず、フィルタリングされた要素のキーを様々な型（mixed）で返します。

サンプルコードでは、まず複数の階層を持つ配列データを用意し、RecursiveArrayIteratorとRecursiveIteratorIteratorを組み合わせて、配列の全ての要素を順にたどれるように準備しています。その上で、RecursiveRegexIteratorを使用し、キーに「a」または「o」が含まれる要素のみを抽出するよう設定しています。このフィルタリングは、RecursiveRegexIterator::MODE_KEYモードを指定することでキーに対して正規表現を適用しています。

foreachループでフィルタリング後のイテレータを処理する際、$key変数にはRecursiveRegexIterator::key()メソッドが内部的に返す値が代入されます。これにより、正規表現の条件に合致した要素のキーが正確に取得され、それに対応する値と共に表示されます。このメソッドは、複雑なデータ構造から特定のキーを持つ情報だけを効率的に取り出したい場合に役立ちます。