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

Copy
1<?php
2
3/**
4 * PHPコードを解析し、特定のトークン定数に対応する要素を識別する関数です。
5 * システムエンジニアを目指す初心者向けに、PHPが内部でコードをどのように解釈（トークン化）しているかを示します。
6 *
7 * この例では、特に以下のトークン定数に注目します:
8 * - T_SR: 右シフト演算子 (>>) を表すトークンID。
9 * - T_STRING: 識別子 (変数名、関数名、クラス名など) を表すトークンID。
10 */
11function analyzePhpCodeTokens(): void
12{
13    // 解析対象のPHPコード文字列を定義します。
14    // T_SR (>>) と T_STRING (識別子: $originalValue, $shiftedValue, calculateShift) の両方を含んでいます。
15    $codeToAnalyze = <<<'EOD'
16<?php
17// T_STRING: originalValue
18$originalValue = 256;
19
20/**
21 * 指定された値を右シフト演算子 (>>) を用いてシフトする関数です。
22 * T_STRING: calculateShift, value, shiftAmount
23 */
24function calculateShift(int $value, int $shiftAmount): int
25{
26    // T_SR: >>
27    return $value >> $shiftAmount;
28}
29
30// T_STRING: shiftedValue
31$shiftedValue = calculateShift($originalValue, 4);
32
33echo "元の値: " . $originalValue . PHP_EOL;
34echo "右シフト後の値 (4ビット): " . $shiftedValue . PHP_EOL;
35?>
36EOD;
37
38    echo "--- PHP コードのトークン解析開始 ---" . PHP_EOL;
39    echo "解析対象コード:\n" . $codeToAnalyze . PHP_EOL . PHP_EOL;
40
41    // token_get_all() 関数は、PHPコードをその構成要素（トークン）に分解します。
42    // 各トークンは、その種類、値、および行番号を含む配列として、または単一文字トークンの場合は文字列として返されます。
43    $tokens = token_get_all($codeToAnalyze);
44
45    echo "検出されたトークン一覧:" . PHP_EOL;
46    foreach ($tokens as $token) {
47        if (is_array($token)) {
48            // トークンが配列形式の場合: [トークンID, トークン文字列, 行番号]
49            $tokenName = token_name($token[0]); // トークンIDを人間が読める名前に変換
50            $tokenValue = $token[1];             // トークンの実際の文字列値
51            $lineNumber = $token[2];             // トークンが出現した行番号
52
53            echo sprintf("  [行 %-3d] ID: %-20s 値: \"%s\"", $lineNumber, $tokenName, $tokenValue);
54
55            // 特定のトークンID（T_SR または T_STRING）に一致するかを確認し、強調表示します。
56            if ($token[0] === T_SR) {
57                echo " <-- T_SR (右シフト演算子)";
58            } elseif ($token[0] === T_STRING) {
59                echo " <-- T_STRING (識別子)";
60            }
61            echo PHP_EOL;
62        } else {
63            // トークンが単一文字の場合（例: '{', '}', ';', '=' など）は文字列として扱われます。
64            echo sprintf("  [不明な行] ID: N/A                  値: \"%s\"", $token) . PHP_EOL;
65        }
66    }
67
68    echo PHP_EOL . "--- トークン解析完了 ---" . PHP_EOL;
69}
70
71// 関数を実行してトークン解析のデモンストレーションを開始します。
72analyzePhpCodeTokens();

このPHPコードは、PHPが内部でソースコードをどのように解釈（トークン化）しているかをシステムエンジニアを目指す初心者の方に示します。具体的には、token_get_all()関数を使用してPHPコード文字列を構成要素である「トークン」に分解し、それぞれのトークンの種類と値を識別します。

ここで注目するのは、PHPの言語仕様で定義された特定のトークン定数です。T_SRは右シフト演算子（>>）を表すトークンIDで、このサンプルコードでは数値のビットシフト処理部分で検出されます。T_STRINGは、変数名、関数名、クラス名といった「識別子」を表すトークンIDです。例えば、$originalValueやcalculateShiftなどがこれに該当します。

token_get_all()関数は、与えられたPHPコードを解析し、各トークンをその種類（ID）、値、出現行番号を含む配列として返します。単一文字の演算子などは直接その文字が返されます。このサンプルコードの出力は、指定したPHPコード内のすべてのトークンを列挙し、T_SRとT_STRINGに該当するトークンを特に強調して表示します。T_SRは内部的な定数であり、引数や戻り値は持ちません。この解析を通じて、PHPがコードを理解する基本的な仕組みを学ぶことができます。

Copy
1<?php
2
3/**
4 * 指定されたPHPコード文字列をトークンに分解し、各トークンの詳細を表示します。
5 * T_SR (右シフト演算子) や T_VARIABLE (変数) など、PHPがコードをどのように
6 * 解析するかの一例をシステムエンジニアを目指す初心者に示します。
7 *
8 * @param string $phpCode 解析対象のPHPコード文字列。
9 */
10function analyzePhpCodeTokens(string $phpCode): void
11{
12    echo "--- PHPコードのトークン解析 ---\n";
13    echo "解析対象コード:\n";
14    echo "```php\n";
15    echo $phpCode;
16    echo "```\n\n";
17
18    // token_get_all() 関数は、PHPコード文字列をPHPのパーサーが使用するトークンの配列に分解します。
19    // 各トークンは、以下のいずれかの形式で返されます:
20    // 1. [トークンID, トークン値, 行番号] の配列 (例: T_VARIABLE, T_SR)
21    // 2. 単一の文字 (演算子や区切り文字など、PHP独自のトークンIDを持たないもの、例: '+', ';', '(')
22    $tokens = token_get_all($phpCode);
23
24    echo "--- 解析結果 ---\n";
25    foreach ($tokens as $token) {
26        if (is_array($token)) {
27            // 配列形式のトークンの場合、トークンIDを人間が読める名前に変換します。
28            // token_name() は T_SR のような定数を "T_SR" という文字列に変換します。
29            $tokenName = token_name($token[0]);
30            $tokenValue = $token[1];
31            $lineNumber = $token[2];
32
33            printf(
34                "行 %-3d | タイプ: %-15s (ID: %-4d) | 値: '%s'\n",
35                $lineNumber,
36                $tokenName,
37                $token[0],
38                $tokenValue
39            );
40
41            // T_SR トークンが見つかった場合に補足説明を追加します。
42            if ($token[0] === T_SR) {
43                echo "        -> T_SR は右シフト演算子 '>>' を表すトークン定数です。\n";
44            }
45            // T_VARIABLE トークンが見つかった場合に補足説明を追加します。
46            if ($token[0] === T_VARIABLE) {
47                echo "        -> T_VARIABLE は変数を表すトークン定数です (例: \$myVariable)。\n";
48            }
49        } else {
50            // 単一文字のトークン（例: '{', '}', ';', '+' など）
51            printf("トークン: '%s'\n", $token);
52        }
53    }
54    echo "--------------------------\n";
55}
56
57// 解析対象となるPHPコードの例を定義します。
58// ここでは、変数定義と右シフト演算子を含む簡単なコードを使用します。
59$samplePhpCode = <<<'EOD'
60<?php
61$valueA = 100;
62$valueB = $valueA >> 2; // T_SR (右シフト演算子) の例
63$result = $valueB + 5; // T_VARIABLE の例: $valueB, $result
64echo $result;
65EOD;
66
67// 定義した関数を呼び出し、PHPコードのトークン解析を実行します。
68analyzePhpCodeTokens($samplePhpCode);
69
70?>

このPHPサンプルコードは、PHPがどのようにコードを解析し、プログラムを理解しているかを示すものです。具体的には、token_get_all()関数を使用して、指定されたPHPコード文字列を「トークン」と呼ばれる最小単位に分解し、それぞれのトークンの種類や値を表示します。

token_get_all()関数は、解析対象のPHPコード文字列を引数に取り、PHPパーサーが使用するトークンの配列を戻り値として返します。この配列内の各要素は、トークンの詳細（ID、値、行番号）を含む配列、または単一の文字（演算子など）の形式をとります。

T_SRはPHPのパーサーが「右シフト演算子 >>」を識別した際に割り当てるトークン定数です。また、T_VARIABLEは「変数 $myVariable」を識別した際に割り当てるトークン定数で、これらはコード内で特定の意味を持つ要素を表します。

サンプルコードでは、変数定義や右シフト演算子を含む短いPHPコードを解析し、その結果を表示しています。これにより、token_get_all()関数がコード内の各要素（例えば、変数名や演算子など）をどのように認識し、T_SRやT_VARIABLEといった内部的な定数として分類しているかを学ぶことができます。システムエンジニアを目指す初心者の方にとって、PHPの内部的な動作を理解するための一助となるでしょう。