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

Copy
1<?php
2
3/**
4 * SplDoublyLinkedList クラスの key() メソッドの使用例を示します。
5 *
6 * key() メソッドは、現在のイテレータ位置のインデックス（整数）を返します。
7 * このインデックスが「有効なキー」として要素に対応しているかどうかを判断するには、
8 * イテレータが有効な要素を指しているか (valid() メソッド) を確認することが重要です。
9 *
10 * システムエンジニアを目指す初心者の方にも、SplDoublyLinkedList のキー（インデックス）の扱いや、
11 * その「存在」の確認方法を理解していただけるよう、具体例を用いて説明します。
12 */
13function demonstrateSplDoublyLinkedListKeyExistence(): void
14{
15    echo "--- SplDoublyLinkedList::key() メソッドとキーの存在確認のデモンストレーション ---\n\n";
16
17    // 1. 要素を持つリストの場合
18    echo "### 1. 要素を持つリストでのキーの取得と存在確認 ###\n";
19
20    $list = new SplDoublyLinkedList();
21    $list->push('りんご');  // インデックス 0
22    $list->push('バナナ');  // インデックス 1
23    $list->push('みかん');  // インデックス 2
24
25    echo "リストを巡回し、各要素のキー（インデックス）と値を確認します:\n";
26
27    // イテレータをリストの先頭に設定し直します。
28    // SplDoublyLinkedList は Iterator インターフェースを実装しており、
29    // rewind(), valid(), current(), key(), next() メソッドを使って要素を順に処理できます。
30    $list->rewind();
31
32    // valid() メソッドで、イテレータが現在有効な要素を指しているかを確認します。
33    // valid() が true の間だけ、key() や current() メソッドが有効な情報を返します。
34    while ($list->valid()) {
35        $currentKey = $list->key();       // 現在の要素のインデックスを取得 (int)
36        $currentValue = $list->current(); // 現在の要素の値を取得
37
38        // ここでは valid() が true なので、$currentKey は「存在する要素のキー」です。
39        echo "  キー: {$currentKey} (存在します), 値: {$currentValue}\n";
40
41        $list->next(); // イテレータを次の要素へ進めます。
42    }
43    echo "イテレータがリストの終端に到達しました。これ以上有効なキーはありません。\n\n";
44
45    // 2. 空のリストの場合
46    echo "### 2. 空のリストでのキーの存在確認 ###\n";
47
48    $emptyList = new SplDoublyLinkedList();
49
50    echo "空のリストのイテレータの状態を確認します:\n";
51    echo "  valid(): " . ($emptyList->valid() ? 'true (有効)' : 'false (無効)') . "\n";
52
53    // valid() が false の場合、key() メソッドが返す値 (通常は 0) は
54    // 有効な要素のインデックスではありません。
55    // key() メソッドは常に int を返しますが、その値が有効な要素に対応しているかは valid() で判断します。
56    echo "  key(): " . $emptyList->key() . " (注意: valid() が false なので、このキーは有効な要素に対応していません)\n";
57
58    // 「キーが存在するか」をプログラムで判断する際の推奨される方法:
59    if ($emptyList->valid()) {
60        echo "  結果: 有効なキー " . $emptyList->key() . " が存在します。\n";
61    } else {
62        echo "  結果: 有効なキーは存在しません。\n";
63    }
64    echo "\n";
65
66    // 3. リストに要素があるが、イテレータが終端にある場合
67    echo "### 3. 要素を持つリストで、イテレータが終端にある場合のキーの存在確認 ###\n";
68
69    $singleElementList = new SplDoublyLinkedList();
70    $singleElementList->push('単一要素'); // インデックス 0
71
72    // イテレータを先頭に設定し、次に進めて終端の状態を作ります。
73    $singleElementList->rewind(); // イテレータをインデックス0に設定
74    $singleElementList->next();   // イテレータをインデックス0の次（終端）に進める
75
76    echo "イテレータが終端にあるリストの状態を確認します:\n";
77    echo "  valid(): " . ($singleElementList->valid() ? 'true (有効)' : 'false (無効)') . "\n";
78    echo "  key(): " . $singleElementList->key() . " (注意: valid() が false なので、このキーは有効な要素に対応していません)\n";
79
80    // ここでも valid() で有効なキーの存在を判断します。
81    if ($singleElementList->valid()) {
82        echo "  結果: 有効なキー " . $singleElementList->key() . " が存在します。\n";
83    } else {
84        echo "  結果: 有効なキーは存在しません。\n";
85    }
86    echo "\n";
87}
88
89// 関数を実行します。
90demonstrateSplDoublyLinkedListKeyExistence();

PHP 8のSplDoublyLinkedListクラスに属するkey()メソッドは、引数を取らず、現在のイテレータが指している要素のインデックス（キー）を整数型（int）で返します。このメソッドはリストの要素を順に処理する際に、現在の位置を示すのに使われます。

システムエンジニアとして重要なのは、「キーの存在」を正しく判断することです。key()メソッドはイテレータの位置にかかわらず常に整数を返しますが、そのインデックスが実際にリスト内の有効な要素に対応しているかどうかは別途判断が必要です。具体的には、valid()メソッドを使用し、イテレータが現在有効な要素を指しているかを確認します。

サンプルコードでは、要素を持つリストを巡回する際にvalid()がtrueの間だけkey()が返すインデックスが有効なキーとして扱われることを示しています。一方、リストが空の場合や、イテレータがリストの終端に達した場合など、valid()がfalseの状況では、key()が整数を返しても、それは有効な要素のキーとはみなされません。そのため、有効なキーの存在を確認する際は、if ($list->valid())の条件で判断することが推奨されます。

Copy
1<?php
2
3/**
4 * SplDoublyLinkedList のキー取得 (key()) メソッドの使用例を示します。
5 *
6 * SplDoublyLinkedList は、双方向リンクリストを実装するPHPの標準クラスです。
7 * key() メソッドは、現在のイテレータのポインタが指す要素のキーを整数で返します。
8 * リストに要素を追加すると、自動的に0から始まるキーが割り当てられます。
9 */
10function demonstrateSplDoublyLinkedListKey(): void
11{
12    // SplDoublyLinkedList のインスタンスを作成
13    $list = new SplDoublyLinkedList();
14
15    // リストに要素を追加します。
16    // push() はリストの末尾に要素を追加します。
17    // このとき、内部的に0から始まるキーが割り当てられます。
18    $list->push('最初の要素'); // キー: 0
19    $list->push('次の要素');   // キー: 1
20    $list->push('最後の要素'); // キー: 2
21
22    echo "--- リストの要素を順に走査し、キーと値を表示 ---\n";
23
24    // リストのポインタを先頭にリセットします。
25    // key() メソッドは現在のポインタの位置のキーを返すため、
26    // 走査を開始する前に rewind() を呼び出すのが一般的です。
27    $list->rewind();
28
29    // valid() でポインタが有効な位置にあるか確認し、
30    // next() で次の要素に移動しながらリストを走査します。
31    while ($list->valid()) {
32        // key() メソッドで現在の要素のキーを取得します。
33        $currentKey = $list->key();
34        // current() メソッドで現在の要素の値を取得します。
35        $currentValue = $list->current();
36
37        echo "キー: {$currentKey}, 値: {$currentValue}\n";
38
39        // ポインタを次の要素に進めます。
40        $list->next();
41    }
42
43    echo "\n--- 特定の位置にポインタを移動後のキーの表示 ---\n";
44
45    // ポインタを再度先頭にリセット
46    $list->rewind();
47    // ポインタを1つ進める (キー 1 の位置)
48    $list->next();
49
50    // 現在のポインタが指すキーと値を表示
51    echo "ポインタ移動後の現在のキー: " . $list->key() . "\n";
52    echo "ポインタ移動後の現在の値: " . $list->current() . "\n";
53}
54
55// 関数を実行して、SplDoublyLinkedList::key() の動作を確認します。
56demonstrateSplDoublyLinkedListKey();

PHP 8のSplDoublyLinkedList::key()メソッドは、PHPの標準クラスであるSplDoublyLinkedListが提供する、リスト内の要素のキーを取得するための機能です。SplDoublyLinkedListは、データの追加や削除を効率的に行える「双方向リンクリスト」というデータ構造を実装しており、リストに要素を追加すると、自動的に0から始まる整数が「キー」として割り振られます。

key()メソッドは、現在リスト内で注目している（イテレータのポインタが指している）要素のキーを整数で返します。このメソッドに引数はなく、戻り値はint型となります。

サンプルコードでは、SplDoublyLinkedListに複数の要素をpush()で追加しています。この際、「最初の要素」にはキー0、「次の要素」にはキー1、といった形でキーが自動的に割り当てられます。

リストの要素を順に走査し、それぞれのキーと値を確認する際には、まずrewind()メソッドでポインタをリストの先頭に戻します。その後、while ($list->valid())ループを使って、key()メソッドで現在の要素のキーを取得し、current()メソッドでその値を取得します。ループの各ステップでnext()メソッドを呼び出すことで、ポインタを次の要素に進め、リスト全体を処理します。

また、ポインタを任意の場所に移動させた後でも、key()メソッドは常にその時点のポインタが指す要素のキーを正確に返します。このように、SplDoublyLinkedList::key()は、リスト内の要素の位置情報を確認する際に非常に有用なメソッドです。