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

Copy
1<?php
2
3/**
4 * PHPコード文字列から、シングルクォートまたはダブルクォートで囲まれた
5 * 定数文字列リテラル（T_CONSTANT_ENCAPSED_STRING）を検索し表示します。
6 *
7 * T_CONSTANT_ENCAPSED_STRING は、PHPの字句解析器がソースコードをトークンに分解する際に、
8 * シングルクォートまたはダブルクォートで囲まれた固定の文字列値に対して割り当てるトークンIDです。
9 * これを理解することで、PHPがどのようにコードを内部的に解釈しているかの一端を知ることができます。
10 *
11 * @param string $phpCode 解析対象のPHPコード文字列。
12 */
13function findConstantEncapsulatedStrings(string $phpCode): void
14{
15    echo "--- 解析対象のPHPコード ---\n";
16    echo $phpCode . "\n";
17    echo "--------------------------\n\n";
18
19    // token_get_all() は、PHPコードをトークンの配列に変換します。
20    // 各トークンは、[トークンID, トークン値, 行番号] の配列、
21    // または単一の文字（例: ;, (, { など、トークンIDを持たない構文要素）です。
22    $tokens = token_get_all($phpCode);
23
24    echo "検出された定数文字列リテラル (T_CONSTANT_ENCAPSED_STRING):\n";
25    foreach ($tokens as $token) {
26        // トークンが配列形式（[ID, 値, 行番号]）であるかを確認します。
27        // 単一文字のトークン（例: '{', ';'）は文字列として返されます。
28        if (is_array($token)) {
29            // トークンIDが T_CONSTANT_ENCAPSED_STRING であるかを確認します。
30            if ($token[0] === T_CONSTANT_ENCAPSED_STRING) {
31                // $token[1] には文字列リテラルの値が含まれています。
32                echo "- " . $token[1] . "\n";
33            }
34        }
35    }
36}
37
38// PHPコードのサンプル。
39// ここでは、様々なシングルクォートとダブルクォートで囲まれた文字列リテラルを含めています。
40$samplePhpCode = <<<'PHP_CODE'
41<?php
42// PHPスクリプト開始
43
44$greeting = "Hello, world!"; // ダブルクォートで囲まれた文字列
45$name = 'PHP User';         // シングルクォートで囲まれた文字列
46
47// 複数の文字列リテラルを含む行
48echo "Welcome, " . $name . "! Version " . '8.0' . "\n"; 
49
50// 空文字列も検出されます
51$empty = "";
52$anotherEmpty = '';
53
54// 数字の文字列リテラル
55$numberAsString = "12345";
56
57// こちらは文字列リテラルではありません（数値リテラルや定数名です）
58$versionNumber = 8.0;
59define('APP_NAME', 'My Application');
60
61?>
62PHP_CODE;
63
64// 定数文字列リテラルを検索する関数を実行します。
65findConstantEncapsulatedStrings($samplePhpCode);
66
67?>

このサンプルコードは、指定されたPHPコード文字列の中から、シングルクォートまたはダブルクォートで囲まれた「定数文字列リテラル」を検索し、表示するものです。T_CONSTANT_ENCAPSED_STRINGとは、PHPの内部処理において、ソースコードが字句解析される際に、これらの固定の文字列値に割り当てられる特別な識別子（トークンID）を指します。これは、PHPがコードをどのように認識しているかを理解する上で重要な要素です。

findConstantEncapsulatedStrings関数は、解析対象のPHPコード文字列を$phpCode引数として受け取ります。この関数は、PHP標準のtoken_get_all()関数を利用して、与えられたPHPコードを小さな単位（トークン）の配列に分解します。その後、分解された各トークンを一つずつ確認し、そのトークンIDがT_CONSTANT_ENCAPSED_STRINGである場合に、その文字列リテラルの内容を画面に出力します。関数の戻り値はvoidとなっており、処理結果を関数から直接返すのではなく、画面に表示する形で完結します。このコードを通じて、PHPがプログラム中の文字列をどのように識別し、内部的に処理しているかという仕組みの一端を学ぶことができます。