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

Copy
1<?php
2
3/**
4 * リフレクションを使って静的プロパティの値を取得する例です。
5 * C#で静的プロパティを取得するのと同様の操作をPHPで行います。
6 */
7class ApplicationSettings
8{
9    /**
10     * アプリケーションの名称。
11     */
12    public static string $appName = 'SampleWebApp';
13
14    /**
15     * アプリケーションのバージョン。
16     */
17    public static float $version = 1.0;
18}
19
20// ReflectionClassのインスタンスを作成し、ApplicationSettingsクラスをリフレクション対象とします。
21$reflectionClass = new ReflectionClass(ApplicationSettings::class);
22
23echo "--- 静的プロパティの値の取得 ---" . PHP_EOL;
24
25// 静的プロパティ $appName の値を取得して出力します。
26echo "アプリケーション名: " . $reflectionClass->getStaticPropertyValue('appName') . PHP_EOL;
27
28// 静的プロパティ $version の値を取得して出力します。
29echo "バージョン: " . $reflectionClass->getStaticPropertyValue('version') . PHP_EOL;
30
31echo PHP_EOL . "--- 存在しない静的プロパティとデフォルト値 ---" . PHP_EOL;
32
33// 存在しない静的プロパティを取得しようとした場合、デフォルト値が返されることを示します。
34// この例では 'N/A' がデフォルト値として指定されています。
35echo "存在しないプロパティ (デフォルト値あり): " . $reflectionClass->getStaticPropertyValue('nonExistentProperty', 'N/A') . PHP_EOL;
36
37// デフォルト値を指定しない場合、存在しないプロパティへのアクセスは ReflectionException をスローします。
38try {
39    echo "存在しないプロパティ (デフォルト値なし): " . $reflectionClass->getStaticPropertyValue('anotherNonExistentProperty') . PHP_EOL;
40} catch (ReflectionException $e) {
41    echo "エラー: 存在しないプロパティへのアクセス (デフォルト値なし): " . $e->getMessage() . PHP_EOL;
42}

このPHPサンプルコードは、ReflectionClassのgetStaticPropertyValueメソッドを使用して、クラスに定義された静的プロパティの値を動的に取得する方法を示しています。ReflectionClassは、プログラムの実行中にクラスの構造（プロパティやメソッドなど）を調べたり、操作したりする「リフレクション」という機能を提供するものです。

getStaticPropertyValueメソッドは、指定されたクラスに存在する静的プロパティの値を取得するために用いられます。第一引数には、取得したい静的プロパティの名前を文字列で指定します。第二引数$defaultは省略可能で、もし指定したプロパティが存在しない場合に、その代わりに返されるデフォルト値を設定できます。この$default引数を省略し、かつプロパティが見つからない場合は、ReflectionExceptionというエラー（例外）が発生します。このメソッドの戻り値は、取得された静的プロパティの値、または指定されたデフォルト値となります。

サンプルコードでは、ApplicationSettingsクラスの静的プロパティ$appNameや$versionの値をリフレクション経由で取得しています。さらに、存在しないプロパティにアクセスする際に、デフォルト値を指定した場合の挙動と、デフォルト値を指定しなかったために例外が発生するケースも示しており、このメソッドの利用方法と注意点を具体的に学ぶことができます。

Copy
1<?php
2
3/**
4 * 静的プロパティを持つサンプルクラス。
5 * クラスのインスタンスを作成せずに直接アクセスできるプロパティ (static) を定義します。
6 */
7class Configuration
8{
9    // 公開静的プロパティ: どこからでもアクセス可能
10    public static string $applicationName = 'MyAwesomeApp';
11
12    // 保護静的プロパティ: このクラス自身と継承クラスからアクセス可能
13    protected static int $version = 1;
14
15    // 非公開静的プロパティ: このクラス自身からのみアクセス可能
16    private static bool $debugMode = false;
17}
18
19/**
20 * ReflectionClass を使用して、クラスの静的プロパティの値を取得する例です。
21 * 通常、静的プロパティは ClassName::$propertyName の形式で直接アクセスしますが、
22 * Reflection を使うと、プロパティの名前を文字列で指定したり、
23 * private/protected なプロパティにもアクセスしたりできます。
24 */
25
26// ReflectionClass のインスタンスを作成し、Configuration クラスに関する情報を取得します。
27$reflectionClass = new ReflectionClass(Configuration::class);
28
29echo "--- 静的プロパティの値の取得例 ---\n";
30
31// 1. 公開静的プロパティ 'applicationName' の値を取得
32// getStaticPropertyValue() メソッドは、指定された名前の静的プロパティの値を返します。
33$appName = $reflectionClass->getStaticPropertyValue('applicationName');
34echo "アプリケーション名 (public): " . $appName . "\n"; // 出力: MyAwesomeApp
35
36// 2. 保護静的プロパティ 'version' の値を取得
37// Reflection を使えば、protected なプロパティにもアクセスできます。
38$version = $reflectionClass->getStaticPropertyValue('version');
39echo "バージョン (protected): " . $version . "\n"; // 出力: 1
40
41// 3. 非公開静的プロパティ 'debugMode' の値を取得
42// Reflection を使えば、private なプロパティにもアクセスできます。
43$debugMode = $reflectionClass->getStaticPropertyValue('debugMode');
44echo "デバッグモード (private): " . ($debugMode ? '有効' : '無効') . "\n"; // 出力: 無効
45
46// 4. 存在しない静的プロパティの取得 (デフォルト値の指定)
47// 指定した名前の静的プロパティが存在しない場合、第2引数で指定したデフォルト値が返されます。
48$logLevel = $reflectionClass->getStaticPropertyValue('logLevel', 'info');
49echo "ログレベル (存在しないプロパティのデフォルト値): " . $logLevel . "\n"; // 出力: info
50
51// 存在しないプロパティをデフォルト値なしで取得しようとすると、ReflectionException が発生します。
52// 以下はエラーになる例（コメントアウトしてあります）:
53/*
54try {
55    $reflectionClass->getStaticPropertyValue('nonExistentPropertyWithoutDefault');
56} catch (ReflectionException $e) {
57    echo "エラー: " . $e->getMessage() . "\n"; // "Property nonExistentPropertyWithoutDefault does not exist" のようなメッセージ
58}
59*/
60?>

ReflectionClass::getStaticPropertyValueメソッドは、PHPのクラスが持つ「静的プロパティ」の値をプログラムから動的に取得するために使用されます。静的プロパティとは、staticキーワードで宣言され、クラスのインスタンスを作成せずにClassName::$propertyNameのように直接アクセスできるプロパティのことです。

このメソッドを使うと、取得したい静的プロパティの名前を文字列で指定できるため、プログラムの実行中にどのプロパティにアクセスするかを柔軟に決定できます。さらに、通常はアクセスが制限されているprotectedやprivateな静的プロパティの値も取得することが可能です。

第一引数$nameには、取得したい静的プロパティの名前を文字列で指定します。第二引数$defaultはオプションで、指定したプロパティがクラスに存在しない場合に返されるデフォルト値を設定できます。このデフォルト値を省略した場合、存在しないプロパティにアクセスしようとするとエラーが発生します。戻り値は、指定された静的プロパティの値、またはデフォルト値となります。

サンプルコードでは、Configurationクラスのpublic、protected、privateな静的プロパティに、ReflectionClassを介してアクセスし、その値を取得しています。また、存在しないプロパティに対してデフォルト値を指定してエラーを防ぐ例も示されており、これにより柔軟かつ安全に静的プロパティの値を操作できることがわかります。この機能は、フレームワークやライブラリ開発において、クラスの内部構造を動的に解析する際に特に役立ちます。