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

Copy
1<?php
2
3/**
4 * PHPの文字列補間におけるT_ENCAPSED_AND_WHITESPACEトークンの動作を示します。
5 *
6 * この定数はPHPの内部トークナイザーによって使用され、二重引用符で囲まれた
7 * 文字列内で変数ではないリテラルなテキスト部分を識別します。
8 * 例えば、`"$name さん、こんにちは！"` という文字列では、`" さん、こんにちは！"` の部分が
9 * T_ENCAPSED_AND_WHITESPACEとして認識されます。
10 *
11 * この知識は、PHPが文字列をどのように解析するかを理解し、
12 * 文字列補間が意図した通りに機能しない場合のデバッグに役立ちます。
13 *
14 * @return void
15 */
16function demonstrateTokenEncapsulatedAndWhitespace(): void
17{
18    // 分析対象のPHPコードスニペット
19    $codeSnippet = '<?php $username = "Alice"; echo "Hello, $username! Welcome to the system.";';
20
21    echo "--- 分析対象のPHPコードスニペット ---\n";
22    echo $codeSnippet . "\n";
23    echo "------------------------------------\n\n";
24
25    // コードスニペットをPHPの内部トークンに分解します。
26    // token_get_all() は、PHPコードを構文解析するためにPHP自体が使用するトークンの配列を返します。
27    $tokens = token_get_all($codeSnippet);
28
29    echo "--- トークン分析結果 ---\n";
30    foreach ($tokens as $token) {
31        if (is_array($token)) {
32            // 配列形式のトークンは、[トークンID, 値, 行番号] の形式です。
33            $tokenName = token_name($token[0]); // トークンIDから人間が読める名前を取得
34            $tokenValue = $token[1];           // トークンが表す実際の文字列
35            $lineNumber = $token[2];          // トークンが存在するコードの行番号
36
37            // トークン情報を出力
38            echo sprintf("行 %d: %s ('%s')", $lineNumber, $tokenName, $tokenValue);
39
40            // T_ENCAPSED_AND_WHITESPACEトークンを強調表示
41            if ($token[0] === T_ENCAPSED_AND_WHITESPACE) {
42                echo " <-- T_ENCAPSED_AND_WHITESPACE: 二重引用符内の変数ではないリテラル部分";
43            }
44            echo "\n";
45        } else {
46            // 単一文字のトークン（例: ;, {, } など）は、配列ではなく文字列として返されます。
47            echo sprintf("単一文字トークン: '%s'\n", $token);
48        }
49    }
50    echo "------------------------\n";
51}
52
53// 関数を実行して、T_ENCAPSED_AND_WHITESPACEがどのように現れるかを確認します。
54demonstrateTokenEncapsulatedAndWhitespace();
55

PHPのT_ENCAPSED_AND_WHITESPACEは、PHPがソースコードを解析する際に使用する内部的な定数です。これは、二重引用符（ダブルクォート）で囲まれた文字列の中で、変数の値が埋め込まれる（文字列補間）際、変数以外の固定されたテキスト部分を識別するために用いられます。例えば、"$name 様、いらっしゃいませ。"という文字列では、" 様、いらっしゃいませ。"の部分がT_ENCAPSED_AND_WHITESPACEとして扱われます。

この定数は、プログラマーが直接コード内で利用するものではなく、PHPがどのように文字列を解析し、変数を埋め込むかを理解するための手がかりとなります。サンプルコードが示すように、token_get_all()関数を使ってPHPコードをトークンに分解すると、このT_ENCAPSED_AND_WHITESPACEトークンが現れることが確認できます。

文字列補間が意図通りに動作しないといった問題に直面した際に、PHPの内部的な動作を把握することで、より効率的なデバッグやトラブルシューティングが可能になります。この定数には引数はなく、特定の値を返すわけでもありません。PHPの文字列処理の仕組みを深く理解する上で、このトークンの存在を知ることは非常に有益です。