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

Copy
1<?php
2
3/**
4 * プロパティの可視性を確認するためのサンプルクラス。
5 * public, protected, private の各可視性を持つプロパティを定義します。
6 */
7class SampleClass
8{
9    public string $publicProperty = 'パブリックプロパティ';
10    protected int $protectedProperty = 100;
11    private bool $privateProperty = true;
12    public static string $publicStaticProperty = 'パブリック静的プロパティ';
13}
14
15echo "--- SampleClassのプロパティ可視性チェック ---" . PHP_EOL;
16
17// ReflectionClass を使用して SampleClass のリフレクション情報を取得します。
18$reflectionClass = new ReflectionClass(SampleClass::class);
19
20// クラスが持つ全てのプロパティをループ処理します。
21foreach ($reflectionClass->getProperties() as $property) {
22    echo "プロパティ名: " . $property->getName() . PHP_EOL;
23
24    // isPrivate() メソッドを使用して、プロパティが private であるかを確認します。
25    echo "  プライベート? " . ($property->isPrivate() ? "はい" : "いいえ") . PHP_EOL;
26
27    // 参考として、他の可視性も確認し表示します。
28    echo "  パブリック? " . ($property->isPublic() ? "はい" : "いいえ") . PHP_EOL;
29    echo "  プロテクテッド? " . ($property->isProtected() ? "はい" : "いいえ") . PHP_EOL;
30    echo PHP_EOL;
31}
32?>

ReflectionProperty::isPrivateメソッドは、プログラムから動的にクラスのプロパティがprivate（プライベート）な可視性を持つかどうかを確認するために使用されます。PHPには、クラスやオブジェクトの構造をプログラム実行中に検査できる「リフレクションAPI」という機能があり、このメソッドはそのリフレクションAPIの一部であるReflectionPropertyクラスに属しています。

このメソッドには引数がなく、呼び出すだけで対象のプロパティがprivateとして定義されているかを判定します。戻り値はbool型で、プロパティがprivateであればtrueを、そうでなければfalseを返します。

サンプルコードでは、SampleClassというクラスにpublic、protected、privateの異なる可視性を持つプロパティを定義しています。ReflectionClassを使ってSampleClassのリフレクション情報を取得し、そこから各プロパティのReflectionPropertyインスタンスを一つずつ取り出します。それぞれのプロパティに対してisPrivate()メソッドを呼び出すことで、その可視性を判定しています。出力結果から、privatePropertyのみが「プライベート? はい」と表示され、他のプロパティは「いいえ」となることで、isPrivate()メソッドが正しく機能していることがわかります。この機能は、クラスの内部構造を動的に解析し、特定の条件に基づいて処理を行う必要がある場合に役立ちます。なお、同様にisPublic()やisProtected()といったメソッドも存在し、それぞれの可視性を確認できます。

Copy
1<?php
2
3/**
4 * プロパティの可視性をテストするためのサンプルクラス。
5 */
6class SampleClass
7{
8    public string $publicProperty = 'This is a public property.';
9    protected string $protectedProperty = 'This is a protected property.';
10    private string $privateProperty = 'This is a private property.';
11}
12
13/**
14 * 指定されたクラスの各プロパティが private であるかを確認します。
15 * ReflectionProperty::isPrivate メソッドの使用例を示します。
16 */
17function checkPropertyVisibility(): void
18{
19    // SampleClassのReflectionClassインスタンスを作成し、クラス情報を取得
20    $reflectionClass = new ReflectionClass(SampleClass::class);
21
22    echo "--- Checking Property Visibility for SampleClass ---\n";
23
24    // クラス内の全プロパティを取得
25    // ReflectionProperty::getProperties() は PHP 8 で引数なしで public, protected, private 全てを返します。
26    $properties = $reflectionClass->getProperties();
27
28    foreach ($properties as $property) {
29        $propertyName = $property->getName();
30        $isPrivate = $property->isPrivate(); // プロパティが private かどうかを判定
31
32        echo "Property '{$propertyName}': ";
33        if ($isPrivate) {
34            echo "YES, it IS private.\n";
35        } else {
36            echo "NO, it IS NOT private.\n";
37            // 他の可視性も表示する (isPublic(), isProtected())
38            if ($property->isPublic()) {
39                echo "  (It is public)\n";
40            } elseif ($property->isProtected()) {
41                echo "  (It is protected)\n";
42            }
43        }
44    }
45    echo "---------------------------------------------------\n";
46}
47
48// 関数を実行し、結果を表示
49checkPropertyVisibility();

PHP 8のReflectionProperty::isPrivateメソッドは、クラス内で定義されたプロパティが「private（プライベート）」として宣言されているかを確認するために使われます。このメソッドは引数を一切取らず、判定の結果を真偽値（trueまたはfalse）で返します。プロパティがprivateであればtrue、そうでなければfalseです。

サンプルコードでは、まずSampleClassというクラスを定義し、その中にpublic（公開）、protected（保護）、private（非公開）という異なるアクセス修飾子を持つプロパティをそれぞれ用意しています。 checkPropertyVisibility関数では、ReflectionClassという機能を用いてSampleClass全体の情報を取り出し、そこからgetProperties()メソッドでクラス内のすべてのプロパティ情報を取得しています。

取得した各プロパティについてループ処理を行い、一つずつisPrivate()メソッドを呼び出して、そのプロパティがprivateであるかどうかを判定しています。例えば、$privatePropertyに対してはtrueが返され、「YES, it IS private.」と表示されます。一方で、$publicPropertyや$protectedPropertyに対してはfalseが返されるため、それぞれがpublicかprotectedである旨が補足表示されます。

このように、isPrivate()メソッドは、プログラムの実行中にクラスのプロパティの可視性を動的に判別し、その情報に基づいて処理を分岐させたい場合に活用できる機能です。