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

Copy
1<?php
2
3/**
4 * T_ENCAPSED_AND_WHITESPACE は、PHPの内部的なトークナイザー定数です。
5 * ダブルクォーテーションで囲まれた文字列（例: "Hello $name"）内で、
6 * 変数展開されない純粋なテキスト部分や空白文字を表すために使用されます。
7 * 主にPHPコードを解析するツール（リンター、IDE、静的解析ツールなど）によって利用されます。
8 * この定数の値は整数型です。
9 */
10function demonstrateEncapsedAndWhitespaceConstant(): void
11{
12    // T_ENCAPSED_AND_WHITESPACE の動作を観察するため、
13    // 変数展開を含むダブルクォーテーション文字列を含む簡単なPHPコードを用意します。
14    $codeSnippet = '<?php $greeting = "Hello $user, welcome!";';
15
16    echo "--- 解析対象のPHPコード ---" . PHP_EOL;
17    echo $codeSnippet . PHP_EOL;
18    echo "-------------------------" . PHP_EOL . PHP_EOL;
19
20    echo "--- トークン解析結果 ---" . PHP_EOL;
21
22    // token_get_all() 関数は、与えられたPHPコードをその構成要素（トークン）に分解します。
23    // 各トークンは通常、配列形式で返され、以下の情報を含みます:
24    // [0]: トークンID (T_xxx定数, 整数)
25    // [1]: トークンに対応する元の文字列
26    // [2]: トークンがコード内で出現する行番号
27    $tokens = token_get_all($codeSnippet);
28
29    foreach ($tokens as $token) {
30        if (is_array($token)) {
31            // トークンが配列の場合（T_xxx定数に対応するPHPの言語要素）
32            $tokenName = token_name($token[0]); // トークンIDから人間が読める名前を取得
33
34            $isEncapsed = ($token[0] === T_ENCAPSED_AND_WHITESPACE);
35            echo sprintf(
36                "  - ID: %s (%d), 値: '%s', 行: %d%s",
37                $tokenName,
38                $token[0],
39                $token[1],
40                $token[2],
41                ($isEncapsed ? " <-- ここで T_ENCAPSED_AND_WHITESPACE を検出" : "")
42            ) . PHP_EOL;
43        } else {
44            // トークンが単一の文字列の場合（例: "=", ";", "$" などの単一文字の演算子や区切り文字）
45            echo sprintf("  - ID: 文字列, 値: '%s'", $token) . PHP_EOL;
46        }
47    }
48    echo "-------------------------" . PHP_EOL;
49}
50
51// 関数を実行して T_ENCAPSED_AND_WHITESPACE 定数の動作を確認します。
52demonstrateEncapsedAndWhitespaceConstant();

PHPのT_ENCAPSED_AND_WHITESPACEは、ダブルクォーテーションで囲まれた文字列内で、変数展開されない純粋なテキスト部分や空白文字を識別するための内部的な定数です。これは主に、"Hello $name, welcome!"のように変数を含む文字列リテラルにおいて、"Hello "や, welcome!"といった、変数$name以外の静的なテキスト部分を特定するために使われます。この定数自体は引数を取らず、その値は整数型で表現されます。PHPのコードを解析するリンターや統合開発環境（IDE）、静的解析ツールなどが、コードの正確な構造を理解する際に内部的に利用するものです。

提供されたサンプルコードは、token_get_all()関数を用いてPHPコードをその構成要素であるトークンに分解し、T_ENCAPSED_AND_WHITESPACEがどこで検出されるかを示すものです。コードスニペット$greeting = "Hello $user, welcome!";を解析することで、"Hello "や, welcome!"の部分がT_ENCAPSED_AND_WHITESPACEとして認識される様子を具体的に確認できます。このようにPHPが文字列リテラルを内部的にどのように処理しているかを理解することは、将来的にPHPの高度な解析ツール開発やデバッグを行う上で役立つ知識となります。

Copy
1<?php
2
3/**
4 * PHPコードを解析し、そのトークン情報を表示します。
5 * 特にキーワードであるT_CONSTANT_ENCAPSED_STRINGトークンを強調して表示します。
6 *
7 * @param string $phpCode 解析対象のPHPコード文字列。
8 */
9function analyzePhpTokens(string $phpCode): void
10{
11    // token_get_all() 関数は、PHPコードをPHPの言語トークン（要素）の配列に分解します。
12    // 各トークンは、その種類（ID）、値、コード上の行番号を含む配列、
13    // または単一文字の記号（例: '{', ';', '='）の場合は文字列として返されます。
14    $tokens = token_get_all($phpCode);
15
16    echo "--- PHP コードトークン解析 ---" . PHP_EOL;
17    echo "対象コード:\n```php\n{$phpCode}\n```\n" . PHP_EOL;
18    echo "検出されたトークン:\n";
19
20    foreach ($tokens as $token) {
21        if (is_array($token)) {
22            // トークンが配列の場合、その詳細情報を取り出します。
23            $tokenId = $token[0];    // トークンの内部的な数値ID
24            $tokenValue = $token[1]; // トークンの実際の文字列値
25            $lineNumber = $token[2]; // コード内でのトークンの行番号
26            $tokenName = token_name($tokenId); // トークンIDに対応する名前（例: T_VARIABLE, T_STRINGなど）
27
28            // T_CONSTANT_ENCAPSED_STRING は主にシングルクォートで囲まれた文字列リテラルを表します。
29            // 例えば、'$name = \'John\';' の 'John' がこれに該当します。
30            if ($tokenId === T_CONSTANT_ENCAPSED_STRING) {
31                echo sprintf(
32                    "  [行 %d] %s (T_CONSTANT_ENCAPSED_STRING): '%s' <-- キーワードに該当する文字列です！\n",
33                    $lineNumber,
34                    $tokenName,
35                    $tokenValue
36                );
37            }
38            // ダブルクォートで囲まれた文字列リテラルは、変数展開の有無によって
39            // T_ENCAPSED_AND_WHITESPACE などの異なるトークンに分解されることが多いです。
40            elseif ($tokenId === T_ENCAPSED_AND_WHITESPACE) {
41                echo sprintf(
42                    "  [行 %d] %s: '%s' (ダブルクォート文字列の一部)\n",
43                    $lineNumber,
44                    $tokenName,
45                    $tokenValue
46                );
47            }
48            // T_ENDDECLAREもPHPの内部的なトークン定数ですが、
49            // token_get_all() でPHPコードから直接検出されることは稀です。
50            // 主にPHPパーサーがdeclare文の終端を内部的に識別するために使われます。
51            else {
52                // その他のトークンも表示します。
53                echo sprintf(
54                    "  [行 %d] %s: '%s'\n",
55                    $lineNumber,
56                    $tokenName,
57                    $tokenValue
58                );
59            }
60        } else {
61            // トークンが文字列の場合、それは単一文字の記号（例: '{', ';', '='）です。
62            echo sprintf("  [シンボル] '%s'\n", $token);
63        }
64    }
65    echo PHP_EOL;
66}
67
68// 解析対象となるサンプルPHPコードを定義します。
69// シングルクォート文字列、ダブルクォート文字列、declare文を含めます。
70$sampleCode = <<<'EOC'
71<?php
72
73declare(strict_types=1); // PHPのdeclare文の例
74
75$productName = 'AwesomeGadget'; // T_CONSTANT_ENCAPSED_STRING の典型的な例
76$version = "1.0.0"; // ダブルクォート文字列（変数展開なし）
77$greeting = "Hello, welcome to {$productName} v{$version}!"; // 変数展開を含むダブルクォート文字列
78
79echo $greeting;
80EOC;
81
82// 上記のサンプルコードを解析する関数を実行します。
83analyzePhpTokens($sampleCode);

このサンプルコードは、token_get_all()関数を使用してPHPコードを構成する各要素（トークン）に分解し、その詳細を表示するものです。特に、シングルクォートで囲まれた文字列リテラルを表すT_CONSTANT_ENCAPSED_STRINGトークンに注目し、その検出を強調して示しています。これは、プログラム内で固定の文字列値を扱う際によく使われる表現です。

一方、T_ENDDECLAREはPHPの内部的な定数で、declare文の終端をPHPエンジンが識別するために用いられます。この定数は引数を取らず、整数値（int）を返しますが、token_get_all()関数でPHPコードから直接検出されることは稀で、主にPHPのコンパイル時に内部的に使用されるものです。このコードは、PHPがどのようにコードを解析し、異なる種類の要素を識別しているかを学ぶための良い例となります。