【PHP8.x】ArrayAccess::offsetSet()メソッドの使い方

offsetSetメソッドは、PHPのArrayAccessインターフェースに定義されているメソッドの一つです。このメソッドは、特定のクラスのオブジェクトを配列のように扱う際に、そのオブジェクトの要素に値を設定する操作が実行されたときに自動的に呼び出されます。

具体的には、あるクラスがArrayAccessインターフェースを実装し、そのクラスのインスタンスに対して$object['キー'] = $値;のような角括弧構文を使って値の代入が行われた場合に、offsetSetメソッドが実行されます。このメソッドを実装することで、開発者はオブジェクト内部でどのようにキーと値のペアを管理し、保存するかを自由に制御できます。

offsetSetメソッドは通常、二つの引数を取ります。一つ目の引数は、値を設定したい要素のキー（またはインデックス）を表し、二つ目の引数は、そのキーに関連付けたい新しい値を表します。このメソッドは、値を保存する処理を行うため、戻り値は持ちません（void）。

たとえば、オブジェクトが内部でプライベートな配列を持っている場合、offsetSetメソッド内でそのプライベートな配列に値を追加したり、特定の条件を満たす値のみを受け入れたりするロジックを実装できます。オフセット（キー）を指定せずに $object[] = $値; のように値を追加しようとした場合は、キーを表す引数に null が渡されます。

offsetSetメソッドは、ArrayAccessインターフェースを構成するoffsetGet（要素の取得）、offsetExists（要素の存在確認）、offsetUnset（要素の削除）といった他のメソッドと合わせて利用することで、オブジェクトを配列として振る舞わせるための重要な機能を提供します。これにより、オブジェクトの内部構造を隠蔽しつつ、外部からは配列と似た直感的な操作を可能にします。

Copy
1public function offsetSet(mixed $offset, mixed $value): void

mixed $offset, mixed $value

• mixed $offset: 配列のキーまたはインデックスを指定します。
• mixed $value: $offset に設定する値を指定します。

戻り値なし

戻り値はありません