Webエンジニア向けプログラミング解説動画をYouTubeで配信中!
▶ チャンネル登録はこちら

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

getStaticPropertiesメソッドの使い方について、初心者にもわかりやすく解説します。

作成日: 更新日:

基本的な使い方

getStaticPropertiesメソッドは、指定されたクラスの全ての静的プロパティの情報を取得するメソッドです。PHPのリフレクションAPIの一部であるReflectionClassクラスに属しており、プログラムの実行中にクラスの構造や情報を動的に検査するために使用されます。

このメソッドを呼び出すと、ReflectionClassオブジェクトが表すクラスに直接定義されている静的プロパティ、およびその親クラスから継承された静的プロパティが、連想配列として返されます。配列のキーはプロパティの名前、値は現在のプロパティの値となります。これにより、publicprotectedprivateといったアクセス修飾子に関わらず、そのクラスの全ての静的プロパティとその値を実行時に調べることが可能になります。

例えば、フレームワークの開発において、特定のクラスが持つ設定値を動的に読み込んだり、クラスのデバッグ時に静的状態を確認したりする際に非常に役立ちます。また、テストの際に、クラスの内部状態である静的プロパティを検査するといった用途でも利用されます。対象のクラスに静的プロパティが一つも定義されていない場合、このメソッドは空の配列を返します。この機能は、PHP 8を含む様々なバージョンで利用でき、プログラムの柔軟性と拡張性を高めるための強力なツールとなります。

構文(syntax)

1<?php
2
3class MyClass
4{
5    public static $propertyOne = 'Static Value 1';
6    protected static $propertyTwo = 'Static Value 2';
7}
8
9$reflectionClass = new ReflectionClass('MyClass');
10$staticProperties = $reflectionClass->getStaticProperties();

引数(parameters)

引数なし

引数はありません

戻り値(return)

array

ReflectionClass::getStaticPropertiesメソッドは、そのクラスで定義されているすべての静的プロパティの名前と値を連想配列として返します。

関連コンテンツ