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

Copy
1<?php
2
3/**
4 * SplObjectStorage にキーとして使用するシンプルなオブジェクト。
5 */
6class User
7{
8    private string $name;
9
10    public function __construct(string $name)
11    {
12        $this->name = $name;
13    }
14
15    public function getName(): string
16    {
17        return $this->name;
18    }
19}
20
21// SplObjectStorage のインスタンスを作成します。
22// これはオブジェクトをキーとして、任意のデータを関連付けて格納できる特殊なコレクションです。
23$storage = new SplObjectStorage();
24
25// User オブジェクトをいくつか作成します。これらがストレージのキーとなります。
26$userA = new User('Alice');
27$userB = new User('Bob');
28$userC = new User('Charlie'); // このオブジェクトはまだストレージに追加しません
29
30// offsetSet() メソッドを使用して、各オブジェクトに関連付けるデータを格納します。
31// キーワード「offsetset」に関連するため、このメソッドでデータを設定します。
32$storage->offsetSet($userA, ['role' => 'Administrator', 'active' => true]);
33$storage->offsetSet($userB, ['role' => 'Editor', 'active' => false]);
34
35echo "--- SplObjectStorage へのデータ設定と取得の例 ---\n\n";
36
37// offsetGet() メソッドを使用して、特定のオブジェクトに関連付けられたデータを取得します。
38echo "ユーザー {$userA->getName()} の情報を取得:\n";
39$dataA = $storage->offsetGet($userA);
40if ($dataA !== null) {
41    var_dump($dataA);
42} else {
43    echo "データが見つかりませんでした。\n";
44}
45
46echo "\nユーザー {$userB->getName()} の情報を取得:\n";
47$dataB = $storage->offsetGet($userB);
48if ($dataB !== null) {
49    var_dump($dataB);
50} else {
51    echo "データが見つかりませんでした。\n";
52}
53
54// ストレージに存在しないオブジェクトのデータを取得しようとすると、null が返されます。
55echo "\nユーザー {$userC->getName()} の情報を取得 (未格納):\n";
56$dataC = $storage->offsetGet($userC);
57if ($dataC !== null) {
58    var_dump($dataC);
59} else {
60    echo "データが見つかりませんでした。({$userC->getName()} はストレージに格納されていません)\n";
61}
62

PHPのSplObjectStorageは、オブジェクトそのものをキーとして任意のデータを格納できる特殊なコレクションです。このクラスのoffsetGetメソッドは、指定したオブジェクトに関連付けられたデータを取得するために使用されます。

引数には、キーとして登録されているobject（オブジェクト）を指定します。このメソッドは、もし指定したオブジェクトがSplObjectStorageに存在し、データが関連付けられていれば、その関連付けられたデータ（mixed型）を返します。データが見つからない場合や、指定したオブジェクトがストレージに存在しない場合は、nullが戻り値として返されます。

サンプルコードでは、まずUserオブジェクトを作成し、offsetSetメソッド（キーワード「php offsetset」に関連）で各ユーザーオブジェクトに役割などの情報を関連付けて格納しています。その後、offsetGetメソッドを使って$userAや$userBに関連付けられた情報を取得し、表示しています。ストレージに格納されていない$userCでoffsetGetを呼び出すと、データが見つからないためnullが返されることが確認できます。このように、offsetGetはオブジェクトをキーとしたデータの安全な取得を可能にします。

Copy
1<?php
2
3/**
4 * SplObjectStorage::offsetGet の使用例
5 *
6 * SplObjectStorage は、オブジェクトをキーとして任意のデータを格納できる特殊なコレクションクラスです。
7 * offsetGet() メソッドは、指定されたオブジェクトに関連付けられた値を取得するために使用されます。
8 */
9
10// 1. SplObjectStorage のインスタンスを作成します。
11$storage = new SplObjectStorage();
12
13// 2. いくつかのシンプルなオブジェクトを作成します。
14$user1 = new stdClass();
15$user1->id = 1;
16$user1->name = 'Alice';
17
18$user2 = new stdClass();
19$user2->id = 2;
20$user2->name = 'Bob';
21
22// 3. オブジェクトをキーとして、関連するデータをストレージに格納します。
23//    attach() メソッドは、オブジェクトとそれに関連するデータを追加します。
24//    (これは内部的に offsetSet() を呼び出します)
25$storage->attach($user1, ['role' => 'admin', 'last_login' => '2023-01-01']);
26$storage->attach($user2, ['role' => 'user', 'last_login' => '2023-01-05']);
27
28echo "--- SplObjectStorage::offsetGet の使用例 ---\n\n";
29
30// 4. offsetGet() メソッドを使って、特定のオブジェクトに関連付けられた値を取得します。
31
32// user1 に関連付けられた値を取得します。
33echo "ユーザー Alice のデータ:\n";
34$aliceData = $storage->offsetGet($user1);
35var_dump($aliceData); // 配列が取得される
36
37echo "\n";
38
39// user2 に関連付けられた値を取得します。
40echo "ユーザー Bob のデータ:\n";
41$bobData = $storage->offsetGet($user2);
42var_dump($bobData); // 配列が取得される
43
44echo "\n";
45
46// 5. ストレージに存在しないオブジェクトのデータを取得しようとするとどうなるか。
47$user3 = new stdClass();
48$user3->id = 3;
49$user3->name = 'Charlie';
50
51echo "存在しないユーザー Charlie のデータ:\n";
52$charlieData = $storage->offsetGet($user3);
53var_dump($charlieData); // null が返されます

SplObjectStorage::offsetGetは、PHP 8で利用可能なSplObjectStorageクラスのメソッドです。SplObjectStorageは、一般的な配列とは異なり、オブジェクトそのものをキーとして任意のデータを格納できる特殊なコレクションクラスとして機能します。

このoffsetGetメソッドは、SplObjectStorageに既に格納されているデータの中から、引数として渡された特定のオブジェクトに関連付けられた値を取得するために用いられます。引数 $object には、データを取得したい対象のオブジェクトインスタンスを指定します。

メソッドの実行結果として返される戻り値は mixed 型です。これは、関連付けられたデータの種類が様々であることを示します。具体的には、もし指定したオブジェクトがSplObjectStorage内に存在し、データが関連付けられている場合は、そのデータ（例えばサンプルコードにある配列など）が返されます。一方で、指定されたオブジェクトがSplObjectStorageに存在しない場合や、関連付けられたデータがない場合は、戻り値としてnullが返される挙動となります。

サンプルコードでは、SplObjectStorageにユーザーオブジェクトとそれに関連する情報をattachメソッドで追加した後、offsetGetメソッドを用いて各ユーザーオブジェクトに対応する情報を正確に取得し、存在しないオブジェクトを指定した際にはnullが返される様子を示しています。