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

『offsetSetメソッドは、ArrayIteratorオブジェクトが内部で保持する配列の、指定したオフセット（キー）に値を設定するために実行するメソッドです。ArrayIteratorは、配列をオブジェクトとして扱い、foreachループなどで反復処理できるようにするためのクラスです。このoffsetSetメソッドは、PHPのArrayAccessインターフェースを実装するために定義されており、ArrayIteratorオブジェクトを通常の配列と同じように角括弧 [] を使って要素に値を代入できるようにします。例えば、$iterator['key'] = 'value'; というコードを実行すると、内部的にこのoffsetSetメソッドが呼び出されます。第一引数には値を設定するキーを指定し、第二引数には設定したい値を渡します。指定したキーが配列内に既に存在する場合はその値が上書きされ、存在しない場合は新しい要素として追加されます。また、$iterator[] = 'value'; のようにキーを省略して代入すると、配列の末尾に新しい要素が追加されます。このメソッド自体は値を返しません（戻り値の型はvoidです）。これにより、オブジェクトを介して、ラップしている配列のデータを直感的に変更できます。

Copy
1<?php
2
3$array = ['a' => 'Apple', 'b' => 'Banana'];
4$iterator = new ArrayIterator($array);
5
6// 既存のオフセット 'b' の値を 'Blueberry' に設定します。
7// これは内部的に offsetSet('b', 'Blueberry') を呼び出します。
8$iterator['b'] = 'Blueberry';
9
10// 新しいオフセット 'c' に値 'Cherry' を設定します。
11// これは内部的に offsetSet('c', 'Cherry') を呼び出します。
12$iterator['c'] = 'Cherry';
13
14var_dump(iterator_to_array($iterator));
15
16?>

mixed $offset, mixed $value

• mixed $offset: 格納する要素のキーを指定します。
• mixed $value: 格納する要素の値を指定します。

戻り値なし

戻り値はありません