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

Copy
1<?php
2
3/**
4 * PHPコードをトークンに分解し、それぞれのトークンに関する情報（型、値、行番号）を出力します。
5 * 特に、PHPのコメント (T_COMMENT) と複合代入演算子 (T_MOD_EQUAL) がどのようにトークンとして扱われるかを示します。
6 *
7 * @param string $phpCode 解析するPHPコード文字列。
8 */
9function displayCodeTokens(string $phpCode): void
10{
11    echo "--- 解析対象のPHPコード ---\n";
12    echo $phpCode . "\n";
13    echo "---------------------------\n\n";
14
15    // PHPのソースコードを個々の「トークン」に分解します。
16    // PHPはコードを実行する前に、このトークンに分解する処理を行います。
17    // '<?php ' を前置するのは、token_get_all() が有効なPHPコードブロックを必要とするためです。
18    $tokens = token_get_all('<?php ' . $phpCode);
19
20    echo "--- トークン解析結果 ---\n";
21
22    // 各トークンを順番に処理します。
23    foreach ($tokens as $token) {
24        if (is_array($token)) {
25            // トークンが配列の場合、[型ID, 値, 行番号] の形式です。
26            $tokenName = token_name($token[0]); // トークンIDを人間が読める名前に変換します (例: T_COMMENT)。
27            $tokenValue = $token[1];           // トークンの実際の文字列値 (例: '// 初期値')。
28            $lineNumber = $token[2];           // そのトークンがある行番号。
29
30            echo "行 {$lineNumber}: 型: {$tokenName}, 値: '{$tokenValue}'";
31
32            // キーワードに関連するT_COMMENTの場合、特別な説明を追加します。
33            if ($token[0] === T_COMMENT) {
34                echo " <= これはPHPコード内のコメントです。実行時には無視されます。";
35            }
36            // リファレンス情報にあるT_MOD_EQUALの場合、特別な説明を追加します。
37            if ($token[0] === T_MOD_EQUAL) {
38                echo " <= これは複合代入演算子 '%=' を表すトークンです。";
39            }
40            echo "\n";
41        } else {
42            // トークンが配列でない場合、それは単一文字の演算子や記号です (例: '{', ';', '=')。
43            echo "型: (記号), 値: '{$token}'\n";
44        }
45    }
46    echo "---------------------------\n";
47}
48
49// 解析対象のPHPサンプルコードを定義します。
50// このコードにはコメント (T_COMMENT) と複合代入演算子 '%=' (T_MOD_EQUAL) の両方が含まれています。
51$sampleCode = <<<'EOD'
52$count = 10; // 初期値を設定
53$divisor = 3;
54
55// $count %= $divisor; は $count = $count % $divisor; と同じ意味です。
56$count %= $divisor; /* ここは複数行のコメントです */
57
58echo "残りの値: " . $count; // 結果を出力
59EOD;
60
61// 関数を呼び出して、サンプルコードのトークンを表示します。
62displayCodeTokens($sampleCode);

このPHPサンプルコードは、与えられたPHPのソースコードを、言語の最小単位である「トークン」に分解し、それぞれのトークンの型、値、そして出現行番号を詳細に表示します。displayCodeTokens関数は、解析したいPHPコード文字列を引数$phpCodeとして受け取り、結果を画面に出力するため戻り値はありません。

コードの解析にはPHPに標準で備わっているtoken_get_all()関数が利用されており、PHPがコードを実行する前にどのように構造を認識しているかを示します。特に、このサンプルコードでは、PHPコード内のコメント部分がT_COMMENTというトークンとして認識されることや、%=のような複合代入演算子がT_MOD_EQUALという特定のトークンとして識別される様子を具体的に確認できます。

T_COMMENTトークンは、開発者がコードに説明を加えるために記述し、プログラム実行時には完全に無視される部分です。一方、T_MOD_EQUALトークンは$a %= $b;のように記述され、$a = $a % $b;と等価な演算を表します。これらの情報を通して、PHPコードの内部的な構造や、コメントと特殊な演算子がどのように扱われるかを、初心者の方にも分かりやすく理解していただけます。

Copy
1<?php
2
3/**
4 * PHPのトークン定数 T_MOD_EQUAL と T_STRING を用いたコード解析の例。
5 *
6 * この関数は、与えられたPHPコード文字列をトークンに分解し、
7 * 各トークンの種類（T_MOD_EQUAL, T_STRINGなど）とその値、行番号を表示します。
8 * T_MOD_EQUAL は複合代入演算子 "%=" を、T_STRING は識別子
9 * （変数名、関数名、クラス名など）を表します。
10 *
11 * @param string $code 解析対象のPHPコード文字列。
12 */
13function analyzePhpCodeTokens(string $code): void
14{
15    echo "--- PHP コードトークン解析 ---\n";
16    echo "解析対象コード:\n";
17    echo "```php\n{$code}\n```\n\n";
18
19    // token_get_all() を使用してPHPコードをトークンに分解します。
20    // PHPコードの内部的な構造を理解するのに役立ちます。
21    $tokens = token_get_all($code);
22
23    echo "検出されたトークン:\n";
24    foreach ($tokens as $token) {
25        if (is_array($token)) {
26            // トークンが配列の場合、名前付きトークン（例: T_STRING, T_MOD_EQUAL）です。
27            $tokenName = token_name($token[0]); // トークンIDから人間が読める名前を取得
28            $tokenValue = $token[1];           // トークンの実際の値（文字列）
29            $lineNumber = $token[2];           // トークンが出現した行番号
30
31            if ($token[0] === T_MOD_EQUAL) {
32                // T_MOD_EQUAL は "%=" 演算子を検出したことを示します。
33                echo "  行 {$lineNumber}: [{$tokenName}] 値: '{$tokenValue}' (T_MOD_EQUALを検出: 剰余代入演算子)\n";
34            } elseif ($token[0] === T_STRING) {
35                // T_STRING は識別子（変数名、関数名、クラス名など）を検出したことを示します。
36                echo "  行 {$lineNumber}: [{$tokenName}] 値: '{$tokenValue}' (T_STRINGを検出: 識別子)\n";
37            } else {
38                echo "  行 {$lineNumber}: [{$tokenName}] 値: '{$tokenValue}'\n";
39            }
40        } else {
41            // トークンが文字列の場合、単一文字の演算子や区切り文字（例: '=', ';', '{'）です。
42            echo "  トークン: '{$token}'\n";
43        }
44    }
45    echo "-------------------------------\n";
46}
47
48// 解析対象のPHPコード文字列を定義します。
49// T_MOD_EQUAL の例 ( %= ) と T_STRING の例 ( $counter, greetUser ) を含みます。
50$phpCodeSnippet = <<<'EOD'
51<?php
52$counter = 10;
53$counter %= 3; // ここに T_MOD_EQUAL が出現します
54function greetUser($name) { // 'greetUser' は T_STRING の例です
55    echo "Hello, " . $name . "!\n";
56}
57greetUser("Alice");
58EOD;
59
60// 上記で定義したPHPコードスニペットのトークン解析を実行します。
61analyzePhpCodeTokens($phpCodeSnippet);
62

このサンプルコードは、PHPコードの内部構造を理解するための「トークン解析」の基本を示しています。analyzePhpCodeTokens関数は、引数として与えられたPHPコード文字列を解析し、それを構成する最小単位である「トークン」の種類、値、出現行番号を表示します。この関数自体は具体的な戻り値を持ちません。

関数内部では、token_get_all()というPHPの組み込み関数を使用し、PHPコード文字列をトークンの配列に分解しています。分解された各トークンはループで処理され、その種類に応じて詳細が表示されます。特に注目すべきは、T_MOD_EQUALとT_STRINGというPHPの定数です。T_MOD_EQUALは、剰余代入演算子である%=（例えば $variable %= 5; のような記述）をPHPコード内で検出したことを示します。一方、T_STRINGは、変数名、関数名、クラス名などの「識別子」（例えば $counter や greetUser）を検出した際に使用される定数です。

トークンが配列として検出された場合、最初の要素がトークンID（例: T_MOD_EQUAL）、二番目の要素がそのトークンの実際の文字列値、三番目の要素がコード内での行番号を表します。token_name()関数を使って、トークンIDを人間が読みやすい名前に変換しています。単一の記号（=や;など）は直接文字列として表示されます。この解析を通じて、PHPがコードをどのように解釈しているかを視覚的に確認できます。