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

Copy
1<?php
2
3/**
4 * ArrayAccess インターフェースを実装するクラスの例です。
5 * これにより、オブジェクトを配列のように扱うことができるようになります。
6 * (例: $object['key'] = 'value'; isset($object['key']);)
7 */
8class MyArrayLikeCollection implements ArrayAccess
9{
10    /**
11     * オブジェクトの内部データを保持する配列。
12     * @var array<mixed, mixed>
13     */
14    private array $data = [];
15
16    /**
17     * コンストラクタ。初期データを設定します。
18     * @param array<mixed, mixed> $initialData
19     */
20    public function __construct(array $initialData = [])
21    {
22        $this->data = $initialData;
23    }
24
25    /**
26     * offsetExists メソッドは、指定されたオフセット（キー）が存在するかどうかをチェックします。
27     *
28     * isset($object['key']) や empty($object['key']) のような操作を行う際に、
29     * PHPによって内部的に呼び出されます。
30     *
31     * @param mixed $offset チェックするキー
32     * @return bool キーが存在すれば true、そうでなければ false
33     */
34    public function offsetExists(mixed $offset): bool
35    {
36        // 内部の $data 配列にキーが存在するかどうかを確認して返します
37        return array_key_exists($offset, $this->data);
38    }
39
40    /**
41     * 指定されたオフセット（キー）の値を取得します。
42     * $value = $object['key']; の際に呼び出されます。
43     *
44     * @param mixed $offset 取得するキー
45     * @return mixed キーに対応する値 (存在しない場合は null)
46     */
47    public function offsetGet(mixed $offset): mixed
48    {
49        return $this->offsetExists($offset) ? $this->data[$offset] : null;
50    }
51
52    /**
53     * 指定されたオフセット（キー）に値を設定します。
54     * $object['key'] = $value; の際に呼び出されます。
55     *
56     * @param mixed $offset 設定するキー (null の場合は末尾に追加)
57     * @param mixed $value 設定する値
58     */
59    public function offsetSet(mixed $offset, mixed $value): void
60    {
61        if (is_null($offset)) {
62            $this->data[] = $value;
63        } else {
64            $this->data[$offset] = $value;
65        }
66    }
67
68    /**
69     * 指定されたオフセット（キー）を削除します。
70     * unset($object['key']); の際に呼び出されます。
71     *
72     * @param mixed $offset 削除するキー
73     */
74    public function offsetUnset(mixed $offset): void
75    {
76        unset($this->data[$offset]);
77    }
78}
79
80// --- 使用例 ---
81
82// MyArrayLikeCollection クラスのインスタンスを作成し、初期データを設定
83$collection = new MyArrayLikeCollection([
84    'name' => 'Alice',
85    'age' => 30,
86    'city' => 'New York'
87]);
88
89echo "--- offsetExists のデモンストレーション ---" . PHP_EOL;
90
91// 'name' キーが存在するか確認 (isset() は内部で offsetExists() を呼び出す)
92if (isset($collection['name'])) {
93    echo "'name' キーは存在します。値: " . $collection['name'] . PHP_EOL;
94} else {
95    echo "'name' キーは存在しません。" . PHP_EOL;
96}
97
98// 'country' キーが存在するか確認 (存在しないはず)
99if (isset($collection['country'])) {
100    echo "'country' キーは存在します。値: " . $collection['country'] . PHP_EOL;
101} else {
102    echo "'country' キーは存在しません。" . PHP_EOL;
103}
104
105// 新しいキー 'email' を追加 (offsetSet() が呼び出される)
106$collection['email'] = 'alice@example.com';
107// 追加後、'email' キーが存在するか再確認
108if (isset($collection['email'])) {
109    echo "'email' キーを追加しました。値: " . $collection['email'] . PHP_EOL;
110}
111
112// 'city' キーを削除 (unset() は内部で offsetUnset() を呼び出す)
113unset($collection['city']);
114// 削除後、'city' キーが存在しないことを確認
115if (isset($collection['city'])) {
116    echo "'city' キーは存在します。(誤検出)" . PHP_EOL;
117} else {
118    echo "'city' キーは存在しません。(正しく削除されました)" . PHP_EOL;
119}
120
121?>

PHPのArrayAccessインターフェースを実装するクラスは、オブジェクトを配列のように扱えるようにする機能を提供します。その中のoffsetExistsメソッドは、指定されたキー（オフセット）がオブジェクト内に存在するかどうかを確認する役割を担います。

このメソッドは、isset($object['キー名'])やempty($object['キー名'])といった操作がオブジェクトに対して行われた際に、PHPによって自動的に呼び出されます。 引数mixed $offsetには確認したいキーが渡され、戻り値boolは、キーが存在すればtrue、存在しなければfalseを返します。

サンプルコードでは、MyArrayLikeCollectionクラスがoffsetExistsを実装しており、isset($collection['name'])と書くことで、コレクション内に'name'キーが存在するかを内部的にチェックしています。これにより、配列と同じ感覚でオブジェクトのキーの有無を簡潔に確認し、適切な処理を行うことができるようになります。