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

Copy
1<?php
2
3/**
4 * SplDoublyLinkedList::offsetExists メソッドの使用例
5 *
6 * このスクリプトは、SplDoublyLinkedList が指定されたオフセット（インデックス）に
7 * 要素を持っているかどうかを確認する方法を示します。
8 * システムエンジニアを目指す初心者向けに、リストへの要素の追加と、
9 * その後のインデックスの存在チェックを具体的に示します。
10 */
11
12// SplDoublyLinkedList の新しいインスタンスを作成します。
13$list = new SplDoublyLinkedList();
14
15// リストにいくつかの要素を追加します。
16$list->push('Apple');
17$list->push('Banana');
18$list->push('Cherry');
19
20echo "現在のリストの要素数: " . $list->count() . "\n\n";
21
22// 存在するインデックスのチェック
23echo "--- 存在するインデックスのチェック ---\n";
24
25// インデックス0（最初の要素）が存在するか確認します。
26// 'Apple' が存在するため、true を返します。
27echo "リストにインデックス 0 が存在するか？: ";
28var_dump($list->offsetExists(0));
29
30// インデックス1（2番目の要素）が存在するか確認します。
31// 'Banana' が存在するため、true を返します。
32echo "リストにインデックス 1 が存在するか？: ";
33var_dump($list->offsetExists(1));
34
35// インデックス2（3番目の要素）が存在するか確認します。
36// 'Cherry' が存在するため、true を返します。
37echo "リストにインデックス 2 が存在するか？: ";
38var_dump($list->offsetExists(2));
39
40echo "\n--- 存在しないインデックスのチェック ---\n";
41
42// 存在しないインデックスのチェック
43// リストには3つの要素があるため、インデックス3は存在しません。
44// したがって、false を返します。
45echo "リストにインデックス 3 が存在するか？: ";
46var_dump($list->offsetExists(3));
47
48// 負のインデックスは SplDoublyLinkedList では無効なため、
49// 常に false を返します。
50echo "リストにインデックス -1 が存在するか？: ";
51var_dump($list->offsetExists(-1));
52
53// 整数以外の値（文字列など）をインデックスとして渡した場合、
54// 有効なインデックスではないため、false を返します。
55echo "リストにインデックス 'foo' が存在するか？: ";
56var_dump($list->offsetExists('foo'));
57
58?>

SplDoublyLinkedList::offsetExistsメソッドは、PHPの双方向連結リストであるSplDoublyLinkedListが、指定された位置（オフセットまたはインデックス）に要素を保持しているかどうかを確認するために使用されます。

引数$indexには、存在を確認したいリスト上の位置を渡します。この$indexは通常、0から始まる整数値です。戻り値はbool型で、指定されたインデックスに要素が存在すればtrue（真）を、存在しなければfalse（偽）を返します。

サンプルコードでは、まずリストにいくつかの要素を追加しています。リストに「Apple」「Banana」「Cherry」が追加されると、それぞれインデックス0、1、2に格納されます。そのため、offsetExists(0)、offsetExists(1)、offsetExists(2)を実行するとtrueが返されます。

しかし、リストの範囲外であるインデックス3や、負のインデックス-1、さらには整数以外の値（例: 'foo'）を指定した場合は、要素が存在しないと判断されfalseが返されます。このメソッドは、リストから特定のデータを取り出す前に、そのデータが本当に存在するかを確認する際に役立ち、プログラムの予期せぬエラーを防ぐために重要です。