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

Copy
1<?php
2
3/**
4 * このクラスは、ユーザーが自分で定義した（作成した）クラスの例です。
5 */
6class MyCustomClass
7{
8    public string $name = 'ユーザー定義オブジェクト';
9
10    /**
11     * オブジェクトのメッセージを返します。
12     *
13     * @return string
14     */
15    public function getMessage(): string
16    {
17        return "Hello from " . $this->name;
18    }
19}
20
21echo "--- ReflectionObject::isUserDefined() のサンプルコード ---\n\n";
22
23// 1. ユーザー定義クラスのインスタンスを作成
24$userObject = new MyCustomClass();
25// ReflectionObject を使って、このオブジェクトに関する情報を取得できるように準備します。
26$reflectionUser = new ReflectionObject($userObject);
27
28echo "■ MyCustomClass (ユーザーが定義したクラス) の場合:\n";
29echo "  クラス名: " . $reflectionUser->getName() . "\n";
30// isUserDefined() メソッドを呼び出し、このオブジェクトがユーザー定義かどうかを確認します。
31// ユーザー定義であれば 'はい'、そうでなければ 'いいえ' と表示します。
32echo "  ユーザー定義クラスか？: " . ($reflectionUser->isUserDefined() ? 'はい' : 'いいえ') . "\n\n";
33
34
35// 2. PHPに組み込まれている（内部）クラスのインスタンスを作成
36// DateTime は日付と時刻を扱うための、PHPにあらかじめ用意されているクラスです。
37$internalObject = new DateTime();
38// ReflectionObject を使って、このオブジェクトに関する情報を取得できるように準備します。
39$reflectionInternal = new ReflectionObject($internalObject);
40
41echo "■ DateTime (PHP内部クラス) の場合:\n";
42echo "  クラス名: " . $reflectionInternal->getName() . "\n";
43// isUserDefined() メソッドを呼び出し、このオブジェクトがユーザー定義かどうかを確認します。
44echo "  ユーザー定義クラスか？: " . ($reflectionInternal->isUserDefined() ? 'はい' : 'いいえ') . "\n\n";
45
46
47// 3. 別のPHP内部クラスのインスタンスを作成
48// stdClass は、プロパティを動的に追加できる汎用的な空のオブジェクトとしてよく使われます。
49$stdClassObject = new stdClass();
50$stdClassObject->message = "これはstdClassです。";
51$reflectionStdClass = new ReflectionObject($stdClassObject);
52
53echo "■ stdClass (PHP内部クラス) の場合:\n";
54echo "  クラス名: " . $reflectionStdClass->getName() . "\n";
55// isUserDefined() メソッドを呼び出し、このオブジェクトがユーザー定義かどうかを確認します。
56echo "  ユーザー定義クラスか？: " . ($reflectionStdClass->isUserDefined() ? 'はい' : 'いいえ') . "\n\n";
57
58?>

ReflectionObject::isUserDefined()メソッドは、PHPのプログラム実行中に、あるオブジェクトが「ユーザー自身が定義したクラス」のインスタンスなのか、それとも「PHPに最初から組み込まれている内部クラス」のインスタンスなのかを判別するために使用されます。

このメソッドはReflectionObjectクラスに属しており、オブジェクトに関する情報を取得するリフレクション機能の一つです。引数は必要なく、戻り値はbool型で判定結果を真偽値で返します。具体的には、対象のオブジェクトがユーザー定義クラスであればtrue（真）、PHPに標準で組み込まれている内部クラスであればfalse（偽）となります。

サンプルコードでは、最初にユーザーが自分で作成したMyCustomClassのオブジェクトに対してisUserDefined()を実行しています。この場合、MyCustomClassはユーザーが定義したクラスであるため、trueが返されます。次に、PHPに標準で提供されているDateTimeクラスやstdClassのオブジェクトに対して同様にisUserDefined()を実行すると、これらはPHP内部クラスであるため、いずれもfalseが返されます。このメソッドは、プログラムが扱うオブジェクトの種類を動的に確認したい場合に利用できます。

Copy
1<?php
2
3/**
4 * ユーザー定義クラスの例。
5 * このクラスは開発者がPHPコード内で明示的に定義しています。
6 */
7class MyCustomClass
8{
9    public string $message = 'Hello from MyCustomClass!';
10
11    public function getMessage(): string
12    {
13        return $this->message;
14    }
15}
16
17/**
18 * オブジェクトがユーザー定義クラスか、PHP組み込みクラスかを判定し、結果を表示します。
19 *
20 * @param object $object 判定対象のオブジェクト
21 */
22function checkClassDefinitionOrigin(object $object): void
23{
24    // ReflectionObject を使用して、オブジェクトに関する詳細な情報を取得します。
25    // これにより、そのオブジェクトがどのクラスから生成されたかなどを調べることができます。
26    $reflector = new ReflectionObject($object);
27
28    // isUserDefined() メソッドは、ReflectionObject が表すクラスが
29    // 開発者によってコード内で定義されたものか (true)、
30    // それともPHPのコアや標準エクステンションによって提供される組み込みクラスか (false) を判定します。
31    $isUserDefined = $reflector->isUserDefined();
32
33    echo "--- クラス名: " . $reflector->getName() . " ---\n";
34    echo "このクラスはユーザー定義ですか？ ";
35
36    if ($isUserDefined) {
37        echo "はい、ユーザーがコード内で定義したクラスです。\n";
38    } else {
39        echo "いいえ、PHPの組み込みクラスです。\n";
40    }
41
42    // キーワード「isset」「undefined variable」との関連について:
43    // isUserDefined は、変数やプロパティが「存在するかどうか」をチェックする isset() や、
44    // 未定義の変数アクセスによるエラー (undefined variable) とは全く異なる目的で使用されます。
45    // isUserDefined は、「特定の変数やオブジェクトが存在するか」ではなく、
46    // 「そのオブジェクトの元となるクラス定義がどこから来たのか（開発者が書いたものか、PHPが元々持っているものか）」
47    // を確認するためのものです。
48    // つまり、「存在」ではなく、クラス定義の「起源」を問い、プログラミング言語の深い部分を探る際に役立ちます。
49}
50
51// ユーザー定義クラスのインスタンスを作成
52$myCustomObject = new MyCustomClass();
53checkClassDefinitionOrigin($myCustomObject);
54
55echo "\n";
56
57// PHP組み込みクラスのインスタンスを作成 (例: DateTimeクラス)
58$dateTimeObject = new DateTime();
59checkClassDefinitionOrigin($dateTimeObject);
60
61echo "\n";
62
63// PHP組み込みの一般的なクラス (stdClass) のインスタンスを作成
64// stdClassは、プロパティを動的に追加できる汎用的な空のクラスとしてよく使われます。
65$stdClassObject = new stdClass();
66checkClassDefinitionOrigin($stdClassObject);

PHPのReflectionObject::isUserDefinedメソッドは、特定のオブジェクトのクラスが、開発者がコード内で定義した「ユーザー定義クラス」なのか、それともPHPのコアや拡張機能に備わる「組み込みクラス」なのかを判定する際に使われます。このメソッドはReflectionObjectのインスタンスから呼び出し、引数は不要です。戻り値は真偽値（bool）で、ユーザー定義クラスであればtrueを、組み込みクラスであればfalseを返します。

例えば、サンプルコード中のMyCustomClassのような開発者が自作したクラスはtrueと判定されますが、DateTimeやstdClassのようなPHP標準のクラスはfalseと判定されます。

このメソッドは、isset()関数による変数の存在確認や、未定義の変数アクセスによるエラーとは目的が大きく異なります。isUserDefinedは変数の有無ではなく、オブジェクトのクラス定義の「起源」を動的に判断し、そのクラスがコード内で定義されたものか、PHP自体に組み込まれているものかを区別したい場合に役立ちます。