【PHP8.x】get_declared_traits()関数の使い方

Copy
1<?php
2
3/**
4 * 現在のスコープで定義されているすべての変数を表示するサンプル関数です。
5 *
6 * get_defined_vars() 関数は、その関数が呼び出された時点の
7 * ローカルスコープで定義されている変数とその値を連想配列として返します。
8 * スーパーグローバル変数 (例: $_SERVER, $_GET) もこの結果に含まれます。
9 */
10function demonstrateGetDefinedVars(): void
11{
12    // この関数内で定義されたローカル変数
13    $userName = 'System Engineer Beginner';
14    $phpVersion = 8;
15    $skills = ['PHP', 'SQL', 'Linux'];
16    $isLearning = true;
17    
18    echo "--- demonstrateGetDefinedVars() 関数内の get_defined_vars() の出力 ---" . PHP_EOL;
19
20    // get_defined_vars() を呼び出し、現在のスコープの変数を取得
21    $definedVariables = get_defined_vars();
22
23    // 取得した変数をループで表示
24    foreach ($definedVariables as $varName => $varValue) {
25        echo "変数名: " . $varName . ", ";
26        
27        // 変数の型に応じて表示方法を調整し、理解を助ける
28        if (is_array($varValue)) {
29            // 配列の場合、内容をカンマ区切りで表示
30            echo "値: [" . implode(', ', $varValue) . "] (型: " . get_debug_type($varValue) . ")" . PHP_EOL;
31        } elseif (is_bool($varValue)) {
32            // 真偽値の場合、true/false で表示
33            echo "値: " . ($varValue ? 'true' : 'false') . " (型: " . get_debug_type($varValue) . ")" . PHP_EOL;
34        } elseif (is_string($varValue)) {
35            // 文字列の場合、クォートで囲んで表示
36            echo "値: '" . $varValue . "' (型: " . get_debug_type($varValue) . ")" . PHP_EOL;
37        } elseif (is_int($varValue)) {
38            // 整数値の場合、そのまま表示
39            echo "値: " . $varValue . " (型: " . get_debug_type($varValue) . ")" . PHP_EOL;
40        } else {
41            // その他の型は var_export を使って詳細に表示
42            echo "値: " . var_export($varValue, true) . " (型: " . get_debug_type($varValue) . ")" . PHP_EOL;
43        }
44    }
45
46    echo PHP_EOL . "--- スコープに関する補足 ---" . PHP_EOL;
47    echo "この出力には、" . __FUNCTION__ . " 関数内で定義された変数 " . PHP_EOL;
48    echo "(\$userName, \$phpVersion など) が含まれています。" . PHP_EOL;
49    echo "また、PHPが自動的に提供するスーパーグローバル変数 (例: \$_SERVER, \$_GET) も含まれます。" . PHP_EOL;
50    echo "しかし、この関数の外 (グローバルスコープ) で定義された変数は、" . PHP_EOL;
51    echo "この関数内の get_defined_vars() の結果には含まれません。" . PHP_EOL;
52    echo "get_defined_vars() は、それが呼び出された「現在のスコープ」に限定されるためです。" . PHP_EOL;
53}
54
55// グローバルスコープで変数を定義（この変数は demonstrateGetDefinedVars() 内の
56// get_defined_vars() の結果には含まれませんが、存在はしています）
57$globalGreeting = "Hello from the global scope!";
58$globalCount = 42;
59
60// 関数を呼び出して実行
61demonstrateGetDefinedVars();

get_defined_vars() 関数は、PHPのプログラム実行中に、その関数が呼び出された時点の「現在のスコープ」で定義されているすべての変数とその値を連想配列として取得します。この関数に引数はなく、戻り値は変数名がキー、その変数の値がバリューとなる配列です。

このサンプルコードでは、demonstrateGetDefinedVars() 関数内でローカル変数をいくつか定義し、その直後に get_defined_vars() を呼び出しています。これにより、関数内で定義された $userName や $phpVersion といったローカル変数のほか、PHPが自動で提供する $_SERVER や $_GET といったスーパーグローバル変数も取得され、結果として表示されているのがわかります。

重要な点として、関数外のグローバルスコープで定義された $globalGreeting や $globalCount といった変数は、demonstrateGetDefinedVars() 関数内での get_defined_vars() の結果には含まれません。これは、get_defined_vars() があくまで「呼び出された時点のローカルなスコープ」に限定して変数を取得するためです。この関数は、プログラムのデバッグや実行中の変数の確認に役立ちます。

Copy
1<?php
2
3/**
4 * PHPで定義されている定数を一覧表示するサンプルコード。
5 *
6 * この関数は、PHPエンジンや読み込まれた拡張機能によって定義されている
7 * すべての定数を取得し、その名前と値をコンソールに出力します。
8 * システムエンジニアを目指す初心者の方が、PHPの実行環境でどのような定数が
9 * 利用可能かを知るための基本的な例となります。
10 *
11 * @return void
12 */
13function displayDefinedConstantsExample(): void
14{
15    echo "--- PHPで定義されている定数一覧 ---\n";
16
17    // get_defined_constants() 関数は、現在PHPで定義されている全ての定数を配列で返します。
18    // 引数を指定しない場合、定数は「定数名 => 値」の形式で返されます。
19    $constants = get_defined_constants();
20
21    // 取得した定数を一つずつループで処理し、名前と値を出力します。
22    foreach ($constants as $name => $value) {
23        // 定数の値が配列、オブジェクト、またはリソースの場合、直接echoするとエラーになるか、
24        // 意図しない出力になる可能性があるため、型に応じて処理を分けます。
25        if (is_array($value)) {
26            echo "定数名: " . $name . ", 値: (配列)\n";
27        } elseif (is_object($value)) {
28            echo "定数名: " . $name . ", 値: (オブジェクト)\n";
29        } elseif (is_resource($value)) {
30            echo "定数名: " . $name . ", 値: (リソース)\n";
31        } else {
32            // スカラー値（文字列、数値、真偽値、null）はvar_exportで安全に表示します。
33            // var_export(値, true) は、値をPHPの構文で表現した文字列を返します。
34            echo "定数名: " . $name . ", 値: " . var_export($value, true) . "\n";
35        }
36    }
37
38    echo "-----------------------------------\n";
39}
40
41// 関数を実行し、PHPで定義されている定数の一覧を表示します。
42displayDefinedConstantsExample();

このサンプルコードは、PHPで現在定義されているすべての定数を一覧表示する方法を示しています。get_defined_constants()関数は、PHPエンジン自体や読み込まれた拡張機能によって利用可能となっている、様々なシステム定数や環境に関する定数を取得するために使用されます。システムエンジニアを目指す初心者の方にとって、PHPの動作環境を理解するための第一歩として役立ちます。

get_defined_constants()関数は引数を一切取りません。実行すると、定義されているすべての定数を連想配列として返します。この配列では、キーが定数の名前、値がその定数の内容となります。例えば、PHPのバージョン情報を示すPHP_VERSIONなどの定数が含まれます。

サンプルコードでは、まずこの関数で定数一覧を取得し、それを$constants変数に格納しています。その後、foreachループを使って配列の各要素を一つずつ取り出し、定数名とその値をコンソールに出力しています。定数の値が文字列や数値などの単純な型（スカラー値）であればそのまま表示できますが、配列やオブジェクト、リソースといった複雑な型の場合は、直接表示するとエラーになったり、意図しない出力になったりする可能性があるため、型に応じて表示を分けています。特にスカラー値はvar_export()関数を使って、PHPの構文に合わせた形式で安全に出力しています。これにより、PHPの実行環境でどのような定数が利用できるかを確認できます。