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

offsetExistsメソッドは、SplDoublyLinkedListクラスに属し、リスト内の特定のオフセット（位置）に要素が存在するかどうかを確認するために使用されるメソッドです。SplDoublyLinkedListは、要素を両方向から効率的に追加・削除できる「双方向連結リスト」というデータ構造を提供するPHPの標準的なクラスです。このクラスは、配列のように要素にアクセスできる機能（ArrayAccessインターフェース）を実装しており、その一部としてoffsetExistsメソッドが提供されています。

このメソッドは、引数として指定された整数値のオフセットが、SplDoublyLinkedList内に有効な位置として存在し、かつその位置に要素が格納されているかを判定します。例えば、リストの5番目の位置に要素が存在するかどうかを確認したい場合に利用できます。指定されたオフセットがリストの有効な範囲内であり、実際に要素が格納されている場合はtrueを返します。一方、オフセットがリストの範囲外である場合や、指定された位置に要素が格納されていない場合はfalseを返します。

offsetExistsメソッドを使用することで、プログラマはリストの要素にアクセスする前に、その要素が本当に存在するかどうかを安全に確認できます。これにより、存在しないオフセットにアクセスしようとした際に発生するエラーを防ぎ、プログラムの安定性を向上させることが可能です。PHPの通常の配列でisset()関数を使って要素の存在をチェックするのと同様の目的で使用されます。

Copy
1<?php
2$list = new SplDoublyLinkedList();
3$list->push('item A');
4
5$exists = $list->offsetExists(0);
6?>

mixed $index

• mixed $index: 存在を確認したい要素のインデックス番号

bool

指定されたキー（インデックス）に要素が存在するかどうかを真偽値（trueまたはfalse）で返します。