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

Copy
1<?php
2
3/**
4 * コンストラクタプロモーションを実演するためのサンプルクラスです。
5 * PHP 8で導入されたコンストラクタプロモーションにより、
6 * コンストラクタ引数の一部を直接プロパティとして定義できます。
7 */
8class Product
9{
10    /**
11     * @param string $name promotedProperty: これはコンストラクタプロモーションによりクラスのプロパティとなります。
12     * @param float $price normalParameter: これは通常のコンストラクタ引数であり、自動的にプロパティにはなりません。
13     */
14    public function __construct(
15        public string $name, // 'public' キーワードにより、自動的にプロパティとして昇格される
16        float $price          // 'public' などの可視性修飾子がないため、通常の引数
17    ) {
18        // $name は既にプロパティとして定義されています。
19        // $price はここで利用できますが、別途プロパティとして定義しない限り、
20        // クラス外部からは直接アクセスできません。
21    }
22}
23
24// ReflectionMethod を使用して、Product クラスのコンストラクタを取得します。
25$reflectionMethod = new ReflectionMethod(Product::class, '__construct');
26
27// コンストラクタのすべてのパラメータを取得します。
28$parameters = $reflectionMethod->getParameters();
29
30echo "--- Product::__construct のパラメータ昇格状態 --- \n";
31
32foreach ($parameters as $parameter) {
33    // ReflectionParameter::getName() でパラメータ名を取得します。
34    $paramName = $parameter->getName();
35
36    // ReflectionParameter::isPromoted() を呼び出し、そのパラメータがコンストラクタプロモーションによって
37    // 昇格された（promoted）プロパティであるかどうかを判定します。
38    $isPromoted = $parameter->isPromoted();
39
40    echo "パラメータ名: '{$paramName}'\n";
41    echo "昇格されたプロパティか: " . ($isPromoted ? 'はい' : 'いいえ') . "\n";
42    echo "-------------------------------\n";
43}
44
45?>

ReflectionParameter::isPromotedメソッドは、PHP 8で導入された「コンストラクタプロモーション」によって、クラスのコンストラクタ引数がクラスのプロパティとして自動的に定義されたかどうかを判定するために使用されます。コンストラクタプロモーションとは、コンストラクタの引数にpublicやprotectedといった可視性修飾子を直接記述することで、その引数を初期化と同時に同名のクラスプロパティとして定義できる機能です。これにより、クラス定義をより簡潔に記述できるようになります。

このメソッドは引数を取りません。戻り値は真偽値（bool）で、対象のパラメータがコンストラクタプロモーションによって昇格されたプロパティである場合にtrueを、通常の引数である場合はfalseを返します。

サンプルコードでは、Productクラスのコンストラクタに定義された二つのパラメータの昇格状態をリフレクションAPIを使って確認しています。$nameパラメータはpublic修飾子が付けられているためプロモーションされたプロパティとなり、isPromoted()メソッドはtrueを返します。一方、$priceパラメータは修飾子がないため通常の引数であり、isPromoted()メソッドはfalseを返します。このコードは、コンストラクタプロモーションが適用されている引数をプログラムによって動的に識別できる様子を示しています。

Copy
1<?php
2
3/**
4 * プロパティプロモーションを使用したクラスの例 (PHP 8 以降)
5 */
6class Product
7{
8    /**
9     * コンストラクタ引数として宣言され、同時にクラスプロパティとしても昇格（プロモート）される。
10     * public, protected, private のいずれかの可視性修飾子が付く。
11     */
12    public function __construct(
13        public string $name,
14        public float $price,
15        string $description // これは通常のコンストラクタ引数で、プロパティとしては昇格されない
16    ) {
17        // $description はプロパティとして昇格されていないため、
18        // クラスプロパティとして保持したい場合は明示的に代入する必要がある。
19        // 例: $this->description = $description;
20    }
21}
22
23/**
24 * 指定されたクラスのコンストラクタ引数を解析し、
25 * 各引数がプロパティとして昇格されているか（isPromoted()）を表示する。
26 */
27function analyzeConstructorPromotion(string $className): void
28{
29    echo "--- クラス: {$className} のコンストラクタ引数解析 ---\n";
30
31    try {
32        $reflectionClass = new ReflectionClass($className);
33        $constructor = $reflectionClass->getConstructor();
34
35        if ($constructor === null) {
36            echo "このクラスにはコンストラクタがありません。\n";
37            return;
38        }
39
40        echo "分析対象メソッド: " . $constructor->getName() . "\n";
41
42        foreach ($constructor->getParameters() as $parameter) {
43            echo "  パラメータ名: " . $parameter->getName() . "\n";
44            // ReflectionParameter::isPromoted() を使用して、引数がプロパティとして昇格されているか確認
45            echo "  プロパティとして昇格されているか (isPromoted()): " . ($parameter->isPromoted() ? 'はい' : 'いいえ') . "\n";
46            echo "  型: " . ($parameter->hasType() ? $parameter->getType()->__toString() : '不明') . "\n";
47            echo "\n";
48        }
49    } catch (ReflectionException $e) {
50        echo "エラー: " . $e->getMessage() . "\n";
51    }
52    echo "---------------------------------------------------\n\n";
53}
54
55// Product クラスのコンストラクタ引数プロモーションを分析
56analyzeConstructorPromotion(Product::class);
57
58/**
59 * プロパティプロモーションを使用していないクラスの例
60 */
61class OldProduct
62{
63    public string $name;
64    public float $price;
65    public string $description;
66
67    public function __construct(string $name, float $price, string $description)
68    {
69        $this->name = $name;
70        $this->price = $price;
71        $this->description = $description;
72    }
73}
74
75// OldProduct クラスのコンストラクタ引数プロモーションを分析
76// すべての引数がプロモートされていないことを確認
77analyzeConstructorPromotion(OldProduct::class);
78
79?>

PHP 8で導入された「コンストラクタプロパティプロモーション」という機能を解析するために役立つのが、ReflectionParameterクラスのisPromoted()メソッドです。このメソッドは、クラスのコンストラクタ引数が同時にクラスプロパティとして昇格（プロモート）されているかどうかを判定します。

isPromoted()メソッドは引数を取りません。戻り値は真偽値（bool）で、コンストラクタ引数がpublic、protected、privateのいずれかの可視性修飾子を伴って宣言されている場合にtrueを返します。これは、その引数が自動的にクラスのプロパティとしても初期化されることを意味します。もし引数が通常のコンストラクタ引数として宣言されており、プロパティとして昇格されていない場合はfalseを返します。

サンプルコードでは、Productクラスのコンストラクタで$nameと$priceがpublic修飾子付きで宣言されており、これらがプロパティプロモーションの対象です。一方$descriptionは修飾子がないため通常の引数です。analyzeConstructorPromotion関数は、ReflectionClassとReflectionParameterを使って各コンストラクタ引数の情報を取得し、それぞれの引数に対してisPromoted()を呼び出しています。実行すると、$nameと$priceには「はい」、$descriptionには「いいえ」と表示され、プロモーションの有無が正確に判別されていることが分かります。OldProductクラスの例では、プロパティプロモーションが使われていないため、すべての引数で「いいえ」と表示されます。このメソッドは、実行時にクラスの構造を分析する際に非常に有用です。