【PHP8.x】get_defined_constants関数の使い方

<?php

/**
 * PHPのget_defined_constants関数の使用例。
 * この関数は、現在定義されている全ての定数を配列として返します。
 * 引数によって、定数をカテゴリ別に分類して取得することも可能です。
 */

// ユーザー定義の定数をいくつか作成します
define('MY_APP_VERSION', '1.0.0');
define('DEBUG_MODE', true);
const MAX_ITEMS = 100; // constキーワードでも定数を定義できます

echo "--- カテゴリ分けなしで全ての定数を取得 (get_defined_constants()) ---\n";
// get_defined_constants() を引数なしで呼び出すと、全ての定数がフラットな配列で返されます
// キーが定数名、値が定数の値となります
$allConstants = get_defined_constants();
print_r($allConstants);
// 出力は非常に長くなるため、一部の定数だけ確認することも可能です
// echo "\n[MY_APP_VERSION]: " . $allConstants['MY_APP_VERSION'] . "\n";
// echo "[DEBUG_MODE]: " . ($allConstants['DEBUG_MODE'] ? 'true' : 'false') . "\n";
// echo "[MAX_ITEMS]: " . $allConstants['MAX_ITEMS'] . "\n";


echo "\n--- カテゴリ分けして全ての定数を取得 (get_defined_constants(true)) ---\n";
// get_defined_constants(true) を呼び出すと、定数がその所属カテゴリ（例: "Core", "pcre", "user" など）
// ごとに分類された連想配列として返されます。
// "user" カテゴリには、ユーザーが定義した定数が含まれます。
$categorizedConstants = get_defined_constants(true);
print_r($categorizedConstants);
// カテゴリ別にアクセスする例
// echo "\n[User Defined Constants]:\n";
// print_r($categorizedConstants['user']);

echo "\n--- ユーザー定義定数のみにアクセスする例 ---\n";
if (isset($categorizedConstants['user'])) {
    print_r($categorizedConstants['user']);
} else {
    echo "ユーザー定義定数はありません。\n";
}

?>

PHPのget_defined_constants関数は、現在PHPスクリプト内で定義されている全ての定数を配列として取得する際に使用します。この関数は、プログラムの実行中にどのような定数が利用可能かを確認したい場合に役立ちます。

引数$categorizeには真偽値（trueまたはfalse）を指定でき、デフォルトはfalseです。 $categorizeにfalseを指定するか、引数なしで呼び出した場合、戻り値は定数名がキー、その値が要素となるフラットな連想配列になります。例えば、define()やconstキーワードで定義したユーザー定義定数、およびPHP自身が提供する組み込み定数などが全て含まれます。

一方、$categorizeにtrueを指定して呼び出すと、戻り値は定数がその所属するカテゴリ（例えば、PHPのコア定数、特定の拡張モジュールによる定数、そしてユーザーが定義した定数は'user'カテゴリ）ごとに分類された多次元連想配列になります。これにより、特定の種類の定数に絞ってアクセスしたい場合に便利です。例えば、$categorizedConstants['user']とすることで、自分で定義した定数のみを簡単に取得できます。戻り値は常にarray型です。

<?php

/**
 * ユーザー定義の定数をいくつか定義します。
 * 定数は、`define()` または `const` キーワードで定義できます。
 */
define('APP_NAME', 'MyAwesomeApp');
const APP_VERSION = '1.0.0';
define('DEBUG_MODE', true);
const MAX_ITEMS_PER_PAGE = 20;

/**
 * 現在定義されているユーザー定義の定数を取得し、表示する関数です。
 * get_defined_constants() 関数を使用して、定数をカテゴリ別に取得します。
 */
function displayUserDefinedConstants(): void
{
    // get_defined_constants(true) を呼び出し、定数をカテゴリ別に取得します。
    // これにより、定数は 'internal'（PHP内部）や 'user'（ユーザー定義）などのカテゴリに分類されます。
    $allConstants = get_defined_constants(true);

    // 'user' カテゴリに定義されている定数のみを抽出します。
    // PHP 8.4.12では、null合体演算子 (??) を使用して安全にアクセスできます。
    $userConstants = $allConstants['user'] ?? [];

    echo "=== ユーザー定義の定数一覧 ===\n";

    if (empty($userConstants)) {
        echo "現在、ユーザー定義の定数はありません。\n";
    } else {
        foreach ($userConstants as $name => $value) {
            echo "定数名: " . $name . ", 値: ";
            // 定数の値に応じて表示を調整し、見やすくします。
            if (is_bool($value)) {
                echo ($value ? 'true' : 'false') . "\n";
            } elseif (is_string($value)) {
                echo "'" . $value . "'\n";
            } elseif (is_scalar($value)) { // 数値なども含むスカラー値
                echo $value . "\n";
            } else {
                echo gettype($value) . " (非表示)\n"; // スカラー値以外は型のみ表示
            }
        }
    }
}

// 関数を実行して、定義されているユーザー定義の定数を表示します。
displayUserDefinedConstants();

PHPのget_defined_constants関数は、現在定義されているすべての定数を取得するために使用されます。この関数は、プログラム内で利用可能な定数を一覧表示したり、特定の定数の存在を確認したりする際に役立ちます。

引数$categorizeはbool型で、デフォルト値はfalseです。この引数にtrueを渡すと、戻り値の配列は定数の定義元に基づいてカテゴリ分けされます。具体的には、PHP内部で定義されている定数はinternalカテゴリに、ユーザーがdefine()関数やconstキーワードで定義した定数はuserカテゴリに分類されます。falseの場合は、すべての定数がカテゴリ分けされずに一つのフラットな配列として返されます。

戻り値はarray型で、定数名とそれに対応する値のペアが含まれます。$categorizeがtrueの場合、配列のキーはカテゴリ名（例: 'user'）となり、その値としてカテゴリ内の定数配列が格納されます。

サンプルコードでは、まずdefine()とconstキーワードを使ってユーザー定義の定数をいくつか設定しています。次に、displayUserDefinedConstants関数内でget_defined_constants(true)を呼び出し、定数をカテゴリ別に取得しています。これにより、$allConstants['user']としてユーザー定義の定数のみを安全に抽出できます。抽出された定数はループ処理で一つずつ取り出され、定数名とその値が整形されて表示されます。特に、値が真偽値や文字列の場合に分かりやすく表示されるよう調整されています。