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

Copy
1<?php
2declare(strict_types=1);
3
4/**
5 * ParentIterator::key() の使用例を示すクラス
6 *
7 * このクラスは、多次元配列を再帰的に走査し、
8 * 各要素のキーが存在することを確認して出力します。
9 * RecursiveIteratorIterator は ParentIterator を継承しているため、
10 * この例は ParentIterator::key() の動作を示しています。
11 */
12class KeyExistenceChecker
13{
14    /**
15     * 配列内のキーと値を走査して表示します。
16     *
17     * @param array<mixed> $data 走査する多次元配列
18     */
19    public function checkKeys(array $data): void
20    {
21        // 配列から再帰的なイテレータを作成します。
22        $arrayIterator = new RecursiveArrayIterator($data);
23        $iterator = new RecursiveIteratorIterator($arrayIterator);
24
25        echo "配列内のキーの存在を確認し、その値を出力します。\n";
26        echo "--------------------------------------------------\n";
27
28        // イテレータを使って配列の全要素をループ処理します。
29        foreach ($iterator as $value) {
30            // ParentIterator::key() は内部イテレータの現在のキーを返します。
31            // このメソッドを使って、キーが存在することを確認し、その値と共に出力します。
32            // キーは文字列または整数 (mixed) となります。
33            printf(
34                "キー '%s' (型: %s) が存在します。値: %s\n",
35                $iterator->key(),
36                gettype($iterator->key()),
37                var_export($value, true)
38            );
39        }
40    }
41}
42
43// サンプルデータとなる多次元配列
44$sampleData = [
45    'user_profile' => [
46        'id' => 101,
47        'name' => 'Taro Yamada',
48    ],
49    'tags' => [
50        'PHP',      // この要素のキーは 0
51        'Iterator', // この要素のキーは 1
52    ],
53    'is_active' => true,
54];
55
56// クラスのインスタンスを作成し、メソッドを実行します。
57$checker = new KeyExistenceChecker();
58$checker->checkKeys($sampleData);

ParentIterator::key()は、イテレータが現在指している要素のキーを取得するためのメソッドです。このメソッドは引数を必要としません。戻り値は、現在の要素のキーであり、その型は文字列または整数など様々であるためmixed型となります。

サンプルコードでは、多次元配列を再帰的に走査するためにRecursiveIteratorIteratorを使用しています。このクラスはParentIteratorを継承しているため、key()メソッドを呼び出すことができます。

foreachループで配列の各要素を順番に処理しています。ループの内部で$iterator->key()を呼び出すと、その時点で処理対象となっている要素のキーが返されます。例えば、'user_profile'、'id'、0、1といったキーが順番に取得されます。このメソッドを利用することで、ループ処理中に現在のキーが何であるかを確実に把握でき、キーが存在することの確認にも繋がります。

コードの実行結果では、printf関数によって、key()で取得したキーとその型、そして対応する値がセットで出力されていることが確認できます。このようにParentIterator::key()は、イテレータを使った処理において、現在のキー情報へアクセスする際に重要な役割を果たします。

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * ParentIterator::key() の使用例を示すクラス
7 *
8 * このクラスは、親子関係を持つ多次元配列を ParentIterator を使って走査し、
9 * 親のキーと、それに対応する子のキーと値のペアを出力します。
10 */
11class ParentIteratorExample
12{
13    /**
14     * サンプルコードを実行します。
15     *
16     * ParentIterator は、別の RecursiveIterator をラップし、
17     * 親の階層の要素にアクセスする機能を提供します。
18     */
19    public function run(): void
20    {
21        // 親子関係を持つ多次元連想配列を定義します
22        $categories = [
23            'fruits' => [
24                'red' => 'apple',
25                'yellow' => 'banana',
26            ],
27            'vegetables' => [
28                'orange' => 'carrot',
29                'brown' => 'potato',
30            ],
31        ];
32
33        // 配列を再帰的に走査するためのイテレータを作成します
34        $recursiveIterator = new RecursiveArrayIterator($categories);
35
36        // RecursiveIterator を ParentIterator でラップします
37        $parentIterator = new ParentIterator($recursiveIterator);
38
39        // ParentIterator を使ってループ処理します
40        // このループは最上位の階層 ('fruits', 'vegetables') を走査します
41        foreach ($parentIterator as $key => $value) {
42            // ParentIterator::key() を使って現在の親のキーを取得します。
43            // foreach ループで取得した $key と同じ値が返されます。
44            $parentKey = $parentIterator->key();
45            echo "Parent Key: {$parentKey}\n";
46
47            // 親が子要素（この例では配列）を持つか確認します
48            if ($parentIterator->hasChildren()) {
49                // getChildren() で子要素のイテレータを取得し、ループ処理します
50                foreach ($parentIterator->getChildren() as $childKey => $childValue) {
51                    echo "  - Child Key: {$childKey}, Value: {$childValue}\n";
52                }
53            }
54        }
55    }
56}
57
58// クラスのインスタンスを作成して実行します
59$example = new ParentIteratorExample();
60$example->run();
61

ParentIterator::key()メソッドは、ParentIteratorが現在指し示している親要素のキーを取得するために使用します。このメソッドに引数はありません。戻り値は現在の親のキーで、キーは文字列や整数など様々な可能性があるため、データ型はmixed型となります。

サンプルコードでは、入れ子構造になった連想配列を扱っています。まず、この配列を再帰的に走査するためのRecursiveArrayIteratorを作成し、さらにそれをParentIteratorでラップします。foreachループを使ってParentIteratorを処理すると、配列の最上位の階層、つまり'fruits'と'vegetables'が順番に処理されます。

ループの内部で$parentIterator->key()を呼び出すと、その時点での親のキー（最初のループでは'fruits'、次は'vegetables'）が返されます。このコードでは、foreach構文のas $key => $valueで取得できる$keyと、$parentIterator->key()の戻り値が同じであることを示しています。このように、親子関係を持つ複雑なデータを扱う際に、現在の親のキーを明確に取得できる便利なメソッドです。