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

Copy
1<?php
2
3/**
4 * PHPコードを解析し、そのトークン情報を表示する関数。
5 * システムエンジニアを目指す初心者が、PHPがコードをどのように内部で分解・認識しているかを
6 * 理解するのに役立ちます。特に、T_SR_EQUAL（右シフト代入演算子）と
7 * T_STRING（識別子やキーワード）に注目して表示します。
8 */
9function demonstratePhpCodeTokenization(): void
10{
11    // 解析対象のPHPコード文字列を定義します。
12    // ここには、右シフト代入演算子 (>>=) と、
13    // 識別子やキーワードとしてT_STRINGになる要素が含まれています。
14    $codeToAnalyze = <<<'EOD'
15<?php
16$valueA = 100;
17$valueB = 4;
18$valueA >>= $valueB; // 右シフト代入演算子。これは T_SR_EQUAL トークンになります。
19echo "最終的な値A: " . $valueA . "\n"; // 'echo' や '最終的な値A' は T_STRING トークンになります。
20function calculateResult() {
21    return true; // 'function', 'calculateResult', 'return' なども T_STRING です。
22}
23EOD;
24
25    echo "--- 解析対象のPHPコード ---" . PHP_EOL;
26    echo $codeToAnalyze . PHP_EOL;
27    echo "--------------------------" . PHP_EOL . PHP_EOL;
28
29    echo "--- PHPトークン解析結果 ---" . PHP_EOL;
30
31    // token_get_all() 関数は、PHPコードを指定された文字列からトークンに分割します。
32    // 各トークンは、そのタイプ（PHP定数、例: T_SR_EQUAL）、内容、行番号を含む配列、
33    // または単一文字の演算子や句読点（例: '=', ';', '('）である文字列として返されます。
34    $tokens = token_get_all($codeToAnalyze);
35
36    foreach ($tokens as $token) {
37        if (is_array($token)) {
38            // トークンが配列の場合、それはPHPの内部定数によって識別される要素です。
39            $tokenName = token_name($token[0]); // トークンID (例: 366) から名前 (例: T_SR_EQUAL) を取得します。
40            $tokenContent = $token[1];           // トークンの元の内容 (例: '>>=')。
41            $lineNumber = $token[2];             // コード内でトークンが出現した行番号。
42
43            // 特定のトークン（T_SR_EQUALとT_STRING）に焦点を当てて、その意味を補足します。
44            if ($tokenName === 'T_SR_EQUAL') {
45                echo "  [T_SR_EQUAL] トークン: '" . $tokenContent . "' (行: " . $lineNumber . ") - これは右シフト代入演算子 '>>=' を表します。" . PHP_EOL;
46            } elseif ($tokenName === 'T_STRING') {
47                // T_STRINGはPHPの識別子（変数名の一部、関数名、クラス名）や
48                // いくつかのキーワード（echo, return, functionなど）を表します。
49                echo "  [T_STRING] トークン: '" . $tokenContent . "' (行: " . $lineNumber . ") - これは識別子またはキーワードを表します。" . PHP_EOL;
50            } else {
51                // その他のトークンも表示し、全体像を把握できるようにします。
52                echo "  [" . $tokenName . "] トークン: '" . $tokenContent . "' (行: " . $lineNumber . ")" . PHP_EOL;
53            }
54        } else {
55            // トークンが文字列の場合、それは単一文字の演算子や句読点です。
56            echo "  [単一文字トークン] トークン: '" . $token . "'" . PHP_EOL;
57        }
58    }
59    echo "-------------------------" . PHP_EOL;
60}
61
62// 関数を実行して、トークン解析の結果を表示します。
63demonstratePhpCodeTokenization();
64

このPHPコードは、与えられたPHPのソースコードがPHPによってどのように小さな意味のある単位（トークン）に分解されるかを、システムエンジニアを目指す初心者の方に分かりやすく示すものです。PHP言語がコードを内部でどのように解釈しているかを理解するのに役立ちます。

コードの中心はtoken_get_all()関数で、これは引数としてPHPコード文字列を受け取り、そのコードを解析してトークンのリストを返します。リスト内の各トークンは、その種類、内容、行番号を含む配列、または単一文字の記号（例: ;）として表現されます。

特に注目しているのは、PHPの内部定数であるT_SR_EQUALとT_STRINGです。T_SR_EQUALは、右シフト代入演算子>>=を表す定数で、その値はPHP内部で定義された整数値(int)です。この定数自体は引数を持ちません。T_STRINGは、変数名、関数名、クラス名のような識別子や、echo、return、functionなどの特定のキーワードを表す定数で、こちらも整数値(int)を持ち、引数はありません。

サンプルコードは、これらの定数を利用して、>>=演算子がT_SR_EQUALとして、また変数名やキーワードがT_STRINGとしてどのように認識されるかを具体的に表示しています。コードを実行するdemonstratePhpCodeTokenization関数は引数を取らず、戻り値もありません（void）が、解析結果を画面に出力することで、PHPコードの内部構造を視覚的に理解できます。

Copy
1<?php
2
3/**
4 * PHPコードをトークンに分解し、特定のトークンを検出するサンプル関数。
5 *
6 * この関数は、PHPコードの内部構造を解析するために使用されるトークン定数 `T_SR_EQUAL` と `T_VARIABLE` の
7 * 実際の使用例をシステムエンジニアを目指す初心者向けに示します。
8 * `T_SR_EQUAL` はシフト右代入演算子 (`>>=`) を、`T_VARIABLE` は変数をそれぞれ表します。
9 */
10function analyzeCodeForSpecificTokens(): void
11{
12    // 解析対象のPHPコード文字列を定義
13    // シフト右代入演算子 (>>=) と変数が含まれる簡単なコード
14    $code = '<?php $count = 100; $count >>= 2; $result = $count;';
15
16    echo "--- 解析対象コード ---\n";
17    echo $code . "\n\n";
18    echo "--- トークン解析結果 ---\n";
19
20    // token_get_all() 関数を使用してPHPコードをトークンに分解する
21    // 各トークンは配列（名前付きトークン）または文字列（単一文字の演算子など）として返される
22    // 配列の場合の形式: [0 => トークンID (int), 1 => トークン文字列 (string), 2 => 行番号 (int)]
23    $tokens = token_get_all($code);
24
25    // 分解されたトークンをループし、特定のトークンを検出する
26    foreach ($tokens as $token) {
27        // トークンが配列形式の場合、名前付きトークンである
28        if (is_array($token)) {
29            $tokenId = $token[0];      // トークンID (例: T_VARIABLE の数値)
30            $tokenString = $token[1];  // トークンに対応する文字列 (例: '$count')
31            $lineNumber = $token[2];   // トークンがある行番号
32
33            // T_VARIABLE (変数) トークンを検出する
34            if ($tokenId === T_VARIABLE) {
35                echo "検出: T_VARIABLE (変数) - 文字列: '{$tokenString}' (行: {$lineNumber})\n";
36            }
37            // T_SR_EQUAL (シフト右代入演算子 >>=) トークンを検出する
38            if ($tokenId === T_SR_EQUAL) {
39                echo "検出: T_SR_EQUAL (シフト右代入演算子 >>=) - 文字列: '{$tokenString}' (行: {$lineNumber})\n";
40            }
41        }
42        // 単一文字の演算子や句読点などのトークンは文字列として直接返されるため、ここでは無視
43    }
44
45    echo "\n--- 参考情報 ---\n";
46    // T_SR_EQUAL 定数の値は整数 (int) であることを示す
47    echo "T_SR_EQUAL の値: " . T_SR_EQUAL . " (これは整数値です)\n";
48    // T_VARIABLE 定数の値も整数 (int) である
49    echo "T_VARIABLE の値: " . T_VARIABLE . " (これも整数値です)\n";
50}
51
52// 関数を実行してトークン解析を開始
53analyzeCodeForSpecificTokens();
54

このサンプルコードは、PHPのソースコードを内部的に解析する仕組みである「トークン」を初心者の方にも分かりやすく説明しています。特に、シフト右代入演算子（>>=）を表す定数T_SR_EQUALと、変数を表す定数T_VARIABLEの使用例を示しています。

analyzeCodeForSpecificTokens関数は、まず解析対象となるPHPコードの文字列を定義します。次に、token_get_all()関数を使用してこの文字列をトークンの配列に分解します。token_get_all()関数は引数としてPHPコード文字列を受け取り、そのコードを構成する各要素（変数名、演算子、キーワードなど）を識別するためのトークン情報を含む配列を返します。

この分解されたトークンの配列を順に処理し、各トークンのIDがT_VARIABLEまたはT_SR_EQUALに一致するかどうかを確認します。一致した場合、そのトークンが変数なのかシフト右代入演算子なのかを識別し、元のコード内の文字列と行番号と共に表示します。T_SR_EQUALやT_VARIABLEといった定数は、PHPの内部で構文解析を行う際に各要素を識別するために使われる整数値です。これらは引数を取らず、その値自体が整数であることを示しています。このコードを通じて、PHPがどのようにコードを解釈し、各要素を識別しているかの基礎的な理解を深めることができます。