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

Copy
1<?php
2
3/**
4 * IteratorIterator::key() を使用して、
5 * イテレータブルなオブジェクト内に特定のキーが存在するかを確認するクラス。
6 */
7class KeyExistenceChecker
8{
9    /**
10     * 指定された Traversable オブジェクト内に、特定のキーが存在するかどうかを確認します。
11     *
12     * @param Traversable $traversable 検索対象のイテレータブルなオブジェクト
13     * @param string|int $targetKey 検索するキー
14     * @return void
15     */
16    public static function check(Traversable $traversable, string|int $targetKey): void
17    {
18        // Traversable オブジェクトをラップする IteratorIterator インスタンスを作成します。
19        // これにより、様々な種類のイテレータを同じインターフェースで操作できます。
20        $iterator = new IteratorIterator($traversable);
21
22        echo "探索するキー: '{$targetKey}'" . PHP_EOL . PHP_EOL;
23
24        $keyFound = false;
25
26        // イテレータを先頭に戻します。
27        $iterator->rewind();
28
29        // valid() でイテレータが有効な位置を指している間、ループを続けます。
30        while ($iterator->valid()) {
31            // key() メソッドで現在の要素のキーを取得します。
32            $currentKey = $iterator->key();
33            echo "現在のキー '{$currentKey}' を確認しています..." . PHP_EOL;
34
35            // 取得したキーが探しているキーと一致するかどうかを判定します。
36            if ($currentKey === $targetKey) {
37                $keyFound = true;
38                // current() メソッドで現在の値を取得します。
39                $currentValue = $iterator->current();
40                echo "-> 発見: キー '{$targetKey}' の値は '{$currentValue}' です。" . PHP_EOL;
41                // キーが見つかったので、ループを終了します。
42                break;
43            }
44
45            // next() でイテレータを次の要素に進めます。
46            $iterator->next();
47        }
48
49        if (!$keyFound) {
50            echo "-> 結果: キー '{$targetKey}' は見つかりませんでした。" . PHP_EOL;
51        }
52    }
53}
54
55// データソースとして ArrayObject を作成します (ArrayObject は Traversable です)。
56$userProfile = new ArrayObject([
57    'id' => 123,
58    'name' => 'Taro Yamada',
59    'email' => 'taro.yamada@example.com'
60]);
61
62// 'name' キーが存在するかどうかを確認します。
63KeyExistenceChecker::check($userProfile, 'name');
64
65echo PHP_EOL . '--------------------' . PHP_EOL . PHP_EOL;
66
67// 'age' キー (存在しないキー) が存在するかどうかを確認します。
68KeyExistenceChecker::check($userProfile, 'age');
69

このPHPコードは、IteratorIterator::key()メソッドを使用して、繰り返し処理が可能なデータの中に特定のキーが存在するかを確認するサンプルです。ArrayObjectのような、ループで扱えるオブジェクトを例にキーの探索処理を実装しています。

IteratorIteratorクラスは、様々な形式の繰り返し可能なデータ（Traversableインターフェースを実装したオブジェクト）を、統一された方法で操作できるようにするためのものです。これにより、データの種類を意識することなく、一貫したループ処理を記述できます。

key()メソッドは、引数を取りません。イテレータが現在指している要素のキーを返す役割を持ちます。戻り値の型はmixedで、キーが文字列でも数値でも対応可能です。

サンプルコードでは、whileループ内でまずvalid()メソッドを呼び出し、処理すべき要素がまだあるかを確認します。次にkey()メソッドで現在のキーを取得し、探しているキーと比較します。キーが一致すれば、current()メソッドで対応する値を取得して結果を表示し、ループを終了します。一致しない場合はnext()メソッドで次の要素へ進み、この処理を繰り返します。このように、key()メソッドはイテレータを操作する際に現在のキーを正確に取得するために使用されます。

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * IteratorIterator を使用して、キーと値を取得し表示するサンプル関数
7 *
8 * IteratorIterator は、既存のイテレータをラップして、
9 * Iterator インターフェースの機能を提供します。
10 * while ループと組み合わせることで、イテレータの各メソッドの役割を
11 * 明確に理解することができます。
12 */
13function displayKeyValueWithIteratorIterator(): void
14{
15    // 1. イテレーションの元となる連想配列を定義します。
16    $data = [
17        'first'  => 'Apple',
18        'second' => 'Banana',
19        'third'  => 'Cherry',
20    ];
21
22    // 2. 配列をイテレータとして扱えるように ArrayIterator オブジェクトに変換します。
23    $arrayIterator = new ArrayIterator($data);
24
25    // 3. ArrayIterator を IteratorIterator でラップします。
26    //    これにより、元のイテレータの動作を変更せずに、イテレータとして操作できます。
27    $iterator = new IteratorIterator($arrayIterator);
28
29    // 4. while ループを使ってイテレータを順番に処理します。
30    //    valid() メソッドで、現在の位置に要素が存在するかを確認します。
31    while ($iterator->valid()) {
32        // key() メソッドで現在の要素のキーを取得します。
33        $key = $iterator->key();
34
35        // current() メソッドで現在の要素の値を取得します。
36        $value = $iterator->current();
37
38        // 取得したキーと値を表示します。
39        echo "Key: {$key}, Value: {$value}" . PHP_EOL;
40
41        // next() メソッドでイテレータを次の要素に進めます。
42        $iterator->next();
43    }
44}
45
46// 関数を実行して結果を表示します。
47displayKeyValueWithIteratorIterator();

このPHPサンプルコードは、IteratorIteratorクラスのkey()メソッドを使用して、繰り返し処理の中で現在の要素のキーを取得する方法を示しています。IteratorIteratorは、ArrayIteratorのような既存のイテレータオブジェクトをラップ（包み込む）して、イテレータとしての機能を提供します。

コードでは、まずキーと値を持つ連想配列をArrayIteratorに変換し、それをさらにIteratorIteratorでラップしています。whileループは、valid()メソッドで次の要素が存在するかを確認しながら処理を続けます。

ループの中で呼び出されている$iterator->key()が、今回注目するメソッドです。このメソッドは引数を取らず、イテレータが現在指している要素のキーを返します。このサンプルでは、'first', 'second', 'third' という文字列が順番に返されます。戻り値の型はmixedであり、キーのデータ型によって変わります。

key()メソッドでキーを取得し、current()メソッドで対応する値を取得することで、元の配列のキーと値のペアを一つずつ取り出すことができます。最後にnext()メソッドでイテレータを次の要素に進めることで、すべての要素を順番に処理できます。このようにkey()メソッドは、イテレータを使った繰り返し処理において、各要素のキーを特定するために重要な役割を果たします。