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

Copy
1<?php
2
3/**
4 * PHPのトークン解析の基本的な例を示します。
5 * ソースコードがどのように小さな構成要素（トークン）に分解されるか、
6 * 特に結合代入演算子 (T_CONCAT_EQUAL) と文字列リテラル (T_CONSTANT_ENCAPSED_STRING) に焦点を当てて説明します。
7 */
8function demonstrateTokenAnalysis(): void
9{
10    // 解析対象のPHPコード文字列
11    // ここには T_CONCAT_EQUAL (結合代入演算子 . =) と
12    // T_CONSTANT_ENCAPSED_STRING (二重引用符または単一引用符で囲まれた文字列) が含まれます。
13    $code = <<<'PHP_CODE'
14<?php
15$name = 'PHP'; // T_CONSTANT_ENCAPSED_STRING (シングルクォート文字列)
16$message = "Hello, "; // T_CONSTANT_ENCAPSED_STRING (ダブルクォート文字列)
17$message .= $name . "!"; // T_CONCAT_EQUAL (結合代入演算子)
18echo $message;
19?>
20PHP_CODE;
21
22    echo "--- 解析対象コード ---" . PHP_EOL;
23    echo $code . PHP_EOL;
24    echo "--- トークン解析結果 ---" . PHP_EOL;
25    echo "行: コード中の行番号, ID: トークンIDの正式名称, 値: トークンが表す実際の文字列" . PHP_EOL . PHP_EOL;
26
27    // token_get_all() 関数でPHPコードをトークンに分解します。
28    // 各トークンは配列 ([トークンID, トークン値, 行番号]) または単一の文字列 (句読点や演算子など) として返されます。
29    $tokens = token_get_all($code);
30
31    foreach ($tokens as $token) {
32        if (is_array($token)) {
33            // 配列形式のトークン: [トークンID (int), トークン値 (string), 行番号 (int)]
34            $tokenName = token_name($token[0]); // トークンID (数値) を人間が読める名前に変換
35            $tokenValue = $token[1];
36            $lineNumber = $token[2];
37
38            printf(
39                "行 %-4d | ID: %-28s | 値: %s\n",
40                $lineNumber,
41                $tokenName,
42                json_encode($tokenValue) // 文字列が適切に表示されるようにエスケープ
43            );
44
45            // 特定のトークンに対する補足説明
46            if ($token[0] === T_CONCAT_EQUAL) {
47                echo "    ↑ この \".=\" が T_CONCAT_EQUAL トークンです。文字列の結合と代入を行います。\n";
48            } elseif ($token[0] === T_CONSTANT_ENCAPSED_STRING) {
49                echo "    ↑ この文字列リテラルが T_CONSTANT_ENCAPSED_STRING トークンです。\n";
50            }
51        } else {
52            // 単一文字列形式のトークン: セミコロン (;) や括弧 (() など
53            // これらのトークンは、その文字自体がトークンとなります。
54            // token_get_all の仕様上、単一文字トークンには行番号が直接付属しない場合があります。
55            printf(
56                "行 %-4s | ID: %-28s | 値: %s\n",
57                'N/A', // 行番号はN/Aとして表示
58                'T_SYMBOL', // 便宜上 'T_SYMBOL' と表示
59                json_encode($token)
60            );
61        }
62    }
63}
64
65// 関数を実行して、トークン解析のデモンストレーションを開始します。
66demonstrateTokenAnalysis();

このサンプルコードは、PHPのソースコードがどのように小さな構成要素（トークン）に分解されるかを示すものです。特に、文字列の結合と代入を行う演算子である.=が表すT_CONCAT_EQUALトークンと、シングルクォートまたはダブルクォートで囲まれた文字列リテラルが表すT_CONSTANT_ENCAPSED_STRINGトークンに焦点を当てて説明しています。

コード内では、token_get_all()関数を使用してPHPコード文字列をトークンの配列に分解しています。この関数は、PHPの構文解析器がコードを解釈する前段階で利用するもので、各トークンは数値ID、値、行番号を含む配列、または単一の文字列（例えばセミコロンなど）として返されます。

T_CONCAT_EQUALは、PHPの構文解析におけるトークンとして定義されている定数で、結合代入演算子.=のトークンIDを示す整数値です。この定数自体には引数はなく、常に整数値を返します。サンプルコードでは、.=演算子が出現すると、このT_CONCAT_EQUALとして識別されます。T_CONSTANT_ENCAPSED_STRINGは、ソースコード中の'PHP'や"Hello, "のような文字列リテラルを指し、これもトークン解析時に特定されます。

出力結果では、元のコードがトークンごとに分解され、各トークンの行番号、token_name()関数で変換されたトークンIDの正式名称、そして実際の値が表示されます。これにより、初心者の方でもPHPがコードをどのように「理解」しているかの基礎的な部分を視覚的に把握できるでしょう。

Copy
1<?php
2
3/**
4 * 指定されたPHPコードをトークンに分解し、特定のトークンを検出して表示します。
5 * システムエンジニアを目指す初心者向けに、PHPのコードが内部でどのように解釈されるかを理解するための一例です。
6 *
7 * @param string $code 解析対象のPHPコード文字列。
8 */
9function analyzePhpCodeTokens(string $code): void
10{
11    echo "--- 解析対象のPHPコード ---\n";
12    echo $code . "\n";
13    echo "--------------------------\n\n";
14
15    // token_get_all() 関数は、PHPソースコードをその構成要素（トークン）の配列に分解します。
16    // 各トークンは、その種類（定数名）、値、行番号を含む配列、または単一文字の文字列として返されます。
17    $tokens = token_get_all($code);
18
19    echo "--- 検出されたトークン --- \n";
20
21    foreach ($tokens as $token) {
22        if (is_array($token)) {
23            // トークンが配列の場合、要素は [トークンID, トークン値, 行番号]
24            $tokenName = token_name($token[0]); // トークンIDを人間が読める名前に変換
25            $tokenValue = $token[1];
26            $lineNumber = $token[2];
27
28            echo "行 " . $lineNumber . ": " . $tokenName . " ('" . $tokenValue . "')";
29
30            // T_CONCAT_EQUAL の検出: 文字列結合代入演算子 (.=) を表します。
31            if ($token[0] === T_CONCAT_EQUAL) {
32                echo "  <-- ここに文字列結合代入演算子 (.=) があります！";
33            }
34            // T_COMMENT の検出: コメント (//, #, /* ... */) を表します。
35            if ($token[0] === T_COMMENT) {
36                echo "  <-- ここにコメントがあります！";
37            }
38            echo "\n";
39        } else {
40            // トークンが単一文字の文字列の場合 (例: ;, {, }, = など)
41            echo "シンボル: '" . $token . "'\n";
42        }
43    }
44    echo "--------------------------\n";
45}
46
47// 解析するPHPコードの例を用意します。
48// このコードには、T_CONCAT_EQUAL (.=) と T_COMMENT (コメント) の両方が含まれています。
49$sampleCode = <<<'EOD'
50<?php
51declare(strict_types=1);
52
53$message = "Hello"; // 初期メッセージを定義
54
55// $message に文字列 " World!" を結合し、結果を $message に再代入
56// ここに T_CONCAT_EQUAL (文字列結合代入演算子 .=) があります
57$message .= " World!";
58
59/*
60 * これは
61 * 複数行のコメントです。
62 * T_COMMENT トークンとして認識されます。
63 */
64
65echo $message . "\n"; // 結果を出力する行
66# 別のコメント形式もT_COMMENTとして扱われます
67EOD;
68
69// 定義した関数を呼び出し、サンプルコードを解析します。
70analyzePhpCodeTokens($sampleCode);

このサンプルコードは、PHPプログラムが内部でどのように解釈されるか、その過程の一部をシステムエンジニアを目指す初心者の方に理解していただくための一例です。

analyzePhpCodeTokens関数は、解析対象のPHPコード文字列を引数（$code）として受け取り、そのコードを「トークン」と呼ばれる小さな構成要素に分解します。この関数は、処理結果を直接画面に出力するため、特定の戻り値は持ちません（void）。内部ではtoken_get_all()関数を使用し、PHPコードを、その種類（トークンID）、値、行番号を含む配列のリストに変換します。

T_CONCAT_EQUALは、PHPの文字列結合代入演算子である「.=」を表す整数値の定数です。一方、T_COMMENTは、PHPコード内の「//」、「#」、または「/* ... */」といったコメント部分を表す整数値の定数となります。サンプルコードでは、分解されたトークンを一つずつ確認し、特にT_CONCAT_EQUALやT_COMMENTが見つかった場合に、それがどのようなトークンであるかを具体的に表示します。これにより、文字列結合演算子やコメントといったPHPの基本的な構文が、PHPの内部でどのように区別され、認識されているかを視覚的に確認できます。