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

Copy
1<?php
2
3/**
4 * RecursiveCachingIterator の `key()` メソッドの使用例。
5 *
6 * この関数は多次元配列を定義し、RecursiveArrayIterator と RecursiveCachingIterator を
7 * 組み合わせて、配列の各要素とそのキーを再帰的に表示します。
8 *
9 * キーワード「php key exists」に対して、RecursiveCachingIterator::key() が返すキーは
10 * イテレータの現在の有効な位置に存在するキーであることを示します。
11 */
12function demonstrateRecursiveCachingIteratorKeyUsage(): void
13{
14    // サンプルとなる多次元配列
15    $data = [
16        'fruits' => [
17            'apple' => 'red',
18            'banana' => 'yellow',
19            'grape' => 'purple',
20        ],
21        'vegetables' => [
22            'carrot' => 'orange',
23            'potato' => 'brown',
24        ],
25        'dairy' => 'milk',
26        0 => 'water', // 数値キーの要素も対応
27        'empty_value_key' => '', // 値が空の要素もキーは存在
28    ];
29
30    // RecursiveArrayIterator を使用して配列をイテレート可能にする
31    $arrayIterator = new RecursiveArrayIterator($data);
32
33    // RecursiveCachingIterator で RecursiveArrayIterator をラップする。
34    // RecursiveCachingIterator は、子イテレータの要素をキャッシュする機能を持つが、
35    // `key()` メソッドの動作自体はラップされたイテレータのものを返します。
36    $cachingIterator = new RecursiveCachingIterator($arrayIterator);
37
38    // RecursiveCachingIterator は RecursiveIterator を実装しているため、
39    // RecursiveIteratorIterator と組み合わせて再帰的にイテレートする。
40    $recursiveIterator = new RecursiveIteratorIterator(
41        $cachingIterator,
42        RecursiveIteratorIterator::SELF_FIRST // 自身も子もイテレート対象とする
43    );
44
45    echo "Recursive Iteration with RecursiveCachingIterator::key():\n";
46    echo "---------------------------------------------------------\n";
47
48    // イテレータをループし、各要素のキーと値を取得
49    foreach ($recursiveIterator as $value) {
50        // RecursiveIteratorIterator::key() は、現在のイテレータが指す要素のキーを返す。
51        // これは、RecursiveCachingIterator::key() を経由して、元の配列のキーを取得している。
52        $key = $recursiveIterator->key();
53        $depth = $recursiveIterator->getDepth(); // 現在の要素の深さを取得
54
55        // イテレータが有効な要素を指している場合（すなわち、その位置にキーが存在する場合）に情報を表示。
56        // RecursiveCachingIterator::key() は、イテレータが valid() であれば常に有効なキーを返します。
57        // これにより、イテレーション中に現在の要素のキーが「存在する」ことを確認し、取得できます。
58        printf(
59            "%sKey: '%s', Value: '%s'\n",
60            str_repeat("  ", $depth), // 深さに応じてインデント
61            (string)$key, // キーの型は mixed なので文字列にキャストして表示
62            (string)$value // 値の型も mixed なので文字列にキャストして表示
63        );
64    }
65
66    echo "---------------------------------------------------------\n";
67}
68
69// 関数を実行してサンプルコードの動作を確認
70demonstrateRecursiveCachingIteratorKeyUsage();
71

PHPのRecursiveCachingIterator::key()メソッドは、多次元配列など、複雑な構造のデータを巡回（イテレート）する際に、現在処理している要素の「キー」を取得するために使われます。

このメソッドは引数を必要とせず、現在のイテレータが指す要素のキーを直接返します。戻り値の型はmixedであり、キーが文字列（例: 'fruits'）でも、数値（例: 0）でも、その実際の値をそのまま取得できます。RecursiveCachingIteratorは他のイテレータをラップして使用されるため、このkey()メソッドはラップしている元のイテレータが提供するキーを返します。

「php key exists」というキーワードに関連して、key()メソッドはイテレータが有効な要素を指している場合に常にその位置に存在するキーを返します。つまり、イテレータがvalid()メソッドで有効と判断される位置にあるとき、必ずキーが存在し、key()でそのキーを取得できるわけです。サンプルコードでは、多次元配列を再帰的に巡回し、各要素のキーを本メソッドで取得しています。これにより、イテレーション中に現在の要素をキーで識別し、データの構造を把握するのに役立ちます。