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

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

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

作成日: 更新日:

基本的な使い方

getStaticPropertiesメソッドは、PHPのReflection機能を通じて、オブジェクトに属するクラスの静的プロパティを取得するメソッドです。

このメソッドは、ReflectionObjectクラスに属しています。ReflectionObjectクラスは、プログラムの実行中に特定のオブジェクトの構造や性質を動的に分析するための機能を提供します。これにより、コードを実行する前にすべてを知る必要なく、実行時にオブジェクトの詳細な情報を調べることが可能になります。

getStaticPropertiesメソッドの役割は、ReflectionObjectが対象としているオブジェクトが属するクラスに定義されているすべての静的プロパティを収集することです。静的プロパティとは、クラスの個々のインスタンスに属するのではなく、クラス自体に直接関連付けられたデータのことです。そのため、そのクラスのすべてのインスタンスで同じ値が共有されます。

このメソッドを実行すると、取得した静的プロパティの名前(文字列)をキーとし、そのプロパティの現在の値を要素とする連想配列が返されます。これにより、静的プロパティとその値にプログラムから簡単にアクセスできるようになります。

getStaticPropertiesメソッドは、フレームワークやライブラリの開発において、クラスの動的な解析や設定情報の取得、デバッグ時における内部状態の確認など、多岐にわたる場面で非常に有用なツールとして活用されます。

構文(syntax)

1<?php
2class MyClass {
3    public static $publicStatic = 'value1';
4    protected static $protectedStatic = 'value2';
5    private static $privateStatic = 'value3';
6}
7
8$object = new MyClass();
9$reflector = new ReflectionObject($object);
10$staticProperties = $reflector->getStaticProperties();
11?>

引数(parameters)

引数なし

引数はありません

戻り値(return)

array

ReflectionObject::getStaticProperties は、そのクラスで定義されている全ての静的プロパティを連想配列として返します。配列のキーはプロパティ名、値はそのプロパティの現在値となります。

関連コンテンツ