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

offsetSetメソッドは、イテレータの要素を配列アクセス構文で変更しようとした際に呼び出されるメソッドです。このメソッドは、PHPに標準で備わっているArrayAccessインターフェースを実装するために定義されています。ArrayAccessインターフェースを実装することにより、オブジェクトを配列のように角括弧（[]）を使って操作できるようになります。具体的には、$iterator[$offset] = $value; のように、特定のオフセット（インデックス）に値を代入するコードが実行されると、内部的にこのoffsetSetメソッドが呼び出されます。しかし、CachingIteratorクラスは、元のイテレータの値を変更せずにキャッシュから読み取ることを目的として設計されています。そのため、要素の変更や追加は許可されていません。このメソッドを呼び出すと、処理は実行されずに常にBadMethodCallException例外がスローされます。この仕様は、CachingIteratorがデータソースの不変性を保証するための重要な仕組みです。

Copy
1<?php
2$iterator = new CachingIterator(new ArrayIterator(['a', 'b', 'c']));
3
4// $iterator は ArrayAccess を実装しているため、配列構文でオフセットに値を設定できます。
5// ただし、CachingIterator の実装では、この操作は例外 (BadMethodCallException) をスローします。
6$iterator[0] = 'new_value';

mixed $offset, mixed $value

• mixed $offset: 設定する要素のオフセット（位置）を指定します。
• mixed $value: オフセットに設定する値です。

戻り値なし

戻り値はありません