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

Copy
1<?php
2
3// PHPのリフレクションAPIを使用して、クラスのプロパティ名を取得するサンプルコードです。
4// ReflectionProperty::getName() メソッドは、ReflectionPropertyオブジェクトが表すプロパティの名前を文字列として返します。
5
6/**
7 * リフレクションの対象となるサンプルクラスを定義します。
8 */
9class MySampleClass
10{
11    /**
12     * プライベートプロパティの例。
13     * @var string
14     */
15    private string $privateProperty = 'Hello';
16
17    /**
18     * パブリックプロパティの例。
19     * @var int
20     */
21    public int $publicProperty = 123;
22}
23
24// 1. 'privateProperty' に関するReflectionPropertyオブジェクトを作成します。
25//    コンストラクタには、対象のクラス名とプロパティ名を文字列で渡します。
26$reflectionPrivateProperty = new ReflectionProperty(MySampleClass::class, 'privateProperty');
27
28// 2. getName() メソッドを呼び出し、このプロパティの名前を取得して出力します。
29echo "取得したプロパティ名 ('privateProperty'): " . $reflectionPrivateProperty->getName() . PHP_EOL;
30
31// 3. 同様に、'publicProperty' に関するReflectionPropertyオブジェクトを作成します。
32$reflectionPublicProperty = new ReflectionProperty(MySampleClass::class, 'publicProperty');
33
34// 4. getName() メソッドを呼び出し、このプロパティの名前を取得して出力します。
35echo "取得したプロパティ名 ('publicProperty'): " . $reflectionPublicProperty->getName() . PHP_EOL;
36

PHP 8のリフレクションAPIは、プログラムの実行中にクラスやメソッド、プロパティといった構造に関する情報を動的に取得・操作できる機能を提供します。このサンプルコードでは、その中の一つであるReflectionProperty::getName()メソッドの基本的な使い方を紹介しています。

ReflectionPropertyクラスは、特定のクラスに定義されたプロパティ（変数）に関する詳細な情報を取得するためのオブジェクトです。ReflectionProperty::getName()メソッドは、このReflectionPropertyオブジェクトがどのプロパティの情報を扱っているか、そのプロパティの名前を文字列として返します。このメソッドは引数を一切取らずに呼び出すことができ、戻り値は常にプロパティの名前を示すstring型となります。

サンプルコードでは、MySampleClassに定義されたprivatePropertyとpublicPropertyという二つのプロパティを対象に、それぞれReflectionPropertyオブジェクトを作成しています。その後、それぞれのオブジェクトに対してgetName()メソッドを呼び出すことで、"privateProperty"や"publicProperty"といった実際のプロパティ名を正確に取得し、画面に出力しています。このようにgetName()メソッドを利用することで、プログラム実行時にプロパティ名を動的に把握し、それに応じた柔軟な処理を実装することが可能になります。

Copy
1<?php
2
3// 名前空間を定義
4namespace MyApp;
5
6/**
7 * サンプルクラス
8 * プロパティを持つことを示す
9 */
10class MySampleClass
11{
12    public string $publicProperty = 'This is public.';
13    protected int $protectedProperty = 123;
14    private bool $privateProperty = true;
15}
16
17/**
18 * ReflectionProperty::getName() の使用例を示す関数
19 *
20 * この関数は、指定されたオブジェクトのクラスのプロパティをリフレクションAPIを使って検査し、
21 * 各プロパティの名前と、そのプロパティが属するクラスの完全修飾名（名前空間を含む）を表示します。
22 *
23 * @param object $object リフレクションを行う対象のオブジェクト
24 * @return void
25 */
26function demonstrateReflectionPropertyGetName(object $object): void
27{
28    // オブジェクトからReflectionClassインスタンスを取得
29    $reflectionClass = new \ReflectionClass($object);
30
31    // クラスの完全修飾名（名前空間を含む）を取得
32    $fullyQualifiedClassName = $reflectionClass->getName();
33    echo "Inspecting Class: " . $fullyQualifiedClassName . "\n\n";
34
35    // 全てのプロパティ（public, protected, private）を取得
36    $properties = $reflectionClass->getProperties();
37
38    if (empty($properties)) {
39        echo "No properties found in " . $fullyQualifiedClassName . ".\n";
40        return;
41    }
42
43    echo "Properties:\n";
44    foreach ($properties as $property) {
45        // ReflectionProperty::getName() を使用してプロパティ名を取得
46        $propertyName = $property->getName();
47
48        // プロパティの名前を表示
49        echo "  - Property Name: '" . $propertyName . "'\n";
50
51        // プロパティが属するクラスの完全修飾名とプロパティ名を組み合わせて表示
52        // これにより、名前空間とクラス内のプロパティの関係を示す
53        echo "    Full Property Path: " . $fullyQualifiedClassName . "::" . $propertyName . "\n";
54
55        // プロパティの可視性を表示 (参考情報)
56        $visibility = 'unknown';
57        if ($property->isPublic()) {
58            $visibility = 'public';
59        } elseif ($property->isProtected()) {
60            $visibility = 'protected';
61        } elseif ($property->isPrivate()) {
62            $visibility = 'private';
63        }
64        echo "    Visibility: " . $visibility . "\n";
65        echo "\n";
66    }
67}
68
69// サンプルクラスのインスタンスを作成
70$instance = new MySampleClass();
71
72// 関数を呼び出し、ReflectionProperty::getName() の動作と名前空間のコンテキストを示す
73demonstrateReflectionPropertyGetName($instance);

ReflectionProperty::getName()は、PHPのリフレクションAPIを構成するReflectionPropertyクラスのメソッドです。このメソッドは引数を取りません。呼び出すと、対象となるクラスプロパティの名前を文字列（string）として返します。

リフレクションAPIは、PHPプログラムが自身の構造（クラス、メソッド、プロパティなど）を実行時に動的に検査したり操作したりするための強力な機能です。これにより、コードの内部構造をプログラム自身で調べることができます。

提供されたサンプルコードでは、MyAppという名前空間の中にMySampleClassというクラスが定義されており、このクラスには異なる可視性のプロパティが含まれています。demonstrateReflectionPropertyGetName関数は、このクラスのインスタンスを受け取り、まずReflectionClassを使ってクラス全体の情報を取得します。

次に、getProperties()メソッドにより、クラス内のすべてのプロパティ（public、protected、private）に対応するReflectionPropertyインスタンスを取得します。そして、それぞれのReflectionPropertyインスタンスに対してgetName()メソッドを呼び出し、各プロパティの名前（例: 'publicProperty', 'privateProperty'）を取得して表示しています。

また、出力ではプロパティの名前だけでなく、そのプロパティが属するクラスの完全修飾名（名前空間を含む例: 'MyApp\MySampleClass::publicProperty'）も合わせて表示しています。これにより、プロパティがどの名前空間に属するどのクラスのメンバーであるかを明確に把握し、プログラムの構造を正確に理解することができます。