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

Copy
1<?php
2
3/**
4 * SplDoublyLinkedList::offsetGet の使用例
5 *
6 * SplDoublyLinkedList は、両端から要素を追加・削除できる双方向連結リストです。
7 * offsetGet メソッドは、指定されたインデックスの要素を取得します。
8 * 通常、PHPの配列アクセス構文 ($list[$index]) を使用して要素にアクセスします。
9 * このサンプルでは、offsetSet を用いて要素を設定し、offsetGet で取得する流れを示します。
10 */
11function demonstrateOffsetGet(): void
12{
13    // SplDoublyLinkedList のインスタンスを作成
14    $list = new SplDoublyLinkedList();
15
16    // offsetSet (配列アクセス構文) を使って要素を追加
17    // 通常は push() や unshift() を使いますが、offsetSet の関連を示すためにこちらを使用
18    $list->offsetSet(0, 'Apple');
19    $list->offsetSet(1, 'Banana');
20    $list->offsetSet(2, 'Cherry');
21
22    echo "--- リストの内容 ---\n";
23    foreach ($list as $key => $value) {
24        echo "Index {$key}: {$value}\n";
25    }
26    echo "\n";
27
28    // offsetGet メソッドを使用して、インデックス1の要素を取得
29    $elementAtIndex1ByMethod = $list->offsetGet(1);
30    echo "offsetGet(1) で取得: " . $elementAtIndex1ByMethod . "\n";
31
32    // 配列アクセス構文を使用して、インデックス0の要素を取得
33    $elementAtIndex0ByArrayAccess = $list[0];
34    echo "配列アクセス \$list[0] で取得: " . $elementAtIndex0ByArrayAccess . "\n";
35
36    // 配列アクセス構文を使用して、インデックス2の要素を取得
37    $elementAtIndex2ByArrayAccess = $list[2];
38    echo "配列アクセス \$list[2] で取得: " . $elementAtIndex2ByArrayAccess . "\n";
39
40    echo "\nこれらの取得方法は同じ結果を返します。\n";
41
42    // 存在しないインデックスにアクセスしようとすると OutOfBoundsException がスローされます
43    // 例: try { $list->offsetGet(10); } catch (OutOfBoundsException $e) { echo $e->getMessage(); }
44}
45
46// 関数の実行
47demonstrateOffsetGet();
48
49?>

PHP 8におけるSplDoublyLinkedList::offsetGetメソッドは、SplDoublyLinkedListという両端から要素の追加・削除が可能なリスト構造のオブジェクトから、指定されたインデックスの要素を取得する際に利用されます。このメソッドはint $indexという整数型の引数を一つ取り、リスト内のその位置にある要素をmixed型で返します。mixedは、文字列、数値、オブジェクトなど、あらゆるデータ型を示すものです。

提供されたサンプルコードでは、まずSplDoublyLinkedListのインスタンスを作成し、offsetSetメソッド（PHPの配列のように$list[インデックス] = 値と書くのと同じ働きをします）を用いて、インデックス0から2にそれぞれ'Apple'、'Banana'、'Cherry'という要素を追加しています。

その後、$list->offsetGet(1)のようにメソッドを直接呼び出すことで、インデックス1に格納された'Banana'という要素を取得しています。また、$list[0]や$list[2]のように配列アクセス構文を使っても、それぞれ'Apple'や'Cherry'といった要素を取得できることが示されています。これは、offsetGetメソッドと配列アクセス構文が全く同じ機能を提供することを示しています。なお、リストに存在しないインデックスへアクセスしようとすると、OutOfBoundsExceptionが発生しますので注意が必要です。

Copy
1<?php
2
3// SplDoublyLinkedList のインスタンスを作成します。
4$list = new SplDoublyLinkedList();
5
6// リストにいくつかの要素を追加します。
7$list->push('りんご');
8$list->push('バナナ');
9$list->push('チェリー');
10$list->push('ドリアン');
11
12echo "--- リストの現在の要素 ---" . PHP_EOL;
13// リストの全要素とそのインデックスを表示します。
14foreach ($list as $index => $value) {
15    echo "インデックス {$index}: {$value}" . PHP_EOL;
16}
17echo PHP_EOL;
18
19// offsetGet メソッドを使用して、インデックス 0 の要素を取得します。
20// 引数 $index は int 型で指定します。
21$itemZero = $list->offsetGet(0);
22echo "offsetGet(0) で取得した要素: " . $itemZero . PHP_EOL; // 出力: りんご
23
24// offsetGet メソッドを使用して、インデックス 2 の要素を取得します。
25$itemTwo = $list->offsetGet(2);
26echo "offsetGet(2) で取得した要素: " . $itemTwo . PHP_EOL;   // 出力: チェリー
27
28// SplDoublyLinkedList は ArrayAccess インターフェースを実装しているため、
29// 配列のように $list[$index] 構文で要素にアクセスすることも可能です。
30// この構文は内部的に offsetGet メソッドを呼び出します。
31$itemOneArrayAccess = $list[1];
32echo "配列アクセス $list[1] で取得した要素: " . $itemOneArrayAccess . PHP_EOL; // 出力: バナナ
33
34// 存在しないインデックスにアクセスしようとすると、
35// OutOfBoundsException (具体的には OffsetOutOfRangeException) が発生します。
36// 例: $list->offsetGet(10); // この行は実行時にエラーとなります。
37

SplDoublyLinkedList::offsetGetは、PHPのSplDoublyLinkedListクラスに用意されたメソッドで、リスト内の特定のインデックスに存在する要素を取得するために使用します。

このメソッドはint $indexという引数を一つ受け取ります。この引数には、取得したい要素のインデックスを数値で指定します。例えば、リストの最初の要素を取得したい場合は0を指定し、3番目の要素を取得したい場合は2を指定します。戻り値はmixed型で、指定されたインデックスに対応する要素の値が返されます。

サンプルコードでは、$list->offsetGet(0)でリストの最初の要素「りんご」を、$list->offsetGet(2)で3番目の要素「チェリー」を取得しています。

SplDoublyLinkedListはArrayAccessインターフェースを実装しているため、$list[1]のように配列アクセス構文を使って要素を取得することも可能です。この配列アクセスは、内部的にoffsetGetメソッドを呼び出して要素を取得しています。

なお、リストに存在しないインデックスを指定して要素を取得しようとした場合、OutOfBoundsException（具体的にはOffsetOutOfRangeException）が発生しますので、アクセスするインデックスがリストの範囲内であることを確認することが重要です。