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

Copy
1<?php
2
3/**
4 * PHPコードを解析し、特定のトークン（定数）の出現を検出する関数。
5 *
6 * この関数は、PHPの内部処理でコードがどのように小さな構成要素（トークン）に
7 * 分解されるかを示します。特に、累乗代入演算子 (T_POW_EQUAL) とコメント (T_COMMENT)
8 * がどのように認識されるかをシステムエンジニアを目指す初心者向けに紹介します。
9 */
10function demonstrateTokenRecognition(): void
11{
12    // 解析対象のPHPコードを文字列として定義します。
13    // T_POW_EQUAL 演算子 (`**=`) と様々な形式のコメント (T_COMMENT) を含みます。
14    $phpCodeString = <<<'EOD'
15<?php
16$base = 2; // これは単一行コメントです。
17$exponent = 3; /*
18               * これは複数行コメントの例です。
19               * コードの特定のブロックを説明するために使用されます。
20               */
21$base **= $exponent; # これは累乗代入演算子 (`**=`) の使用例です。
22EOD;
23
24    echo "--- 解析対象のPHPコード ---\n";
25    echo $phpCodeString . "\n";
26    echo "--------------------------\n\n";
27
28    // token_get_all() 関数を使って、PHPコードをトークンの配列に分解します。
29    // 各トークンはPHPの構文要素（変数名、演算子、コメントなど）を表します。
30    $tokens = token_get_all($phpCodeString);
31
32    echo "--- 検出されたトークン --- (T_POW_EQUAL および T_COMMENT のみ)\n";
33
34    // 分解されたトークンを一つずつ確認します。
35    foreach ($tokens as $token) {
36        // token_get_all() は文字列（単一文字の演算子など）または配列を返します。
37        // 配列の場合、トークンID、トークン内容、行番号が含まれます。
38        if (is_array($token)) {
39            $tokenName = token_name($token[0]); // トークンIDを可読な名前に変換します。
40
41            // T_POW_EQUAL トークン（累乗代入演算子 `**=`）を検出
42            if ($token[0] === T_POW_EQUAL) {
43                echo sprintf(
44                    "検出: %s (%s) - 内容: '%s' - 行: %d\n",
45                    $tokenName, // 例: T_POW_EQUAL
46                    "累乗代入演算子",
47                    $token[1],  // 例: **=
48                    $token[2]   // 例: 7
49                );
50            }
51            // T_COMMENT トークン（PHPコード内のコメント）を検出
52            elseif ($token[0] === T_COMMENT) {
53                echo sprintf(
54                    "検出: %s (%s) - 内容: '%s' - 行: %d\n",
55                    $tokenName, // 例: T_COMMENT
56                    "コメント",
57                    $token[1],  // 例: // これは単一行コメントです。
58                    $token[2]   // 例: 2
59                );
60            }
61        }
62    }
63    echo "--------------------------------------------------------\n";
64}
65
66// 上記で定義した関数を実行します。
67demonstrateTokenRecognition();

このサンプルコードは、PHPがプログラムのコードをどのように内部的に解析し、小さな構成要素である「トークン」に分解するかを学ぶためのものです。特に、PHP 8で導入された累乗代入演算子 (**=) と、コメント (//, /* */, #) がPHPによってどのように識別されるかを示しています。

token_get_all() 関数は、与えられたPHPコードの文字列を解析し、その構文要素（変数名、演算子、コメントなど）をトークンという形式の配列として返します。この関数には解析したいPHPコードの文字列を引数として渡し、コードを分解したトークンのリストが戻り値として得られます。

T_POW_EQUAL は、PHP 8から利用できる累乗代入演算子 **= を表すトークン定数です。この定数自体に引数や戻り値はありませんが、token_get_all() がコード内で **= を検出した際に、その部分をT_POW_EQUALというトークンとして識別します。

同様に、T_COMMENT はPHPコード中のコメント部分を表すトークン定数です。サンプルコードでは、用意したPHPコード文字列からtoken_get_all()を使ってトークンを抽出し、その中からT_POW_EQUALとT_COMMENTに該当するものを検出し、種類、実際のコード内容、行番号を表示しています。これにより、PHPがコードの特定の要素を内部的に分類し処理する基礎的な仕組みを理解することができます。

Copy
1<?php
2
3/**
4 * PHPコードを解析し、T_ENCAPSED_AND_WHITESPACE トークンの出現を特定する関数。
5 *
6 * T_ENCAPSED_AND_WHITESPACE は、ダブルクォーテーションで囲まれた文字列内で、
7 * 変数展開と通常の文字列や空白が結合された部分を表す内部トークンです。
8 * この関数は、`token_get_all()` を用いてPHPコードを解析し、
9 * この特定のトークンが見つかった場合にその詳細を出力します。
10 *
11 * @param string $phpCode 解析対象のPHPコード文字列。
12 * @return void
13 */
14function demonstrateEncapsedAndWhitespaceToken(string $phpCode): void
15{
16    echo "--- 解析対象コード ---" . PHP_EOL;
17    echo $phpCode . PHP_EOL;
18    echo "----------------------" . PHP_EOL . PHP_EOL;
19
20    // `token_get_all()` はPHPコードを構文解析し、トークンの配列を返します。
21    // 各トークンは、トークンID (整数)、トークン内容 (文字列)、行番号 (整数) を含む配列です。
22    // 単一文字のトークン (例: '{', ';') は文字列として返されます。
23    $tokens = token_get_all($phpCode);
24
25    $foundEncapsed = false;
26    echo "T_ENCAPSED_AND_WHITESPACE トークンの検出結果:" . PHP_EOL;
27
28    foreach ($tokens as $token) {
29        // トークンが配列であり、かつそのIDが T_ENCAPSED_AND_WHITESPACE であるかを確認
30        if (is_array($token) && $token[0] === T_ENCAPSED_AND_WHITESPACE) {
31            $foundEncapsed = true;
32            // トークンIDを対応する定数名に変換して表示
33            echo sprintf(
34                "  - 内容: '%s', 定数名: %s (ID: %d), 行: %d" . PHP_EOL,
35                $token[1],
36                token_name($token[0]),
37                $token[0],
38                $token[2]
39            );
40        }
41    }
42
43    if (!$foundEncapsed) {
44        echo "  - T_ENCAPSED_AND_WHITESPACE トークンは見つかりませんでした。" . PHP_EOL;
45    }
46}
47
48// --- サンプルコードの実行 ---
49
50// 例1: 変数展開を含むダブルクォーテーション文字列
51// "Hello " や ", welcome to PHP!" の部分が T_ENCAPSED_AND_WHITESPACE に該当します。
52$exampleCode1 = <<<'EOD'
53<?php
54$name = "PHP User";
55echo "Hello $name, welcome to PHP!";
56EOD;
57demonstrateEncapsedAndWhitespaceToken($exampleCode1);
58
59echo PHP_EOL;
60
61// 例2: 変数展開を含まないダブルクォーテーション文字列
62// この場合、文字列全体が T_CONSTANT_ENCAPSED_STRING として扱われるため、
63// T_ENCAPSED_AND_WHITESPACE は通常生成されません。
64$exampleCode2 = <<<'EOD'
65<?php
66echo "This is a simple string without variable.";
67EOD;
68demonstrateEncapsedAndWhitespaceToken($exampleCode2);
69
70echo PHP_EOL;
71
72// 例3: 複雑な変数展開と文字列の組み合わせ
73// "Your item is " や " and price is " の部分などが T_ENCAPSED_AND_WHITESPACE に該当します。
74$exampleCode3 = <<<'EOD'
75<?php
76$item = "Laptop";
77$price = 1200;
78echo "Your item is {$item} and price is ${price} USD.";
79EOD;
80demonstrateEncapsedAndWhitespaceToken($exampleCode3);
81

PHPのT_ENCAPSED_AND_WHITESPACEは、ダブルクォーテーションで囲まれた文字列内で、変数展開される部分と、通常の文字列や空白が結合されてできた部分を表す、PHP内部のトークンです。このトークンは、例えばecho "Hello $name, welcome to PHP!";というコードの場合、"Hello "や, welcome to PHP!"といった、変数（$name）ではない文字列や空白の部分が該当します。一方、変数展開を含まないecho "This is a simple string.";のようなダブルクォーテーション文字列は、通常このトークンとは別の種類として扱われるため、T_ENCAPSED_AND_WHITESPACEは生成されません。

提供されたサンプルコードは、demonstrateEncapsedAndWhitespaceToken関数を利用して、指定されたPHPコード文字列の中からT_ENCAPSED_AND_WHITESPACEトークンがどこにどのように出現するかを検出して表示します。この関数は、引数として解析対象となるPHPコードを文字列（$phpCode）で受け取ります。関数内部では、token_get_all()関数を用いてPHPコードを構文解析し、トークンの配列を生成します。その後、配列内の各トークンを巡回し、T_ENCAPSED_AND_WHITESPACEに該当するトークンが見つかった場合に、その内容や種類、出現行番号をコンソールに出力します。この関数は検出結果を直接出力するため、呼び出し元に特定の値を返すことはなく、戻り値はvoid型です。これにより、PHPがダブルクォーテーション文字列を内部的にどのように処理しているかを具体的に理解することができます。