【PHP8.x】T_CONST定数の使い方

Copy
1<?php
2
3/**
4 * PHPのトークン解析を使用して、`const`キーワードと文字列定数のトークンを識別するサンプル。
5 *
6 * この関数は、指定されたPHPコードスニペットを解析し、
7 * `T_CONST` (constキーワード) および `T_CONSTANT_ENCAPSED_STRING` (囲まれた文字列定数)
8 * のトークンタイプを特定し、その情報を表示します。
9 * `token_get_all()` 関数は、PHPのソースコードを個々の「トークン」の配列に分割します。
10 * 各トークンは、PHPがコードをどのように解釈するかを示します。
11 *
12 * @param string $phpCodeSnippet 解析するPHPコードスニペット。
13 */
14function demonstrateConstantTokens(string $phpCodeSnippet): void
15{
16    // token_get_all() はPHPコードをトークンの配列に分解します。
17    // 各トークンは、[トークンID (T_*), 文字列値, 行番号] の配列、
18    // または単一文字（例: '=', ';'）の文字列として表現されます。
19    // 解析を正しく行うため、スニペットの先頭に `<?php ` を追加します。
20    $tokens = token_get_all("<?php " . $phpCodeSnippet);
21
22    echo "--- トークン解析結果 ---" . PHP_EOL;
23    echo "対象コード:\n" . $phpCodeSnippet . PHP_EOL;
24    echo "----------------------" . PHP_EOL;
25
26    foreach ($tokens as $token) {
27        // トークンが配列形式の場合（つまり、PHPのキーワードや定数、変数など）
28        if (is_array($token)) {
29            $tokenId = $token[0];    // トークンの内部ID（例: T_CONST, T_STRING など）
30            $tokenValue = $token[1]; // トークンの実際の文字列（例: 'const', '"Hello"' など）
31            $tokenName = token_name($tokenId); // トークンIDに対応する人間が読める名前
32
33            // T_CONST は 'const' キーワード自体を表します。
34            if ($tokenId === T_CONST) {
35                echo "[T_CONST] 'const' キーワードが見つかりました: '" . $tokenValue . "' (ID: " . $tokenId . ", 名前: " . $tokenName . ")" . PHP_EOL;
36            }
37            // T_CONSTANT_ENCAPSED_STRING は、文字列リテラル（ダブルクォートやシングルクォートで囲まれた文字列）を表します。
38            // これには、定数定義の一部としての文字列や、通常の文字列変数が含まれます。
39            elseif ($tokenId === T_CONSTANT_ENCAPSED_STRING) {
40                echo "[T_CONSTANT_ENCAPSED_STRING] 囲まれた文字列定数が見つかりました: '" . $tokenValue . "' (ID: " . $tokenId . ", 名前: " . $tokenName . ")" . PHP_EOL;
41            }
42            // その他の主要なトークンも表示すると、コードの流れがより理解しやすくなります
43            // （例: T_STRING は変数名や関数名、定数名など）
44            elseif ($tokenId === T_STRING) {
45                echo "[T_STRING] 識別子/名前が見つかりました: '" . $tokenValue . "' (ID: " . $tokenId . ", 名前: " . $tokenName . ")" . PHP_EOL;
46            }
47        } else {
48            // トークンが単一文字の場合（例: '=', ';', '(', ')' など）
49            // echo "[単一文字] '" . $token . "'" . PHP_EOL;
50        }
51    }
52    echo "----------------------" . PHP_EOL;
53}
54
55// 解析対象となるPHPコードスニペットを定義します。
56// ここでは、`const`キーワードと文字列定数を含む簡単な定義を使用します。
57$codeToAnalyze = <<<PHP_CODE
58const APP_NAME = "My Application";
59const APP_VERSION = '1.0.0';
60const DEFAULT_LIMIT = 50; // 数値はT_LNUMBERとして扱われます
61PHP_CODE;
62
63// 関数を実行して、コードスニペット内のトークンを分析します。
64demonstrateConstantTokens($codeToAnalyze);
65

このPHPサンプルコードは、PHPのトークン解析機能を利用して、ソースコード内の特定の要素を識別する方法を示しています。demonstrateConstantTokens関数は、引数として渡されたPHPコードスニペットを解析し、constキーワードや文字列定数といった特定のコード要素を見つけ出します。

この関数は、token_get_all()関数を使用してPHPコードを個々の「トークン」の配列に分解します。各トークンは、PHPがコードを解釈する上での基本的な構成要素（キーワード、文字列、演算子など）を表しています。解析されたトークンの中で、T_CONSTは「const」というキーワード自体を識別し、T_CONSTANT_ENCAPSED_STRINGはシングルクォートやダブルクォートで囲まれた文字列リテラル（文字列定数）を識別します。例えば、const APP_NAME = "My Application";というコードでは、「const」がT_CONSTとして、「"My Application"」がT_CONSTANT_ENCAPSED_STRINGとして検出されます。

demonstrateConstantTokens関数は、解析したいコードをstring $phpCodeSnippetとして受け取りますが、特定の戻り値は持ちません（void）。関数を実行すると、対象コードスニペットからこれらのトークンが見つかった場合に、その種類や値、内部IDがコンソールに表示され、PHPがどのようにコードを認識しているかを理解するのに役立ちます。