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

『offsetGetメソッドは、ArrayIteratorオブジェクトから指定したオフセット（キー）に対応する値を取得する処理を実行するメソッドです。このメソッドは、PHPの標準インターフェースであるArrayAccessの一部として定義されており、ArrayIteratorクラスはこれを実装しています。ArrayAccessを実装したクラスのオブジェクトは、通常の配列のように角括弧 [] を使って要素の値にアクセスすることが可能になります。具体的には、ArrayIteratorのインスタンスに対して $iterator['some_key'] のような構文で値の取得を試みると、PHPの内部で自動的にこのoffsetGetメソッドが呼び出され、引数として指定されたオフセット（この例では 'some_key'）が渡されます。メソッドは、そのオフセットに対応する値を戻り値として返します。もし指定されたオフセットが存在しない場合、PHPの配列で未定義のキーにアクセスした際と同様に警告が発生し、nullが返ります。この仕組みにより、イテレータオブジェクトを配列とほぼ同じ感覚で直感的に扱うことができます。

Copy
1<?php
2// PHPの配列を用意します
3$array = ['a' => 'Apple', 'b' => 'Banana', 'c' => 'Cherry'];
4
5// 配列を元にArrayIteratorオブジェクトを生成します
6$iterator = new ArrayIterator($array);
7
8// offsetGet()メソッドを使い、指定したキー（オフセット）'b'に対応する値を取得します
9$value = $iterator->offsetGet('b');
10
11// 取得した値を出力します
12// 出力結果: string(6) "Banana"
13var_dump($value);

mixed $offset

• mixed $offset: 取得したい配列のキーまたはオフセットを指定します

mixed

指定されたキーに紐づく値、またはキーが存在しない場合は null を返します。