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

Copy
1<?php
2
3// ReflectionObject::hasProperty() メソッドのデモンストレーション
4// このメソッドは、指定されたオブジェクトが特定の名前のプロパティを持っているかどうかを調べます。
5
6/**
7 * プロパティを持つサンプルクラス。
8 */
9class MySampleClass
10{
11    /**
12     * 公開プロパティ。
13     *
14     * @var string
15     */
16    public string $publicProperty = '公開データ';
17
18    /**
19     * プライベートプロパティ。
20     *
21     * @var int
22     */
23    private int $privateProperty = 123;
24
25    /**
26     * 保護されたプロパティ。
27     *
28     * @var bool
29     */
30    protected bool $protectedProperty = true;
31}
32
33// MySampleClass のインスタンスを作成
34$myObject = new MySampleClass();
35
36// オブジェクトのReflectionObjectインスタンスを作成します。
37// ReflectionObjectは、実行時にオブジェクトの構造（プロパティ、メソッドなど）を検査するためのクラスです。
38$reflector = new ReflectionObject($myObject);
39
40echo "--- ReflectionObject::hasProperty() メソッドの確認 ---\n\n";
41
42// ケース1: オブジェクトに存在する公開プロパティをチェック
43// hasProperty() は、プロパティのアクセス修飾子（public, private, protected）に関わらず、
44// その名前のプロパティがオブジェクトに定義されているかをチェックします。
45$propertyName1 = 'publicProperty';
46if ($reflector->hasProperty($propertyName1)) {
47    echo "オブジェクトには '{$propertyName1}' プロパティが存在します。\n";
48} else {
49    echo "オブジェクトには '{$propertyName1}' プロパティが存在しません。\n";
50}
51
52// ケース2: オブジェクトに存在するプライベートプロパティをチェック
53$propertyName2 = 'privateProperty';
54if ($reflector->hasProperty($propertyName2)) {
55    echo "オブジェクトには '{$propertyName2}' プロパティが存在します。\n";
56} else {
57    echo "オブジェクトには '{$propertyName2}' プロパティが存在しません。\n";
58}
59
60// ケース3: オブジェクトに存在する保護されたプロパティをチェック
61$propertyName3 = 'protectedProperty';
62if ($reflector->hasProperty($propertyName3)) {
63    echo "オブジェクトには '{$propertyName3}' プロパティが存在します。\n";
64} else {
65    echo "オブジェクトには '{$propertyName3}' プロパティが存在しません。\n";
66}
67
68// ケース4: オブジェクトに存在しないプロパティをチェック
69$propertyName4 = 'nonExistentProperty';
70if ($reflector->hasProperty($propertyName4)) {
71    echo "オブジェクトには '{$propertyName4}' プロパティが存在します。\n";
72} else {
73    echo "オブジェクトには '{$propertyName4}' プロパティが存在しません。\n";
74}
75
76echo "\n----------------------------------------------------\n";
77
78?>

PHPのReflectionObject::hasProperty()メソッドは、実行時にオブジェクトの構造（プロパティやメソッドなど）を検査するためのReflectionObjectクラスに属しています。このメソッドの主な役割は、指定されたオブジェクトが特定の名前のプロパティを持っているかどうかを調べることです。

引数には、チェックしたいプロパティの名前を文字列（string $name）で指定します。メソッドは、そのプロパティがオブジェクトに存在すればtrueを、存在しなければfalseをブール値（bool）として返します。

hasProperty()の特徴として、プロパティのアクセス修飾子（public、private、protected）に関わらず、その名前のプロパティがクラス定義に存在するかどうかを判断する点が挙げられます。サンプルコードでは、公開、プライベート、保護された各プロパティ名を指定した場合、いずれもオブジェクト内にプロパティが定義されているためtrueが返されます。一方、クラスに存在しないプロパティ名を指定した場合はfalseが返されます。これにより、開発者は実行時にオブジェクトのプロパティの存在を安全に確認し、それに応じた処理を行うことが可能になります。

Copy
1<?php
2
3/**
4 * サンプル用のクラスを定義します。
5 * 異なる可視性を持つプロパティを含めます。
6 */
7class Product
8{
9    public string $name;
10    private float $price;
11    protected string $sku;
12
13    public function __construct(string $name, float $price, string $sku)
14    {
15        $this->name = $name;
16        $this->price = $price;
17        $this->sku = $sku;
18    }
19
20    public function getPrice(): float
21    {
22        return $this->price;
23    }
24}
25
26/**
27 * ReflectionObject::hasProperty メソッドの使用例を示します。
28 * 指定されたオブジェクトが特定のプロパティを持っているかを確認します。
29 */
30function demonstrateHasProperty(): void
31{
32    // Productクラスのインスタンスを作成します。
33    $product = new Product('Laptop', 1200.50, 'LTOP-X123');
34
35    // ReflectionObjectのインスタンスを作成します。
36    // これにより、オブジェクトの構造に関する情報を取得できるようになります。
37    $reflector = new ReflectionObject($product);
38
39    echo "--- プロパティ存在チェック ({$reflector->getName()} オブジェクト) ---\n";
40
41    // 存在するパブリックプロパティのチェック
42    $propertyName1 = 'name';
43    if ($reflector->hasProperty($propertyName1)) {
44        echo "✅ プロパティ '{$propertyName1}' は存在します。\n";
45    } else {
46        echo "❌ プロパティ '{$propertyName1}' は存在しません。\n";
47    }
48
49    // 存在するプライベートプロパティのチェック (hasPropertyは可視性に関わらず存在を検出します)
50    $propertyName2 = 'price';
51    if ($reflector->hasProperty($propertyName2)) {
52        echo "✅ プロパティ '{$propertyName2}' は存在します。\n";
53    } else {
54        echo "❌ プロパティ '{$propertyName2}' は存在しません。\n";
55    }
56
57    // 存在するプロテクテッドプロパティのチェック
58    $propertyName3 = 'sku';
59    if ($reflector->hasProperty($propertyName3)) {
60        echo "✅ プロパティ '{$propertyName3}' は存在します。\n";
61    } else {
62        echo "❌ プロパティ '{$propertyName3}' は存在しません。\n";
63    }
64
65    // 存在しないプロパティのチェック
66    $propertyName4 = 'weight';
67    if ($reflector->hasProperty($propertyName4)) {
68        echo "✅ プロパティ '{$propertyName4}' は存在します。\n";
69    } else {
70        echo "❌ プロパティ '{$propertyName4}' は存在しません。\n";
71    }
72
73    // メソッド名をプロパティとしてチェックした場合 (メソッドはプロパティではないため存在しません)
74    $propertyName5 = 'getPrice';
75    if ($reflector->hasProperty($propertyName5)) {
76        echo "✅ プロパティ '{$propertyName5}' は存在します。\n";
77    } else {
78        echo "❌ プロパティ '{$propertyName5}' は存在しません。\n";
79    }
80}
81
82// 関数を実行し、結果を出力します。
83demonstrateHasProperty();

PHPのReflectionObject::hasPropertyメソッドは、特定のオブジェクトが指定された名前のプロパティを持っているかを動的に確認する機能です。

このメソッドを利用するには、まず調べたいオブジェクトをReflectionObjectのコンストラクタに渡し、そのインスタンスを作成します。ReflectionObjectは、PHPのリフレクションAPIの一部で、実行時にクラスやオブジェクトの構造に関する情報を取得するのに使われます。

hasPropertyは、string $name（プロパティ名）を引数にとり、そのプロパティがオブジェクト内に存在すればtrue、なければfalseをbool型で返します。プロパティの可視性（public、private、protected）に関わらず、存在を判定できる点が特徴です。

サンプルコードでは、ProductオブジェクトをReflectionObjectで調べ、hasPropertyを呼び出しています。name、price、skuといった異なる可視性のプロパティが存在するとtrueが返されます。一方で、存在しないweightやメソッド名のgetPriceではfalseとなることがわかります。このメソッドは、実行時にオブジェクトの構造を柔軟に検証する際に役立ちます。