【PHP8.x】spl_object_id()関数の使い方

Copy
1<?php
2
3/**
4 * spl_object_id の使用例を示すクラス。
5 * オブジェクトのユニークなIDを取得する方法を実演します。
6 */
7class SimpleObject
8{
9    public string $name;
10
11    public function __construct(string $name)
12    {
13        $this->name = $name;
14    }
15}
16
17// SimpleObject のインスタンスを2つ作成します。
18$objectA = new SimpleObject("Object Alpha");
19$objectB = new SimpleObject("Object Beta");
20
21// objectA への参照を別の変数に代入します。
22$objectA_ref = $objectA;
23
24// spl_object_id を使用して、各オブジェクトのユニークなIDを取得します。
25$idA = spl_object_id($objectA);
26$idB = spl_object_id($objectB);
27$idA_ref = spl_object_id($objectA_ref);
28
29// 取得したIDを出力します。
30echo "ID for \$objectA ('" . $objectA->name . "'): " . $idA . "\n";
31echo "ID for \$objectB ('" . $objectB->name . "'): " . $idB . "\n";
32echo "ID for \$objectA_ref (参照先は\$objectA): " . $idA_ref . "\n\n";
33
34// 異なるオブジェクトは異なるIDを持つことを確認します。
35if ($idA !== $idB) {
36    echo "確認: \$objectA と \$objectB は異なるオブジェクトインスタンスであるため、IDは異なります。\n";
37} else {
38    echo "エラー: \$objectA と \$objectB のIDが同じです。\n";
39}
40
41// 同じオブジェクトインスタンス（またはその参照）は同じIDを持つことを確認します。
42if ($idA === $idA_ref) {
43    echo "確認: \$objectA と \$objectA_ref は同じオブジェクトインスタンスを参照しているため、IDは同じです。\n";
44} else {
45    echo "エラー: \$objectA と \$objectA_ref のIDが異なります。\n";
46}
47
48?>

spl_object_id関数は、PHP 8で導入された機能で、指定されたオブジェクトインスタンスに割り当てられたユニークな整数IDを取得します。このIDは、オブジェクトがメモリ上に存在する間、そのオブジェクトを識別するための唯一の番号として機能します。

引数には、IDを取得したいobject型のオブジェクトを指定します。戻り値としては、そのオブジェクト専用のint型のユニークなIDが返されます。異なるオブジェクトインスタンスには必ず異なるIDが割り当てられますが、同じオブジェクトを指す複数の変数（参照）からは常に同じIDが取得される点が特徴です。

サンプルコードでは、まずSimpleObjectクラスのインスタンスである$objectAと$objectBという異なるオブジェクトを作成しています。また、$objectA_refは$objectAへの参照です。それぞれの変数に対してspl_object_id関数を適用すると、$objectAと$objectBは異なるオブジェクトなので別々のIDが、$objectAと$objectA_refは同じオブジェクトを参照しているため同じIDが取得されることを確認できます。この関数は、オブジェクトが同一であるかを数値で判別する際に役立ちます。

Copy
1<?php
2
3/**
4 * spl_object_id 関数の使用例
5 * オブジェクトの一意なIDを取得する方法を示します。
6 * このIDは、オブジェクトがメモリ上で一意に識別されるための数値です。
7 */
8
9// 1. サンプルで使用するシンプルなクラスを定義します。
10class User
11{
12    public string $name;
13
14    public function __construct(string $name)
15    {
16        $this->name = $name;
17    }
18}
19
20// ----------------------------------------------------
21// spl_object_id の使用方法
22// ----------------------------------------------------
23
24// 2. 異なるオブジェクトインスタンスを複数生成します。
25$userAlice = new User('Alice');
26$userBob = new User('Bob');
27
28// 3. 最初のオブジェクト($userAlice)と同じインスタンスを参照する変数を作成します。
29//    これは新しいオブジェクトではなく、既存のオブジェクトへの参照です。
30$userAliceReference = $userAlice;
31
32// 4. spl_object_id 関数を使用して、各オブジェクトの一意のIDを取得し表示します。
33echo "ユーザー '{$userAlice->name}' のオブジェクトID: " . spl_object_id($userAlice) . "\n";
34echo "ユーザー '{$userBob->name}' のオブジェクトID: " . spl_object_id($userBob) . "\n";
35
36// $userAliceReference は $userAlice と同じオブジェクトを参照しているため、
37// spl_object_id は同じIDを返します。
38echo "ユーザー '{$userAliceReference->name}' (Aliceの参照) のオブジェクトID: " . spl_object_id($userAliceReference) . "\n";
39
40// 別のクラスのオブジェクトでも、それぞれ異なる一意なIDが割り振られます。
41class Product {}
42$productShirt = new Product();
43echo "ProductオブジェクトのID: " . spl_object_id($productShirt) . "\n";
44
45?>

PHPのspl_object_id関数は、指定されたオブジェクトに対して、プログラム実行中に一意な整数値の識別子（ID）を取得するための機能です。このIDは、オブジェクトがメモリ上で個別に識別されるためのものであり、オブジェクトそのものを表す数値的な指紋のような役割を果たします。

引数にはobject $objectとして、IDを知りたい対象のオブジェクトインスタンスを渡します。戻り値はint型で、そのオブジェクト固有の数値が返されます。異なるオブジェクトを作成するたびに、それぞれ異なる一意のIDが割り振られます。

サンプルコードに示すように、Userクラスのインスタンスを複数作成すると、それぞれに異なるIDが付与されます。しかし、あるオブジェクトを参照する複数の変数に対してspl_object_idを適用した場合、それらは同じオブジェクトを指しているため、常に同じIDが返されます。これは、オブジェクトの同一性を確認する際に利用できる重要な挙動です。異なるクラスのオブジェクトであっても、生成されたインスタンスごとに一意のIDが割り振られます。spl_object_idは、オブジェクトのライフサイクル管理やデバッグ、特定のオブジェクトを効率的に識別する場面で役立ちます。