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

Copy
1<?php
2
3/**
4 * 指定されたPHPコード文字列を解析し、PHPのトークン（構文要素）を検出する関数です。
5 * 特に、T_PLUS_EQUAL (加算代入演算子) とコメントトークン (T_COMMENT, T_DOC_COMMENT)
6 * の検出に焦点を当てています。
7 *
8 * @param string $phpCode 解析対象のPHPコード文字列。
9 */
10function analyzePhpCodeTokens(string $phpCode): void
11{
12    // token_get_all() は、PHPコードをその構文を構成するトークンの配列に変換します。
13    // 各トークンは、[トークンID, トークンの値, 行番号] の形式の配列か、
14    // 単一文字の演算子や区切り文字（例: '+', ';', '('）を表す文字列です。
15    $tokens = token_get_all($phpCode);
16
17    echo "--- PHP コードトークン解析結果 ---\n";
18    echo "対象コード:\n```php\n{$phpCode}```\n\n";
19
20    foreach ($tokens as $token) {
21        if (is_array($token)) {
22            // トークンが配列の場合、それはPHPのキーワード、変数、コメントなどの定数トークンです。
23            $tokenId = $token[0];
24            $tokenValue = $token[1];
25            $lineNumber = $token[2];
26
27            // token_name() 関数を使ってトークンIDを人間が読める名前に変換します。
28            $tokenName = token_name($tokenId);
29
30            echo "行 {$lineNumber}: [{$tokenName}] \"{$tokenValue}\"";
31
32            // T_PLUS_EQUAL は、加算代入演算子 '+= ' を表すトークンです。
33            if ($tokenId === T_PLUS_EQUAL) {
34                echo " <-- T_PLUS_EQUAL (加算代入演算子) を検出！";
35            }
36            // T_COMMENT は単一行コメント (//, #) や複数行コメント (/* ... */) を表します。
37            // T_DOC_COMMENT はPHPDoc形式のコメント (/** ... */) を表します。
38            // これらは一般的にコメントとして扱われます。
39            elseif ($tokenId === T_COMMENT || $tokenId === T_DOC_COMMENT) {
40                echo " <-- コメントを検出！";
41            }
42            echo "\n";
43        } else {
44            // トークンが文字列の場合、それはPHPの単一文字の演算子や句読点などです。
45            echo "文字: \"{$token}\"\n";
46        }
47    }
48    echo "\n--- 解析終了 ---\n";
49}
50
51// 解析対象となるPHPコードの例をヒアドキュメントで定義します。
52$samplePhpCode = <<<'EOT'
53<?php
54/**
55 * これは、クラスのドキュメントコメントの例です。
56 * T_DOC_COMMENT トークンとして解析されます。
57 */
58class Counter
59{
60    private int $value = 0; // これは単一行コメントです。T_COMMENT トークン。
61
62    public function add(int $amount): void
63    {
64        // ここで T_PLUS_EQUAL (加算代入演算子) を使用しています。
65        $this->value += $amount; // $this->value = $this->value + $amount; と同じ意味
66        /*
67         * これは複数行コメントの例です。
68         * これもT_COMMENT トークンとして解析されます。
69         */
70        echo "現在の値: " . $this->value . "\n";
71    }
72}
73
74$myCounter = new Counter();
75$myCounter->add(10); // 10を加算
76$myCounter->add(5);  // さらに5を加算
77?>
78EOT;
79
80// 定義した関数を実行して、サンプルコードのトークンを解析し表示します。
81analyzePhpCodeTokens($samplePhpCode);

このサンプルコードは、PHPのソースコードを構成する最小単位である「トークン」を解析し、特に加算代入演算子+=を表すT_PLUS_EQUALと、各種コメントを表すT_COMMENT、T_DOC_COMMENTといった特定のトークンを検出する方法を示しています。

analyzePhpCodeTokens関数は、解析対象のPHPコード文字列を引数$phpCodeとして受け取ります。この関数は、token_get_all()関数を使用してPHPコードをその構文要素であるトークンの配列に分解します。分解されたトークンは、それぞれID、値、行番号の情報を持っています。関数はトークンを一つずつ検査し、token_name()関数でIDを人間が読める名前に変換して出力します。もしトークンIDがT_PLUS_EQUALであれば加算代入演算子が、T_COMMENTまたはT_DOC_COMMENTであればコメントが検出されたことを明示的に表示します。この関数は解析結果を標準出力に表示するだけで、特定の値を返しません（戻り値はvoidです）。

この解析を通じて、システムエンジニアを目指す初心者は、PHPコードがどのように内部的に構造化され、特定の演算子やコメントといった要素がどのように識別されるかを具体的に理解することができます。

Copy
1<?php
2
3/**
4 * 指定されたPHPコードをトークンに分解し、その種類と内容を表示する関数。
5 * PHPコードがどのように内部で解釈されるかの一端を、システムエンジニアを目指す初心者が理解する手助けをします。
6 * 特に、PHPの内部定数である `T_PLUS_EQUAL` (複合代入演算子 +=) と
7 * `T_ENCAPSED_AND_WHITESPACE` (ダブルクォート文字列内のテキスト) に注目して説明します。
8 *
9 * @param string $phpCode 解析するPHPコード文字列。
10 * @return void
11 */
12function analyzePhpTokens(string $phpCode): void
13{
14    echo "--- PHPコードのトークン解析 ---" . PHP_EOL;
15    echo "対象コード:" . PHP_EOL;
16    echo "```php" . PHP_EOL;
17    echo $phpCode . PHP_EOL;
18    echo "```" . PHP_EOL . PHP_EOL;
19
20    // token_get_all() を使用してPHPコードをトークンの配列に分解します。
21    // この関数は、PHPのパーサーがコードを解釈する際に使用する内部的な構成要素（トークン）を返します。
22    // コードが有効なPHPとして解析されるよう、冒頭に '<?php ' タグを追加しています。
23    $tokens = token_get_all("<?php " . $phpCode);
24
25    echo "--- 解析結果 ---" . PHP_EOL;
26
27    foreach ($tokens as $token) {
28        if (is_array($token)) {
29            // トークンが配列の場合、通常は [トークンID, トークン内容, 行番号] の形式です。
30            $tokenName = token_name($token[0]); // トークンIDから人間が読める名前に変換
31            $tokenContent = $token[1];          // トークンが表す実際の文字列
32            $lineNumber = $token[2];            // トークンが出現した行番号
33
34            echo sprintf(
35                "行 %d: %-30s => '%s'",
36                $lineNumber,
37                $tokenName,
38                str_replace(["\n", "\r"], ['\n', '\r'], $tokenContent) // 改行文字を見やすくエスケープ
39            ) . PHP_EOL;
40
41            // T_PLUS_EQUAL (+= 演算子) が検出された場合の説明
42            if ($token[0] === T_PLUS_EQUAL) {
43                echo "    ^ これは『+=』演算子を表すトークンです。変数の値を加算して再代入する際に使われます。" . PHP_EOL;
44            }
45            // T_ENCAPSED_AND_WHITESPACE (ダブルクォート文字列内のテキスト) が検出された場合の説明
46            if ($token[0] === T_ENCAPSED_AND_WHITESPACE) {
47                echo "    ^ これはダブルクォート文字列の中で、変数展開されていないテキスト部分や空白を表すトークンです。" . PHP_EOL;
48                echo "      例えば \"Hello, \$name!\" という文字列の \"Hello, \" や \"!\" の部分がこれに該当します。" . PHP_EOL;
49            }
50        } else {
51            // トークンが単一の文字列の場合（例: '{', ';', '=' など、特定の記号を表す）
52            echo sprintf(
53                "       単一文字トークン          => '%s'",
54                str_replace(["\n", "\r"], ['\n', '\r'], $token)
55            ) . PHP_EOL;
56        }
57    }
58    echo PHP_EOL;
59}
60
61// サンプルコードを定義します。
62// このコードには、`T_PLUS_EQUAL` (`+=`) 演算子と、`T_ENCAPSED_AND_WHITESPACE` が現れる
63// ダブルクォート文字列が含まれています。
64$sampleCode = <<<'PHP_CODE'
65$counter = 10;
66$message = "World";
67$counter += 5; // ここに T_PLUS_EQUAL トークンが含まれます
68$greeting = "Hello, $message! The counter is now {$counter}."; // ここには T_ENCAPSED_AND_WHITESPACE トークンが含まれます
69PHP_CODE;
70
71// 関数を実行し、定義したサンプルコードのトークン解析結果を表示します。
72analyzePhpTokens($sampleCode);
73
74// 別の簡単な例で再度解析してみます。
75$anotherSampleCode = '$x = 1; $x += 2; echo "Value is $x.";';
76analyzePhpTokens($anotherSampleCode);
77

このサンプルコードは、PHPコードを「トークン」と呼ばれる最小単位に分解し、PHPがコードをどのように解釈しているかを示すものです。analyzePhpTokens 関数は、引数として解析したいPHPのコード文字列（$phpCode）を受け取ります。この関数は、PHPの token_get_all() 関数を利用してコードを構成する要素を一つずつ解析し、その種類と内容、出現行番号を詳細に表示します。戻り値は void で、値を返さず直接結果を出力します。

特に注目するのは、T_PLUS_EQUAL と T_ENCAPSED_AND_WHITESPACE という二つのトークンです。T_PLUS_EQUAL は、複合代入演算子である += を表します。これは、変数の現在の値に何かを加えて、その結果を同じ変数に再代入する際に使われる記号です。一方、T_ENCAPSED_AND_WHITESPACE は、ダブルクォートで囲まれた文字列の中で、変数として展開されない純粋なテキスト部分や空白を指します。例えば、"Hello, $name!" という文字列の場合、"Hello, " や "! " の部分がこれに該当します。

この解析を通じて、システムエンジニアを目指す初心者が、PHPがソースコードをどのように「読んで」実行しているのかを理解する手助けとなります。