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

『offsetExistsメソッドは、RecursiveArrayIteratorオブジェクトが現在指している配列の要素に、指定したキー（オフセット）が存在するかどうかを確認するために使用されるメソッドです。このメソッドは、PHPのArrayAccessインターフェースの一部として実装されています。これにより、RecursiveArrayIteratorのインスタンスを、通常の配列と同じように角括弧 [] を用いてアクセスすることが可能になります。具体的には、isset($iterator['key']) や empty($iterator['key']) のような構文が使われた際に、PHPの内部でこのoffsetExistsメソッドが自動的に呼び出されます。引数として渡されたキーが、イテレータ内部の現在の配列内に存在すればtrueを返し、存在しない場合はfalseを返します。この機能により、プログラマは多次元配列を安全に操作する中で、特定のキーの存在を効率的に、かつ直感的なコードで確認でき、未定義のキーへのアクセスによるエラーを未然に防ぐことができます。』

Copy
1<?php
2
3$data = [
4    'fruit' => 'apple',
5    'vegetable' => 'carrot'
6];
7
8$iterator = new RecursiveArrayIterator($data);
9
10// 指定したオフセット（キー）が存在するかどうかを bool 値で返します。
11// 構文: public RecursiveArrayIterator::offsetExists(mixed $key): bool
12
13// 'fruit' キーが存在するため true を出力します
14var_dump($iterator->offsetExists('fruit'));
15
16// 'drink' キーは存在しないため false を出力します
17var_dump($iterator->offsetExists('drink'));
18
19?>

mixed $offset

• mixed $offset: 配列内のキーまたはインデックスを指定します

bool

指定されたキーが存在するかどうかを示す真偽値（TRUE または FALSE）を返します。