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

Copy
1<?php
2
3/**
4 * SeekableIterator インターフェースを実装する ArrayIterator を使用して、
5 * 現在の要素のキーを取得する key() メソッドの利用例を示します。
6 *
7 * ArrayIterator は、PHPの組み込みクラスで、配列を繰り返し処理（イテレート）
8 * するための機能（イテレータ）を提供します。SeekableIterator インターフェースを
9 * 実装しているため、key() メソッドを利用できます。
10 */
11
12// サンプルデータとして、動物の名前とその数を保持する連想配列を準備します。
13$animals = [
14    'Lion'    => 5,
15    'Tiger'   => 3,
16    'Elephant' => 2,
17    'Giraffe' => 4,
18];
19
20// ArrayIterator のインスタンスを作成し、配列を渡します。
21// これにより、$animals 配列がイテレータとして扱えるようになります。
22$iterator = new ArrayIterator($animals);
23
24echo "動物リストのキーと値をイテレートします:\n";
25echo "---------------------------------\n";
26
27// イテレータのポインタを先頭に巻き戻します。
28// これにより、常に最初の要素からイテレーションを開始できます。
29$iterator->rewind();
30
31// イテレータが有効な要素を指している間（つまり、まだ処理すべき要素がある間）ループを続けます。
32while ($iterator->valid()) {
33    // key() メソッドを使って、現在の要素のキー（ここでは動物の名前）を取得します。
34    // 戻り値は mixed 型ですが、この例では文字列のキーを返します。
35    $currentKey = $iterator->key();
36
37    // current() メソッドを使って、現在の要素の値（ここでは動物の数）を取得します。
38    $currentValue = $iterator->current();
39
40    echo "キー: " . $currentKey . ", 値: " . $currentValue . "匹\n";
41
42    // next() メソッドを呼び出して、イテレータのポインタを次の要素に進めます。
43    $iterator->next();
44}
45
46echo "---------------------------------\n";
47echo "イテレーションが完了しました。\n";
48
49?>

このPHPサンプルコードは、SeekableIteratorインターフェースを実装するArrayIteratorクラスを用いて、現在の要素のキーを取得するkey()メソッドの利用方法を示しています。SeekableIteratorは、PHPのイテレータ機能の一つで、イテレータのポインタを任意の場所に移動できるといった「検索可能」な特性を持つインターフェースです。ArrayIteratorは、配列を繰り返し処理する際にこのインターフェースを実装しており、配列の各要素にアクセスする際にkey()メソッドを使用できます。

コードでは、まず動物の名前とその数を保持する連想配列$animalsを用意し、これをArrayIteratorのインスタンス$iteratorに渡しています。whileループの中で$iterator->valid()を使ってイテレータが有効な要素を指している間、繰り返し処理を行います。

ループの各ステップで$iterator->key()メソッドを呼び出すことで、現在イテレータが指している要素のキー（この例では「Lion」や「Tiger」といった動物の名前）を取得しています。このメソッドは引数を取りません。戻り値はmixed型であり、キーの種類に応じて整数や文字列など様々な型の値が返される可能性がありますが、この例では文字列のキーが返されています。取得したキーと、current()メソッドで取得した値を使って、リストの情報を表示し、next()メソッドで次の要素へ進んでいます。

Copy
1<?php
2
3/**
4 * SeekableIterator::key() メソッドの使用例を示します。
5 * ArrayIterator は SeekableIterator インターフェースを実装しており、
6 * イテレータの現在位置のキーを取得するために key() メソッドを利用できます。
7 */
8function demonstrateSeekableIteratorKey(): void
9{
10    // キーと値を持つサンプル配列を準備します。
11    // 連想配列のキーは文字列、値は数値です。
12    $data = [
13        'apple'  => 100,
14        'banana' => 150,
15        'orange' => 120,
16        'grape'  => 200,
17    ];
18
19    // ArrayIterator を使用して、この配列をイテレータとして扱います。
20    // ArrayIterator は PHP の標準ライブラリ(SPL)の一部で、
21    // SeekableIterator インターフェースを実装しています。
22    $iterator = new ArrayIterator($data);
23
24    echo "イテレータを介して各要素のキーと値を取得します:\n";
25
26    // イテレータの現在位置が有効である間、ループを続けます。
27    // 最初は最初の要素 ('apple') を指しています。
28    while ($iterator->valid()) {
29        // SeekableIterator::key() メソッドを呼び出して、
30        // 現在の要素のキーを取得します。
31        $key = $iterator->key();
32
33        // SeekableIterator::current() メソッドを呼び出して、
34        // 現在の要素の値を取得します。
35        $value = $iterator->current();
36
37        // 取得したキーと値を出力します。
38        echo "  キー: '" . $key . "', 値: " . $value . "\n";
39
40        // SeekableIterator::next() メソッドを呼び出して、
41        // イテレータを次の要素へ進めます。
42        $iterator->next();
43    }
44
45    echo "\nイテレーションが完了しました。\n";
46}
47
48// 上で定義した関数を実行して、SeekableIterator::key() の動作を確認します。
49demonstrateSeekableIteratorKey();

SeekableIterator::key()メソッドは、PHPのイテレータが現在指している要素のキーを取得するために使用されます。このメソッドは引数を取らずに呼び出され、現在の要素のキーをmixed型で返します。イテレータが有効な要素を指していない場合など、キーが存在しない場合はnullが返されることがあります。

提供されたサンプルコードでは、連想配列をArrayIteratorクラスでラップしてイテレータとして扱っています。ArrayIteratorはSeekableIteratorインターフェースを実装しているため、key()メソッドを利用できます。まず、キーと値のペアを持つ配列$dataが準備され、それを元にArrayIteratorインスタンス$iteratorが作成されます。

while ($iterator->valid())ループは、イテレータが有効な要素を指している間、繰り返し処理を実行します。ループ内で$iterator->key()を呼び出すことで、現在指している要素（例えば最初の要素であれば'apple'）のキーが取得されます。同時に$iterator->current()で値も取得し、これらを出力しています。その後、$iterator->next()によってイテレータは次の要素へと進み、すべての要素が処理されるまでこの操作が繰り返されます。このように、key()メソッドはイテレータ処理中に各要素の識別子であるキーを簡単に取得する役割を果たします。