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

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

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

作成日: 更新日:

基本的な使い方

getStaticVariablesメソッドは、ReflectionFunctionクラスに属し、リフレクション対象の関数が内部で保持している静的変数の名前と現在の値を取得するメソッドです。このメソッドは、PHPの「リフレクションAPI」の一部として提供されており、プログラムの実行中にクラスや関数といった要素の構造や状態を動的に調査するために利用されます。

「静的変数」とは、関数内で宣言されるローカル変数の一種ですが、一般的なローカル変数と異なり、関数が一度実行を完了してもその値が破棄されず、保持され続ける特性を持っています。これにより、同じ関数が再度呼び出された際に、前回の実行で設定された値が引き継がれて使用されます。

getStaticVariablesメソッドは、対象の関数が定義しているすべての静的変数について、その変数の名前をキーとし、現在の値を要素とする連想配列として情報を返します。これにより、プログラムの実行中に、特定の関数が内部でどのように状態を保持し、変化させているかを動的に確認することが可能になります。例えば、関数のデバッグ時や、既存のコードベースを解析する際に、関数の隠れた内部状態を理解するための重要な手段となります。システムエンジニアを目指す方にとって、実行時のプログラムの挙動を深く理解するための強力なツールの一つです。

構文(syntax)

1<?php
2
3function myStaticExampleFunction() {
4    static $count = 0;
5    static $message = "Hello";
6    $count++;
7    return $count;
8}
9
10$reflectionFunction = new ReflectionFunction('myStaticExampleFunction');
11$staticVariables = $reflectionFunction->getStaticVariables();
12
13print_r($staticVariables);
14
15?>

引数(parameters)

引数なし

引数はありません

戻り値(return)

array

ReflectionFunction::getStaticVariablesメソッドは、この関数が定義されたスコープ内で定義されている静的変数の連想配列を返します。キーはその静的変数の名前、値はその変数の現在の値となります。

関連コンテンツ