【PHP8.x】ReflectionProperty::IS_PUBLIC定数の使い方

Copy
1<?php
2
3/**
4 * プロパティの可視性（publicかどうか）とデータ型（リソース型かどうか）を
5 * 検査するためのサンプルクラスです。
6 */
7class ExampleClass
8{
9    // publicなリソース型のプロパティ
10    public $publicResource;
11
12    // publicな文字列型のプロパティ
13    public string $publicString = 'Hello PHP';
14
15    // protectedなリソース型のプロパティ
16    protected $protectedFileHandle;
17
18    // privateな整数型のプロパティ
19    private int $privateNumber = 123;
20
21    public function __construct()
22    {
23        // publicResource をメモリ上のファイルリソースとして初期化
24        $this->publicResource = fopen('php://memory', 'r+');
25        if (is_resource($this->publicResource)) {
26            fwrite($this->publicResource, "Sample Public Data");
27        }
28
29        // protectedFileHandle を一時ファイルリソースとして初期化
30        $this->protectedFileHandle = fopen('php://temp', 'r+');
31        if (is_resource($this->protectedFileHandle)) {
32            fwrite($this->protectedFileHandle, "Sample Protected Data");
33        }
34    }
35
36    /**
37     * オブジェクトが破棄される際に、開いているリソースを閉じます。
38     * リソースリークを防ぐための重要な処理です。
39     */
40    public function __destruct()
41    {
42        if (is_resource($this->publicResource)) {
43            fclose($this->publicResource);
44        }
45        if (is_resource($this->protectedFileHandle)) {
46            fclose($this->protectedFileHandle);
47        }
48    }
49}
50
51/**
52 * 指定されたオブジェクトのプロパティをリフレクションAPIで検査し、
53 * そのプロパティが「public」であるか、そして「リソース型」であるかを出力します。
54 *
55 * @param object $obj 検査対象のオブジェクト
56 */
57function inspectClassProperties(object $obj): void
58{
59    // オブジェクトのReflectionClassインスタンスを作成し、クラス情報を取得します。
60    $reflectionClass = new ReflectionClass($obj);
61
62    echo "--- クラス: " . $reflectionClass->getName() . " のプロパティ検査 ---\n";
63
64    // クラスが持つ全てのプロパティ（public, protected, private）を取得します。
65    $properties = $reflectionClass->getProperties();
66
67    foreach ($properties as $property) {
68        $propertyName = $property->getName();
69        // プロパティの修飾子（public, protected, private, staticなど）を表す整数値を取得します。
70        $modifiers = $property->getModifiers();
71
72        // ReflectionProperty::IS_PUBLIC 定数を使って、プロパティが public かどうかを判定します。
73        // ビット演算子 '&' を使用して、修飾子に IS_PUBLIC フラグが含まれているかを確認します。
74        $isPublic = ($modifiers & ReflectionProperty::IS_PUBLIC) ? 'はい' : 'いいえ';
75
76        // privateやprotectedプロパティの値も取得できるように、一時的にアクセス権を設定します。
77        $property->setAccessible(true);
78        $value = $property->getValue($obj);
79        // アクセス権を元の状態に戻すことが推奨されます。
80        $property->setAccessible(false);
81
82        // is_resource() 関数を使って、プロパティの値がリソース型であるかを判定します。
83        $isResource = is_resource($value) ? 'はい' : 'いいえ';
84
85        echo "  プロパティ名: \$" . $propertyName . "\n";
86        echo "    公開プロパティ(IS_PUBLIC): " . $isPublic . "\n";
87        echo "    リソース型プロパティ(is_resource): " . $isResource . "\n";
88        echo "-----------------------------------------\n";
89    }
90}
91
92// サンプルクラスのインスタンスを作成します。
93$myObject = new ExampleClass();
94
95// プロパティ検査関数を呼び出し、結果を出力します。
96inspectClassProperties($myObject);
97
98?>

このPHP 8のサンプルコードは、リフレクションAPIを用いてクラスのプロパティが「public」であるか、そして「リソース型」であるかを検査する方法を示しています。 主なポイントはReflectionProperty::IS_PUBLIC定数とis_resource()関数です。 ReflectionProperty::IS_PUBLICは、プロパティがpublicアクセス修飾子を持つかどうかを示す整数値の定数です。ReflectionPropertyオブジェクトのgetModifiers()メソッドが返す整数値と、この定数をビット演算子&で比較することで、プロパティがpublicであるかを判定します。 一方、is_resource()関数は、引数として渡された変数の値がファイルハンドルやデータベース接続といった特殊なリソース型である場合にtrue（真）を、それ以外の場合にfalse（偽）を返します。 サンプルではExampleClassのインスタンスをinspectClassProperties関数（引数としてオブジェクトを受け取ります）に渡し、クラス内の各プロパティを動的に検査します。プロパティ名、そのプロパティがpublicか、そして値がリソース型であるかを判別し、結果を出力します。 特に、setAccessible(true)を使うことで、通常はアクセスできないprivateやprotectedなプロパティの値も一時的に取得して検査する様子が示されており、リフレクションAPIの強力な機能がわかります。