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

Copy
1<?php
2
3/**
4 * 指定されたPHPコードを解析し、そのトークン情報を表示します。
5 * T_POW (指数演算子) や T_STRING (識別子) など、様々なトークンがどのように抽出されるかを示します。
6 *
7 * @param string $phpCode 解析対象のPHPコード文字列。
8 */
9function analyzePhpTokens(string $phpCode): void
10{
11    // PHPコードを個々のトークンに分解します。
12    // 各トークンは配列 ([トークンID, トークン値, 行番号]) または単一の文字列 (演算子など) として返されます。
13    $tokens = token_get_all($phpCode);
14
15    echo "--- PHP コード ---" . PHP_EOL;
16    echo $phpCode . PHP_EOL;
17    echo "--- トークン解析結果 ---" . PHP_EOL;
18
19    foreach ($tokens as $token) {
20        if (is_array($token)) {
21            // トークンが配列の場合、そのタイプ (ID)、値、行番号を取得します。
22            $tokenId = $token[0];
23            $tokenValue = $token[1];
24            $lineNumber = $token[2];
25
26            // トークンIDを人間が読める定数名 (例: T_POW, T_STRING) に変換します。
27            $tokenName = token_name($tokenId);
28
29            // トークン情報を整形して出力します。
30            echo sprintf(
31                "  - タイプ: %s (%d), 値: '%s', 行: %d%s",
32                $tokenName,
33                $tokenId,
34                $tokenValue,
35                $lineNumber,
36                PHP_EOL
37            );
38        } else {
39            // トークンが単一の文字列の場合 (例: '{', ';', '+', ' ', など)。
40            echo sprintf("  - タイプ: 文字列, 値: '%s'%s", $token, PHP_EOL);
41        }
42    }
43    echo "--- 解析終了 ---" . PHP_EOL;
44}
45
46// 解析対象となるPHPコードを定義します。
47// このコードには、指数演算子 (**) を使用した T_POW の例と、
48// 変数名、関数名、キーワードといった T_STRING の例が含まれています。
49$codeToAnalyze = <<<'EOD'
50<?php
51$baseValue = 2;
52$exponentValue = 3;
53$calculatedResult = $baseValue ** $exponentValue; // ここで T_POW が出現します
54
55function calculatePower(int $b, int $e): int { // 'calculatePower', 'int' などが T_STRING です
56    return $b ** $e;
57}
58
59$finalPower = calculatePower(5, 2); // 'finalPower', 'calculatePower' などが T_STRING です
60echo "計算結果: " . $finalPower;
61EOD;
62
63// 定義した関数を実行し、PHPコードのトークン解析結果を表示します。
64analyzePhpTokens($codeToAnalyze);

PHPのT_POWとT_STRINGという定数について、このサンプルコードを通じてご説明します。このコードは、与えられたPHPコードを構成する小さな要素である「トークン」に分解し、その種類や値を表示するものです。これにより、PHPがコードをどう認識しているかを確認できます。

analyzePhpTokens関数は、解析したいPHPコードの文字列を引数として受け取ります。内部ではtoken_get_all関数を使用し、PHPコードをトークンに分解します。各トークンは、T_POWやT_STRINGのような種類を示すID、値、行番号といった情報を含みます。この関数は戻り値を持たず、解析結果を標準出力に表示します。

T_POWは指数演算子**を表すトークン定数で、$baseValue ** $exponentValueのようなべき乗計算を行う箇所で出現します。一方、T_STRINGは、変数名、関数名、クラス名、キーワードなど、PHPコード内の識別子として使われる文字列を表します。例えば$baseValueやcalculatePower、intなどがT_STRINGとして識別されます。サンプルコードの出力で、これらがどのように分類されるかを確認できます。

Copy
1<?php
2
3/**
4 * 指定されたPHPコード文字列を解析し、コメントと累乗演算子 (**) のトークンを検出して表示します。
5 *
6 * システムエンジニアを目指す初心者向けに、PHPの内部がどのようにコードを「トークン」に
7 * 分解して解釈するかの一例を示します。
8 * T_COMMENTとT_POWは、PHPパーサーが使用する内部定数（トークンID）です。
9 *
10 * @param string $phpCode 解析対象のPHPコード文字列。
11 */
12function analyzePhpTokens(string $phpCode): void
13{
14    echo "--- PHP コード解析開始 ---\n";
15
16    // token_get_all() 関数を使用して、PHPコードを個々のトークンに分解します。
17    // 各トークンは配列 ([トークンID, 内容, 行番号]) または単一文字の文字列として返されます。
18    $tokens = token_get_all($phpCode);
19
20    foreach ($tokens as $token) {
21        // トークンが配列の場合、それは特定の意味を持つPHPの要素です（例: 変数名、キーワード、コメントなど）。
22        if (is_array($token)) {
23            $token_id = $token[0];         // トークンの内部ID（例: T_COMMENT, T_POW）
24            $token_content = $token[1];    // トークンの実際の文字列内容（例: '/* コメント */', '**'）
25            $line_number = $token[2];      // トークンが見つかった行番号
26
27            // PHPのトークンIDから、より人間が理解しやすい名前を取得します。
28            $token_name = token_name($token_id);
29
30            // リファレンス情報にある「T_POW」トークン（累乗演算子「**」）を検出します。
31            if ($token_id === T_POW) {
32                echo "【検出】トークン: {$token_name}, 内容: '{$token_content}', 行: {$line_number}\n";
33            }
34            // キーワードにある「T_COMMENT」トークン（コメント）を検出します。
35            elseif ($token_id === T_COMMENT) {
36                echo "【検出】トークン: {$token_name}, 内容: '{$token_content}', 行: {$line_number}\n";
37            }
38        }
39        // 単一文字のトークン（例: '{', '(', ';', '=' など）は、ここでは特別扱いせずスキップします。
40    }
41
42    echo "--- PHP コード解析終了 ---\n";
43}
44
45// 解析するPHPコードのサンプルをヒアドキュメント形式で定義します。
46// これにはコメント (T_COMMENT) と累乗演算子 (T_POW) が含まれています。
47$sample_php_code = <<<'EOD'
48<?php
49/**
50 * このファイルはPHPのトークン解析のサンプルです。
51 * 初心者でも理解しやすいように、コメントが多く含まれています。
52 */
53
54// 変数を定義します。
55$base = 2; // 基数
56$exponent = 3; # 指数
57
58/*
59 * ここから累乗計算です。
60 * PHP 5.6以降では、累乗演算子として「**」が導入されました。
61 * これは内部的にはT_POWトークンとして扱われます。
62 */
63$result = $base ** $exponent; // $result は 2の3乗 (8) となります。
64
65// 結果を出力します。
66echo "計算結果: " . $result . "\n";
67?>
68EOD;
69
70// 定義した関数を呼び出し、サンプルPHPコードを解析します。
71analyzePhpTokens($sample_php_code);

このサンプルコードは、PHPコードがPHPの内部でどのように解析され、小さな要素（トークン）に分解されるかを示しています。特に、コメントを示す内部定数T_COMMENTと、PHP 5.6以降で導入された累乗演算子**を示す内部定数T_POW（トークンID）を検出する方法を紹介します。

analyzePhpTokens関数は、引数として渡されたPHPコード文字列をtoken_get_all()関数を使って解析します。この関数は、コードを構成する個々のトークン（キーワード、変数名、演算子、コメントなど）の配列を返します。各トークンは、その種類を示す内部ID（T_COMMENTやT_POWのような定数）、実際の文字列内容、そしてコード内の行番号を含みます。関数はこれらのトークンを一つずつ確認し、T_POWまたはT_COMMENTに該当するトークンが見つかった場合に、その種類と内容、行番号を画面に出力します。token_name()関数は、内部のトークンIDを人間が理解しやすい名前に変換するために利用されます。この関数の戻り値はvoidであり、結果は直接コンソールに表示されます。システムエンジニアを目指す方にとって、PHPがコードを解釈する仕組みを垣間見る良い例となります。