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

Copy
1<?php
2
3/**
4 * SplQueue の基本的な操作と key() メソッドの使用例を示します。
5 *
6 * SplQueue はPHPの標準ライブラリ(SPL)で提供されるキューの実装で、
7 * 要素を先入れ先出し(FIFO)の順序で管理します。
8 * key() メソッドは、イテレータが指す現在の要素のインデックス(キー)を整数で返します。
9 *
10 * キーワード "php key exists" に関連して、SplQueue のイテレータは
11 * valid() メソッドで現在のキー位置に要素が存在するかどうかを確認できます。
12 *
13 * @return void
14 */
15function demonstrateSplQueueKeyUsage(): void
16{
17    // SplQueue の新しいインスタンスを作成します。
18    $queue = new SplQueue();
19
20    // キューにいくつかの要素を追加します (enqueue)。
21    echo "--- キューに要素を追加します ---\n";
22    $queue->enqueue("First data element");  // インデックス 0 に格納
23    $queue->enqueue("Second data element"); // インデックス 1 に格納
24    $queue->enqueue("Third data element");  // インデックス 2 に格納
25    echo "現在のキューの要素数: " . $queue->count() . "\n\n";
26
27    echo "--- キューの要素をインデックス (キー) と共に反復処理します ---\n";
28
29    // イテレータをキューの先頭に巻き戻します。
30    // これにより、key() メソッドは最初の要素のキー (0) を指すようになります。
31    $queue->rewind();
32
33    // キューの要素を順に処理します。
34    // valid() メソッドは、現在のイテレータの位置に要素が存在するかどうか
35    // (つまり、キーが有効であるか) を確認します。
36    while ($queue->valid()) {
37        // key() メソッドは、現在の要素のインデックス (キー) を整数で返します。
38        // 例えば、最初の要素の場合は 0、次の要素の場合は 1 となります。
39        $currentKey = $queue->key();
40
41        // current() メソッドは、現在の要素の値を取得します。
42        $currentValue = $queue->current();
43
44        echo "現在の要素: キー = " . $currentKey . ", 値 = '" . $currentValue . "'\n";
45
46        // イテレータを次の要素に進めます。
47        $queue->next();
48    }
49    echo "\n";
50
51    echo "--- キューから要素を取り出します (dequeue) ---\n";
52    // キューが空になるまで要素を先入れ先出し (FIFO) の順序で取り出します。
53    while (!$queue->isEmpty()) {
54        echo "取り出した要素: '" . $queue->dequeue() . "'\n";
55    }
56    echo "キューは現在空です。要素数: " . $queue->count() . "\n";
57}
58
59// 上記で定義した関数を実行して、SplQueue の動作と key() メソッドの使用方法を確認します。
60demonstrateSplQueueKeyUsage();
61
62?>

このサンプルコードは、PHPの標準ライブラリ（SPL）が提供するSplQueueクラスにおけるkey()メソッドの利用例を示します。SplQueueは、要素を先入れ先出し（FIFO）の順序で管理するキューというデータ構造を実装しています。

key()メソッドは、イテレータが現在指す要素のインデックス（キー）を整数で返します。引数は必要ありません。

まず、SplQueueに複数の要素をenqueue()メソッドで追加します。次にrewind()メソッドでイテレータをキューの先頭に設定し、要素を最初から順に処理できるように準備します。while ($queue->valid()) のループでは、valid()メソッドが現在のイテレータ位置に要素が存在するかどうかを確認します。キーワード「php key exists」に関連して、valid()メソッドは現在のキー位置に要素があるかの判断に用いられます。

ループ内では、key()メソッドで現在の要素のインデックス番号を取得し、current()メソッドでその要素の値を取り出します。最初の要素のインデックスは0から始まり、next()メソッドでイテレータを次の要素へと進めます。最後に、キューから要素をdequeue()メソッドで順に取り出す様子が示されています。このようにSplQueueとkey()メソッドを組み合わせることで、キュー内の要素をインデックスと共に効率的に操作できることがわかります。

Copy
1<?php
2
3// SplQueue クラスを利用してキューを操作するサンプルコードです。
4// SplQueue::key() メソッドは、現在のイテレータ位置にある要素のインデックス（キー）を返します。
5// これは、キューの先頭から数えた0から始まる数値です。
6
7function demonstrateSplQueueKey(): void
8{
9    // SplQueue オブジェクトを作成します。
10    $queue = new SplQueue();
11
12    echo "--- SplQueue への要素追加とキーの確認 ---\n";
13
14    // キューに要素を追加します (enqueue)。
15    $queue->enqueue("最初のデータ");  // この要素のインデックスは 0 になります。
16    $queue->enqueue("二番目のデータ"); // この要素のインデックスは 1 になります。
17    $queue->enqueue("三番目のデータ"); // この要素のインデックスは 2 になります。
18
19    echo "キューの初期要素数: " . $queue->count() . "\n\n";
20
21    // キューをイテレートし、各要素とそのキー（インデックス）を表示します。
22    // SplQueue は SplDoublyLinkedList を継承しており、イテレータとして機能します。
23    // rewind() はイテレータをキューの先頭に巻き戻します。
24    $queue->rewind();
25    echo "初期状態のキューの要素とキー:\n";
26    while ($queue->valid()) {
27        // key() メソッドで現在の要素のインデックス（キー）を取得します。
28        $currentKey = $queue->key();
29        // current() メソッドで現在の要素の値を取得します。
30        $currentValue = $queue->current();
31
32        echo "  キー: " . $currentKey . ", 値: '" . $currentValue . "'\n";
33
34        // next() メソッドでイテレータを次の要素に進めます。
35        $queue->next();
36    }
37    echo "\n";
38
39    echo "--- キューからの要素取り出し（dequeue）後のキーの振る舞い ---\n";
40
41    // キューから要素を1つ取り出します (dequeue)。
42    // キューは FIFO (先入れ先出し) なので、最初に追加した要素が取り出されます。
43    $dequeuedItem = $queue->dequeue();
44    echo "取り出された要素: '" . $dequeuedItem . "'\n\n"; // "最初のデータ" が取り出されます。
45
46    echo "dequeue後のキューの要素数: " . $queue->count() . "\n\n";
47
48    // 再度イテレートして、残りの要素とそのキーを確認します。
49    // dequeue により要素が詰められ、残った要素のキーが再割り当てされることに注目してください。
50    // 例: "二番目のデータ" のキーは 1 から 0 に、"三番目のデータ" のキーは 2 から 1 に変わります。
51    $queue->rewind();
52    echo "dequeue後のキューの要素とキー:\n";
53    while ($queue->valid()) {
54        $currentKey = $queue->key();
55        $currentValue = $queue->current();
56        echo "  キー: " . $currentKey . ", 値: '" . $currentValue . "'\n";
57        $queue->next();
58    }
59    echo "\n";
60
61    // さらに新しい要素を追加して、キーの継続性を確認することもできます。
62    $queue->enqueue("追加のデータ"); // この要素は現在の最後の要素の次のインデックスに配置されます。
63    echo "追加データ後のキューの要素とキー:\n";
64    $queue->rewind();
65    while ($queue->valid()) {
66        $currentKey = $queue->key();
67        $currentValue = $queue->current();
68        echo "  キー: " . $currentKey . ", 値: '" . $currentValue . "'\n";
69        $queue->next();
70    }
71    echo "\n";
72}
73
74// サンプル関数の実行
75demonstrateSplQueueKey();

このPHPサンプルコードは、SplQueueクラスとそのkey()メソッドの使い方をシステムエンジニアを目指す初心者向けに解説しています。SplQueueは、データを「先入れ先出し（FIFO）」の原則で管理するキュー（待ち行列）データ構造を提供するPHPの標準的なクラスです。

SplQueue::key()メソッドは、引数を取らずに、キューをイテレート（巡回）している現在の要素のインデックス（キー）を整数型（int）で返します。このインデックスはキューの先頭から0, 1, 2...と順に割り当てられます。

コードではまず、SplQueueオブジェクトを作成し、複数の要素をenqueue()メソッドでキューに追加しています。その後、rewind()でイテレータを先頭に戻し、while ($queue->valid())とnext()を使って各要素を順番に処理しながら、key()メソッドで取得した現在のインデックスとcurrent()メソッドで取得した要素の値を表示しています。これにより、要素が追加された順に0, 1, 2といったキーが割り当てられていることがわかります。

次に、dequeue()メソッドでキューから要素を一つ取り出します。キューはFIFOのため、一番最初に追加された要素が取り出されます。この後、残った要素を再度イテレートすると、取り出された要素によって空いた位置が詰められ、残りの要素のインデックスが自動的に再割り当てされる様子が確認できます。例えば、「二番目のデータ」のキーが1から0に、「三番目のデータ」のキーが2から1に変わるのがその例です。最後に新しい要素を追加した場合も、既存の要素の次のインデックスが割り当てられます。

このように、SplQueue::key()はキュー内の要素の現在の位置を数値インデックスとして正確に把握するために利用され、キューの内容の動的な変化に合わせてキーが再調整される特性を理解する上で重要なメソッドです。