【PHP8.x】ReflectionProperty::IS_STATIC定数の使い方

Copy
1<?php
2
3/**
4 * プロパティの静的/非静的判定を行うクラスの例
5 */
6class SampleClass
7{
8    /**
9     * これは非静的（インスタンス）プロパティです。
10     *
11     * @var string
12     */
13    public $instanceProperty = '非静的プロパティの値';
14
15    /**
16     * これは静的（クラス）プロパティです。
17     *
18     * @var string
19     */
20    public static $staticProperty = '静的プロパティの値';
21
22    /**
23     * プライベートな静的プロパティです。
24     *
25     * @var int
26     */
27    private static $privateStaticProperty = 123;
28}
29
30/**
31 * Reflection API を使用して、SampleClass のプロパティが静的かどうかを判定する関数。
32 *
33 * ReflectionProperty::IS_STATIC 定数を利用して、プロパティが静的であるかを調べます。
34 */
35function demonstrateStaticPropertyCheck(): void
36{
37    echo "--- プロパティの静的/非静的判定 ---" . PHP_EOL;
38
39    // ReflectionClass を使って SampleClass をリフレクション（検査）します。
40    $reflectionClass = new ReflectionClass(SampleClass::class);
41
42    // クラスが持つ全てのプロパティを取得します。
43    $properties = $reflectionClass->getProperties();
44
45    // 各プロパティについてループ処理を行います。
46    foreach ($properties as $property) {
47        // プロパティの名前を取得します。
48        $propertyName = $property->getName();
49
50        // プロパティの修飾子（public, private, staticなど）を表すビットマスクを取得します。
51        $modifiers = $property->getModifiers();
52
53        // ReflectionProperty::IS_STATIC 定数を使って、プロパティが静的であるかを判定します。
54        // getModifiers() の戻り値と IS_STATIC をビットAND演算子 '&' で比較し、
55        // IS_STATIC フラグが立っているか（静的であるか）を確認します。
56        if (($modifiers & ReflectionProperty::IS_STATIC) === ReflectionProperty::IS_STATIC) {
57            echo "プロパティ '{$propertyName}' は静的プロパティです。" . PHP_EOL;
58        } else {
59            echo "プロパティ '{$propertyName}' は非静的プロパティです。" . PHP_EOL;
60        }
61    }
62}
63
64// 関数を実行して結果を表示します。
65demonstrateStaticPropertyCheck();
66
67?>

PHP 8のReflectionProperty::IS_STATICは、ReflectionPropertyクラスが提供する定数です。これは、プログラム実行中にクラスのプロパティが「静的」（staticキーワードで宣言された、インスタンスを生成せずにクラスから直接アクセスできるプロパティ）であるか「非静的」（インスタンスを通してアクセスするプロパティ）であるかを判別するために使用されます。この定数自体に引数や戻り値はありません。

サンプルコードでは、ReflectionClassとReflectionPropertyといったリフレクションAPIを利用し、SampleClass内のプロパティが静的かどうかを動的にチェックしています。まず、ReflectionClassでSampleClassの情報を取得し、getProperties()メソッドでそのクラスの全プロパティを表すReflectionPropertyオブジェクトの配列を取得します。

各プロパティについてループ処理を行い、ReflectionPropertyオブジェクトのgetModifiers()メソッドを呼び出します。このメソッドは、プロパティのアクセス修飾子（public, privateなど）や静的であるかどうかの情報を含む数値（ビットマスク）を返します。ReflectionProperty::IS_STATIC定数をこのビットマスクとビットAND演算子&で比較することで、プロパティが静的フラグを持っているか、すなわち静的プロパティであるかを判別できます。比較結果がIS_STATICと一致すれば静的、そうでなければ非静的として、それぞれのプロパティ名と共に結果を出力しています。