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

offsetSetメソッドは、RecursiveCachingIteratorオブジェクトに対して配列構文で値を設定しようとする際に呼び出されるメソッドです。このメソッドは、PHPに標準で組み込まれているArrayAccessインターフェースの要件を満たすために実装されています。ArrayAccessインターフェースを実装したオブジェクトは、$object[$offset] = $value のように、配列と同じ形式で要素の代入操作が可能になります。

しかし、RecursiveCachingIteratorクラスは、元となるイテレータのデータを読み取り専用でキャッシュし、効率的に走査することを目的としています。そのため、イテレーション中に元のデータコレクションが変更されることを許可していません。データの一貫性を保つという設計上の理由から、このクラスのインスタンスに対して要素を設定しようとすると、常にBadMethodCallExceptionという例外がスローされます。したがって、このメソッドはArrayAccessインターフェースの仕様を満たすために形式的に存在しますが、実際にはオブジェクトの値を変更する機能は提供しておらず、呼び出すと必ずエラーとなる点に注意が必要です。

Copy
1<?php
2
3$arrayIterator = new ArrayIterator(['a', 'b', 'c']);
4$iterator = new RecursiveCachingIterator($arrayIterator);
5
6// 指定したオフセットに値を設定します。
7// これは内部的に offsetSet() を呼び出します。
8$iterator[0] = 'new_value';
9

mixed $offset, mixed $value

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

void

offsetSetメソッドは、指定されたオフセットに要素を設定するために使用されます。このメソッドは値を返しません。