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

Copy
1<?php
2
3/**
4 * 指定されたPHPコード文字列を解析し、T_ENCAPSED_AND_WHITESPACE トークンの情報を表示します。
5 *
6 * このトークンは、PHPの字句解析器 (lexer) がコードをトークンに分解する際に生成されます。
7 * 主にダブルクォートで囲まれた文字列（`"`）内部で、変数展開（例: `"Hello, {$name}!"`）がある場合に、
8 * その変数展開以外の部分（例: `"Hello, "` や `"!"`）がこのトークンとして識別されます。
9 *
10 * @param string $phpCode 解析するPHPコード文字列。
11 * @return void
12 */
13function analyzeEncapsedWhitespace(string $phpCode): void
14{
15    echo "--- PHPコードのトークン解析開始 ---\n";
16    echo "対象コード:\n```php\n" . $phpCode . "\n```\n\n";
17
18    // PHPコードをトークンに分解します。
19    // token_get_all() は、PHPスクリプトをトークン配列に変換します。
20    $tokens = token_get_all($phpCode);
21
22    // 各トークンを順番に処理します。
23    foreach ($tokens as $token) {
24        // トークンが配列形式の場合（識別子、キーワード、定数など）に処理します。
25        // 単一文字のトークン（例: '{', ';', '=' など）は文字列として返されます。
26        if (is_array($token)) {
27            $tokenId = $token[0];    // トークンID (例: T_ENCAPSED_AND_WHITESPACE)
28            $tokenValue = $token[1]; // トークンの値 (例: "Hello, ")
29            $tokenLine = $token[2];  // トークンが存在する行番号
30
31            // T_ENCAPSED_AND_WHITESPACE トークンを検出した場合に情報を表示します。
32            if ($tokenId === T_ENCAPSED_AND_WHITESPACE) {
33                echo "検出されたトークン: " . token_name($tokenId) . "\n";
34                echo "  値: '" . $tokenValue . "'\n";
35                echo "  行番号: " . $tokenLine . "\n";
36                echo "  説明: この部分はダブルクォート文字列内の変数展開外の文字列または空白です。\n";
37            }
38        }
39    }
40    echo "\n--- 解析終了 ---\n";
41}
42
43// T_ENCAPSED_AND_WHITESPACE トークンを生成するPHPコードの例を定義します。
44// ダブルクォート文字列内で変数を展開すると、その前後の文字列がこのトークンとして検出されやすくなります。
45$exampleCode = <<<'PHP_SAMPLE_CODE'
46<?php
47$name = "Alice";
48$greeting = "Hello, {$name}!"; // ここで "Hello, " と "!" が T_ENCAPSED_AND_WHITESPACE になります。
49$message = "Welcome to PHP 8!"; // 変数展開がないため、通常 T_CONSTANT_ENCAPSED_STRING になります。
50echo $greeting;
51echo $message;
52?>
53PHP_SAMPLE_CODE;
54
55// 定義した関数を呼び出し、サンプルコードのトークン解析を実行します。
56analyzeEncapsedWhitespace($exampleCode);
57

このサンプルコードは、PHPがどのようにプログラムコードを内部で解析し、小さな部品である「トークン」に分解するかを示しています。特に、T_ENCAPSED_AND_WHITESPACEという特定のトークンに焦点を当てて、その検出方法と役割を解説しています。

T_ENCAPSED_AND_WHITESPACEは、PHPの字句解析器（lexer）がコードをトークンに分解する際に生成されるものです。主に、ダブルクォート（"）で囲まれた文字列内で変数を展開する際（例: "Hello, {$name}!"）に、その変数展開以外の部分（例: "Hello, "や"!"）がこのトークンとして識別されます。

サンプルコード内のanalyzeEncapsedWhitespace関数は、引数として解析したいPHPコード文字列を受け取ります。この関数は、token_get_all()関数を使ってPHPコードをトークンに分解し、配列形式のトークンの中からT_ENCAPSED_AND_WHITESPACEトークンを検出します。そして、検出されたトークンの種類、値、およびコード内の行番号を表示します。この関数には戻り値がありません（void）。

このコードを実行することで、$greeting = "Hello, {$name}!"のような文字列において、「Hello, 」や「!」の部分がT_ENCAPSED_AND_WHITESPACEとして識別される様子を確認できます。これは、PHPが文字列と変数展開を内部でどのように処理しているかを理解するのに役立つ具体的な例です。

Copy
1<?php
2
3/**
4 * PHPコード文字列を解析し、T_ENDIFトークンを検出するサンプル関数。
5 *
6 * T_ENDIFは、PHPのパーサーがコードを解析する際に使用する内部トークン定数の一つで、
7 * "endif;" のような代替構文の制御構造の終了を表します。
8 * システムエンジニアの初心者がPHPの内部トークン定数の存在と使われ方を理解するのに役立ちます。
9 */
10function analyzePhpCodeForT_ENDIF(): void
11{
12    // 解析対象となるPHPコード文字列を用意します。
13    // 'if ... : ... endif;' 構文を含めることで、T_ENDIF トークンが生成されることを示します。
14    $phpCode = <<<'EOD'
15<?php
16$value = 10;
17if ($value > 5) :
18    echo "Value is greater than 5.\n";
19else :
20    echo "Value is not greater than 5.\n";
21endif; // この 'endif;' が T_ENDIF トークンを生成します。
22
23$name = "PHP"; // 変数名や文字列リテラルは T_STRING トークンとして扱われることがあります。
24?>
25EOD;
26
27    echo "--- 解析対象PHPコード --- \n";
28    echo $phpCode;
29    echo "-------------------------- \n\n";
30
31    // T_ENDIF 定数の整数値を確認します。
32    // PHPのトークン定数は、内部的に整数値で表現されます。
33    echo "T_ENDIF 定数の値: " . T_ENDIF . " (整数)\n\n";
34
35    // token_get_all() 関数は、PHPコードを指定されたトークンに分解します。
36    $tokens = token_get_all($phpCode);
37
38    echo "--- トークン解析結果 ---\n";
39    $foundEndif = false;
40    foreach ($tokens as $token) {
41        // token_get_all() の結果は、単一の文字（例: '{', ';') または
42        // 配列形式 (トークンID, 値, 行番号) のどちらかになります。
43        if (is_array($token)) {
44            // トークンIDが T_ENDIF と一致するかどうかを確認します。
45            if ($token[0] === T_ENDIF) {
46                echo "  T_ENDIF トークンを検出しました:\n";
47                echo "    ID: " . $token[0] . " (T_ENDIF)\n";
48                echo "    値: '" . $token[1] . "'\n";
49                echo "    行: " . $token[2] . "\n";
50                $foundEndif = true;
51            }
52        }
53    }
54
55    if (!$foundEndif) {
56        echo "  T_ENDIF トークンは見つかりませんでした。\n";
57    }
58    echo "------------------------\n";
59}
60
61// サンプル関数を実行して結果を表示します。
62analyzePhpCodeForT_ENDIF();
63

T_ENDIFは、PHPのコードを解析する際に内部的に使われるトークン定数の一つで、「endif;」のように代替構文で書かれた制御構造の終了を示すものです。この定数自体に引数はなく、内部的には整数値（int型）として定義されています。

このサンプルコードは、PHPコード文字列からT_ENDIFトークンを検出する方法をシステムエンジニアの初心者に示します。まず、if ... : ... endif;という代替構文を含むPHPコード文字列を用意します。次に、T_ENDIF定数が持つ整数値を確認します。token_get_all()関数を使用すると、与えられたPHPコードを、PHPのパーサーが認識する最小単位である「トークン」の配列に分解できます。この関数が返す配列には、単一の文字（例: ;）と、トークンID、値、行番号を含む配列形式のトークンが混在しています。サンプルコードでは、これらのトークンを一つずつ確認し、トークンIDがT_ENDIFと一致するものがあれば、その詳細（ID、値、行番号）を表示しています。これにより、PHPが内部でどのようにコードを解釈しているかの一端を理解するのに役立ちます。