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

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * LimitIterator::key() の使用例を示します。
7 *
8 * この関数は、指定した範囲の要素を反復処理し、
9 * 各要素のキーが存在することを確認して出力します。
10 */
11function demonstrateLimitIteratorKeyExists(): void
12{
13    // サンプルデータとなる連想配列
14    $data = [
15        'user_id'    => 101,
16        'user_name'  => 'Alice',
17        'email'      => 'alice@example.com',
18        'role'       => 'admin',
19        'last_login' => '2023-10-27',
20    ];
21
22    // 配列を反復処理するための ArrayIterator を作成します
23    $arrayIterator = new ArrayIterator($data);
24
25    // ArrayIterator の一部分（2番目の要素から3つ分）だけを
26    // 反復処理する LimitIterator を作成します
27    // offset: 1 (0から数えて2番目), count: 3
28    $limitIterator = new LimitIterator($arrayIterator, 1, 3);
29
30    echo "指定範囲内のキーと値:" . PHP_EOL;
31
32    // LimitIterator を使ってループ処理を行います
33    foreach ($limitIterator as $value) {
34        // LimitIterator::key() を使って、現在の要素のキーを取得します
35        // このキーは、元の配列に存在していたキーです
36        $key = $limitIterator->key();
37
38        // 取得したキーと値を出力します
39        echo "キー '{$key}' が存在します。値: {$value}" . PHP_EOL;
40    }
41}
42
43// 関数を実行して結果を表示します
44demonstrateLimitIteratorKeyExists();
45
46?>

LimitIterator::key()メソッドは、LimitIteratorオブジェクトが反復処理中に現在指し示している要素のキーを取得します。LimitIteratorは、既存のイテレータ（配列などを順番に処理するためのオブジェクト）から、指定した一部分だけを切り出してループ処理する際に便利なクラスです。

このサンプルコードでは、連想配列からArrayIteratorを作成し、さらにそのArrayIteratorに対してLimitIteratorを適用しています。new LimitIterator($arrayIterator, 1, 3)によって、元の配列の2番目の要素（オフセットが1）から3つ分の要素が処理対象となります。

foreachループ内で$limitIterator->key()を呼び出すと、現在処理している値（例: 'Alice'）に対応する、元の連想配列のキー（例: 'user_name'）が返されます。このメソッドは引数を取らず、戻り値として現在のキーを返します。キーは文字列や数値など様々な可能性があるため、戻り値の型はmixed型となります。

このようにkey()メソッドを使うことで、データの特定範囲を反復処理しながら、各要素が元のデータで持っていたキー情報を正確に取得し、値とキーのペアを維持したまま処理を進めることができます。

Copy
1<?php
2
3/**
4 * LimitIterator::key() を使用して、
5 * イテレータの指定した範囲内の現在のキーを取得するサンプルコード
6 */
7function displayLimitedKeyValue(): void
8{
9    // サンプルとなる連想配列データ
10    $data = [
11        'a' => 'Apple',
12        'b' => 'Banana',
13        'c' => 'Cherry',
14        'd' => 'Durian',
15        'e' => 'Elderberry',
16    ];
17
18    // 配列を反復処理するための ArrayIterator オブジェクトを作成
19    $arrayIterator = new ArrayIterator($data);
20
21    // ArrayIterator の一部分（オフセット1から3要素分）を切り出す LimitIterator を作成
22    // オフセット1は 'b' => 'Banana' から開始
23    $limitIterator = new LimitIterator($arrayIterator, 1, 3);
24
25    echo "指定範囲内のキーと値のペア:\n";
26
27    // LimitIterator をループ処理
28    foreach ($limitIterator as $value) {
29        // key() メソッドで現在の要素の「キー」を取得
30        $key = $limitIterator->key();
31
32        // 取得したキーと値を出力
33        // $value は $limitIterator->current() と同じ値
34        printf("Key: %s, Value: %s\n", $key, $value);
35    }
36}
37
38// 関数を実行
39displayLimitedKeyValue();
40
41/*
42実行結果:
43指定範囲内のキーと値のペア:
44Key: b, Value: Banana
45Key: c, Value: Cherry
46Key: d, Value: Durian
47*/

LimitIterator::key()メソッドは、イテレータが現在指している要素のキーを取得するために使用されます。このメソッドに引数はありません。戻り値は現在の要素のキーであり、キーのデータ型は元の配列に依存するためmixed型となります。

サンプルコードでは、まず連想配列からArrayIteratorオブジェクトを作成し、配列の要素を一つずつ辿れるようにしています。次に、LimitIteratorを使い、このArrayIteratorから特定の部分を切り出しています。具体的には、オフセット1（2番目の要素である 'b' => 'Banana'）から3つの要素分を処理対象としています。

foreachループでこのLimitIteratorを処理する際、ループ内で$limitIterator->key()を呼び出すことで、現在処理中の要素のキー（'b', 'c', 'd'の順）が取得できます。同時に、変数$valueには対応する値（'Banana', 'Cherry', 'Durian'）が格納されます。

この結果、printf関数によって指定した範囲内のキーと値のペアが正しく出力されます。このようにkey()メソッドは、LimitIteratorで絞り込んだデータ範囲の中から、現在のキーを特定する際に役立ちます。