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

Copy
1<?php
2
3/**
4 * ネストされた配列内を再帰的に探索し、指定されたキーが存在するかどうかを確認します。
5 *
6 * RecursiveIteratorIterator は、多次元配列などの再帰的な構造をフラットに（一次元的に）
7 * 処理するためのイテレータです。key() メソッドは、ループ中の現在の要素のキーを返します。
8 * これを利用して、深い階層にあるキーの存在を簡単にチェックできます。
9 *
10 * @param array<mixed> $data 探索対象の多次元配列
11 * @param string|int $searchKey 探索するキー
12 * @return void
13 */
14function checkKeyExistsInNestedArray(array $data, string|int $searchKey): void
15{
16    // 多次元配列を扱うための RecursiveArrayIterator を作成します。
17    $arrayIterator = new RecursiveArrayIterator($data);
18
19    // RecursiveArrayIterator を使って、再帰的な処理を行うイテレータを作成します。
20    $iterator = new RecursiveIteratorIterator($arrayIterator);
21
22    $keyFound = false;
23    $foundValue = null;
24
25    // foreachでイテレータをループ処理します。これにより配列の全要素にアクセスできます。
26    foreach ($iterator as $value) {
27        // key() メソッドで現在の要素のキーを取得し、探しているキーと一致するかを比較します。
28        if ($iterator->key() === $searchKey) {
29            $keyFound = true;
30            $foundValue = $value;
31            // キーが見つかったらループを終了します。
32            break;
33        }
34    }
35
36    // 結果を出力します。
37    if ($keyFound) {
38        echo "キー '{$searchKey}' は存在します。値: " . var_export($foundValue, true) . PHP_EOL;
39    } else {
40        echo "キー '{$searchKey}' は存在しません。" . PHP_EOL;
41    }
42}
43
44// サンプルデータとなる多次元配列
45$userData = [
46    'id' => 1,
47    'info' => [
48        'name' => 'Taro Yamada',
49        'contact' => [
50            'email' => 'taro@example.com',
51            'phone' => '090-1234-5678',
52        ],
53    ],
54    'roles' => ['admin', 'editor'],
55];
56
57// 'email' キーが存在するかどうかをチェックします (存在するケース)
58checkKeyExistsInNestedArray($userData, 'email');
59
60// 'address' キーが存在するかどうかをチェックします (存在しないケース)
61checkKeyExistsInNestedArray($userData, 'address');
62
63?>

このPHPコードは、多次元配列（入れ子になった配列）の中から、指定したキーが存在するかどうかを再帰的に探索する方法を示しています。 複雑な階層構造を持つ配列を効率的に処理するために、RecursiveIteratorIteratorクラスを利用します。このクラスは、深い階層にある要素も含めて、あたかも一つの平坦なリストのように順番に扱えるようにする便利な道具です。 foreachループで配列の全要素を一つずつ処理していく中で、$iterator->key()メソッドが重要な役割を果たします。key()メソッドは、現在処理している要素のキーを取得します。このメソッドに引数はなく、現在のキー（文字列または数値）を戻り値として返します。 サンプルコードでは、このkey()メソッドで取得したキーが、関数に渡された探したいキー（$searchKey）と一致するかを比較しています。もし一致するキーが見つかれば、そのキーと対応する値を出力して探索を終了します。最後まで見つからなかった場合は、キーが存在しない旨のメッセージが表示されます。この手法により、配列の階層の深さを意識することなく、簡潔なコードでキーの存在をチェックできます。

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * 多次元配列のキーと値を再帰的に表示します。
7 *
8 * RecursiveIteratorIterator を使用して、多次元配列のすべての末端要素（葉）を
9 * 順にたどり、そのキー(key)と値(value)のペアを出力します。
10 */
11function displayRecursiveKeyValuePairs(): void
12{
13    // サンプルデータとなる多次元配列
14    $data = [
15        'user_id' => 101,
16        'name' => 'Taro Yamada',
17        'contact' => [
18            'email' => 'taro@example.com',
19            'phone' => '090-1234-5678'
20        ],
21        'skills' => [
22            'PHP',
23            'JavaScript',
24            'Database' => [
25                'MySQL',
26                'PostgreSQL'
27            ]
28        ]
29    ];
30
31    // 多次元配列から再帰的なイテレータを作成します
32    $arrayIterator = new RecursiveArrayIterator($data);
33
34    // 再帰的なイテレータをフラットに（一次元的に）処理するためのイテレータを作成します
35    $iterator = new RecursiveIteratorIterator($arrayIterator);
36
37    echo "多次元配列のすべてのキー(key)と値(value)を表示します:\n\n";
38
39    // イテレータをループ処理します
40    foreach ($iterator as $value) {
41        // RecursiveIteratorIterator::key() を使って現在の要素のキーを取得します
42        $key = $iterator->key();
43
44        // 取得したキーと値を出力します
45        // is_string() でキーが文字列の場合のみクォートで囲み、見やすくしています
46        $formattedKey = is_string($key) ? "'{$key}'" : $key;
47        printf("Key: %-15s => Value: '%s'\n", $formattedKey, $value);
48    }
49}
50
51// 関数を実行して結果を表示します
52displayRecursiveKeyValuePairs();

このPHPコードで使われているRecursiveIteratorIterator::key()メソッドは、多次元配列などを再帰的に（入れ子の奥まで）繰り返し処理する際に、現在位置にある要素のキーを取得するためのものです。

RecursiveIteratorIteratorは、深い階層を持つ多次元配列を、foreachループを使ってあたかも一次元のリストのように扱うことを可能にします。サンプルコードのforeach ($iterator as $value)ループでは、変数$valueに配列の末端の値が順番に代入されますが、その値に対応するキーは自動的には取得できません。

そこで$iterator->key()を呼び出すことで、現在の値（$value）に対応するキーを明示的に取得します。このメソッドは引数を必要としません。戻り値は、元の配列のキーに応じて文字列（例: 'name'）や数値（例: 0）など様々であるため、データ型はmixed型となります。

サンプルコードでは、このkey()メソッドで取得したキーを変数$keyに代入し、foreachで得られる値と組み合わせて出力しています。これにより、複雑な構造の配列であっても、全ての末端要素のキーと値のペアを簡単に一覧表示することができています。