【PHP8.x】offsetExistsメソッドの使い方

『offsetExistsメソッドは、CachingIteratorオブジェクトの指定したオフセット（インデックス）に要素が存在するかどうかをチェックするメソッドです。このメソッドは、PHPのArrayAccessインターフェースを実装することによって提供される機能の一つであり、イテレータオブジェクトを配列のように角括弧 [] を使ってアクセスできるようにします。具体的には、isset($iterator[$offset]) という構文が使われた際に、内部的にこのoffsetExistsメソッドが呼び出されます。引数には、存在を確認したい要素のオフセットを指定します。メソッドの実行後、指定したオフセットに有効な要素が存在する場合は true を、存在しない場合は false を返します。CachingIteratorは前方へのみ進む特性を持つため、まだ読み込んでいない未来のオフセットの存在をチェックすると、イテレータは内部的にその位置まで進み、そこまでの要素をキャッシュします。このメソッドを利用することで、配列の要素の存在確認と同様の処理を、イテレータに対しても安全かつ直感的に行うことが可能になります。

Copy
1<?php
2
3// public CachingIterator::offsetExists(mixed $offset): bool
4$iterator = new CachingIterator(new ArrayIterator(['apple', 'banana']));
5
6var_dump($iterator->offsetExists(0));  // true
7var_dump($iterator->offsetExists(2));  // false
8
9?>

string|int $offset

• string|int $offset: 存在を確認したい配列のキーまたはインデックスを指定する文字列または整数

bool

指定したオフセットに要素が存在するかどうかを示す真偽値を返します。存在する場合はtrue、存在しない場合はfalseを返します。