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

Copy
1<?php
2
3/**
4 * このサンプルコードは、PHP 8で導入された「コンストラクタプロパティプロモーション」
5 * によって宣言されたプロパティかどうかを判定する
6 * ReflectionProperty::isPromoted() メソッドの使用方法を示します。
7 *
8 * ReflectionProperty::isPromoted() は引数なしで呼び出され、
9 * そのプロパティがプロモートされたプロパティであれば true、そうでなければ false を返します。
10 */
11
12// コンストラクタプロパティプロモーションが適用されたプロパティを持つクラス
13class Vehicle
14{
15    // PHP 8以降では、コンストラクタの引数にアクセス修飾子（public/protected/private）を付けることで、
16    // その引数が自動的にクラスプロパティとして定義されます。
17    // これらは「プロモートされたプロパティ」と呼ばれます。
18    public function __construct(
19        public string $brand, // プロモートされたプロパティ
20        public int $year      // プロモートされたプロパティ
21    ) {
22    }
23
24    // これは通常のクラスプロパティです。
25    public string $color = 'red';
26}
27
28// 通常のプロパティのみを持つクラス
29class Engine
30{
31    public string $type;
32    public int $horsepower;
33
34    public function __construct(string $type, int $horsepower)
35    {
36        $this->type = $type;
37        $this->horsepower = $horsepower;
38    }
39}
40
41echo "--- Vehicle クラスのプロパティの確認 ---" . PHP_EOL;
42
43// Vehicle クラスのリフレクション（クラスの構造情報を取得するオブジェクト）を作成
44$vehicleReflection = new ReflectionClass(Vehicle::class);
45
46// Vehicle クラスが持つ全てのプロパティをループ処理
47foreach ($vehicleReflection->getProperties() as $property) {
48    echo "プロパティ '{$property->getName()}' は ";
49    // ReflectionProperty::isPromoted() メソッドを使用して、
50    // そのプロパティがコンストラクタプロパティプロモーションによって定義されたものか判定します。
51    if ($property->isPromoted()) {
52        echo "コンストラクタプロパティプロモーションで宣言されています。" . PHP_EOL;
53    } else {
54        echo "通常のクラスプロパティです。" . PHP_EOL;
55    }
56}
57
58echo PHP_EOL; // 視認性向上のための空行
59
60echo "--- Engine クラスのプロパティの確認 ---" . PHP_EOL;
61
62// Engine クラスのリフレクションを作成
63$engineReflection = new ReflectionClass(Engine::class);
64
65// Engine クラスが持つ全てのプロパティをループ処理
66foreach ($engineReflection->getProperties() as $property) {
67    echo "プロパティ '{$property->getName()}' は ";
68    // isPromoted() を使用して、プロパティがプロモートされたものか判定
69    if ($property->isPromoted()) {
70        echo "コンストラクタプロパティプロモーションで宣言されています。" . PHP_EOL;
71    } else {
72        echo "通常のクラスプロパティです。" . PHP_EOL;
73    }
74}

PHP 8から導入されたReflectionProperty::isPromoted()メソッドは、あるクラスのプロパティが「コンストラクタプロパティプロモーション」によって宣言されたものかどうかを判定するために使用されます。コンストラクタプロパティプロモーションとは、PHP 8で導入された機能で、コンストラクタの引数にpublicやprivateなどのアクセス修飾子を付けることで、その引数が自動的にクラスのプロパティとしても定義される仕組みです。これにより、プロパティの宣言と初期化を簡潔に記述できるようになりました。

このisPromoted()メソッドは引数を一切受け取らずに呼び出され、対象のプロパティがコンストラクタプロパティプロモーションを用いて定義されていればtrue（真）を、通常のプロパティとして定義されていればfalse（偽）をブール値で返します。

サンプルコードでは、Vehicleクラスの$brandや$yearのようにコンストラクタ引数で宣言されたプロパティと、$colorのような通常のプロパティを比較しています。また、全てのプロパティが通常の定義であるEngineクラスのケースも示しています。ReflectionClassとReflectionPropertyを使って各プロパティの情報を取得し、isPromoted()メソッドの結果に基づいて、それぞれのプロパティがどのように宣言されたものかを出力することで、コンストラクタプロパティプロモーションの活用状況をプログラム的に確認できることを示しています。

Copy
1<?php
2
3// PHP 8以降で導入されたコンストラクタプロパティプロモーションを理解するためのサンプルクラス
4class Product
5{
6    // コンストラクタプロパティプロモーションで宣言されたプロパティ（PHP 8以降の機能）
7    // public, protected, private のいずれかのアクセス修飾子を付けてコンストラクタの引数として定義すると、
8    // 自動的に同名のクラスプロパティが作成され、初期化されます。
9    public function __construct(
10        public string $name,
11        private float $price
12    ) {
13        // PHP 8以前では、$this->name = $name; のように手動で代入が必要でした。
14        // プロモートされたプロパティでは、この手動での代入は不要になります。
15    }
16
17    // 通常の方法で宣言されたプロパティ
18    public string $description = 'No description provided.';
19    protected bool $available = true;
20}
21
22/**
23 * クラスのプロパティがコンストラクタでプロモートされたものかを確認する関数です。
24 *
25 * システムエンジニアを目指す初心者の方へ:
26 * このコードは、PHP 8で追加された「コンストラクタプロパティプロモーション」という機能が、
27 * クラスのプロパティにどのように影響するかを調べる方法を示しています。
28 * ReflectionProperty::isPromoted() メソッドを使うと、特定のプロパティがこの新しい方法で
29 * 宣言されたものか（つまり、コンストラクタの引数として定義され、同時にクラスプロパティにもなったものか）
30 * をプログラムから判定できます。
31 */
32function checkPropertyPromotionStatus(): void
33{
34    // ReflectionClass を使って 'Product' クラスの情報を取得します
35    $reflectionClass = new ReflectionClass(Product::class);
36
37    echo "--- Product クラスのプロパティ情報の確認 ---\n";
38
39    // クラスが持つ全てのプロパティを一つずつ調べます
40    foreach ($reflectionClass->getProperties() as $property) {
41        $propertyName = $property->getName();
42        // ReflectionProperty::isPromoted() メソッドを呼び出し、
43        // プロパティがコンストラクタでプロモートされたものかを判定します
44        $isPromoted = $property->isPromoted();
45
46        echo "プロパティ名: '{$propertyName}'\n";
47        echo "  コンストラクタでプロモートされていますか？: " . ($isPromoted ? 'はい' : 'いいえ') . "\n";
48
49        if ($isPromoted) {
50            echo "  (このプロパティはPHP 8の新しい記法で、コンストラクタ引数から自動的に定義されました)\n";
51        } else {
52            echo "  (このプロパティはPHPの従来の記法で、クラス内で直接定義されました)\n";
53        }
54        echo "--------------------------------------------------\n";
55    }
56}
57
58// 関数を実行して、結果をコンソールに出力します
59checkPropertyPromotionStatus();

PHP 8で導入されたReflectionProperty::isPromoted()メソッドは、クラスのプロパティが「コンストラクタプロパティプロモーション」という新しい記法で宣言されたものかどうかを判定するために使用されます。このメソッドは引数を一切取らず、判定結果を真偽値（bool）として返します。プロパティがコンストラクタの引数として定義され、同時にクラスのプロパティとしても自動的に初期化された場合、trueを返します。そうでない場合はfalseを返します。

システムエンジニアを目指す初心者の方にとって、PHP 8のコンストラクタプロパティプロモーションは、クラスのプロパティ定義をより簡潔にするための重要な機能です。このサンプルコードでは、Productクラスのプロパティである$nameと$priceがプロモートされたプロパティとして定義されている一方、$descriptionと$availableは従来の記法で定義されています。

checkPropertyPromotionStatus関数は、ReflectionClassとReflectionPropertyの機能を用いてProductクラスの各プロパティを調べます。そして、それぞれのプロパティに対してisPromoted()メソッドを呼び出し、そのプロパティが新しいプロモーション記法で書かれているか否かを判定し、結果を分かりやすく出力しています。このメソッドを利用することで、プログラムからクラスのプロパティがどのような方法で宣言されたかを動的に確認し、例えばコード生成や解析などの場面で活用できます。