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

Copy
1<?php
2
3/**
4 * PHPコード文字列からコメントを抽出する関数。
5 * システムエンジニアを目指す初心者向けに、PHPのトークン解析の基本を示します。
6 * T_COMMENT は、PHPのコードをトークンに分解した際に、通常のコメント (//, #, /* ... */) を表す定数です。
7 * T_DOC_COMMENT は、PHPDoc形式のドキュメントコメント (/** ... */) を表します。
8 *
9 * @param string $phpCode 解析するPHPコード文字列
10 * @return array コメント文字列の配列
11 */
12function extractComments(string $phpCode): array
13{
14    // token_get_all() はPHPコードをトークンに分解します。
15    // 各トークンは配列 (トークンタイプ、値、行番号) または単一文字 (PHP構文) で構成されます。
16    $tokens = token_get_all($phpCode);
17    $comments = [];
18
19    foreach ($tokens as $token) {
20        // トークンが配列形式の場合のみ処理します。
21        // 単一文字のトークン (例: '{', ';') は文字列として扱われます。
22        if (is_array($token)) {
23            $tokenType = $token[0]; // トークンタイプ（定数ID）
24            $tokenValue = $token[1]; // トークンの値（文字列）
25
26            // T_COMMENT または T_DOC_COMMENT であれば、コメントとして抽出します。
27            // T_COMMENT は通常のコードコメント（//, #, /* */）を表します。
28            // T_DOC_COMMENT はPHPDoc形式のドキュメントコメント（/** */）を表します。
29            if ($tokenType === T_COMMENT || $tokenType === T_DOC_COMMENT) {
30                $comments[] = $tokenValue;
31            }
32        }
33    }
34
35    return $comments;
36}
37
38// 解析対象のPHPコード例
39// このコードには、PHPDoc、単一行コメント、複数行コメントが含まれています。
40$codeToAnalyze = <<<'PHP_CODE'
41<?php
42/**
43 * このファイルは、PHPのトークン解析のサンプルを示します。
44 * 主にコメントの抽出に焦点を当てています。
45 */
46
47namespace App\Utility; // 名前空間の定義
48
49class CodeAnalyzer
50{
51    // 定数を定義します。
52    public const MAX_LIMIT = 100; /* 最大制限値を設定 */
53
54    /**
55     * 指定されたPHPコードからすべてのコメントを抽出します。
56     * このメソッドは、クラスの機能を示すための例です。
57     *
58     * @param string $code 処理対象のPHPコード
59     * @return array 抽出されたコメントのリスト
60     */
61    public function analyzeCode(string $code): array
62    {
63        // ここにコード解析ロジックを記述します。
64        // 現在はコメント抽出のため、別途関数を利用します。
65        $extracted = extractComments($code); // コメントを抽出
66        return $extracted; // 結果を返します。
67    }
68}
69
70// メインスクリプト部分
71$analyzer = new App\Utility\CodeAnalyzer();
72// 別のコメント例
73$sampleResult = $analyzer->analyzeCode("<?php // Test comment"); # 短いコメント
74PHP_CODE;
75
76// 関数を呼び出し、コードからコメントを抽出
77$extractedComments = extractComments($codeToAnalyze);
78
79// 抽出されたコメントを標準出力に表示
80print_r($extractedComments);

PHPのtoken_get_all()関数は、PHPコードの文字列を「トークン」と呼ばれる意味のある最小単位に分解します。T_COMMENTは、このトークンの一つで、PHPのプログラム内で記述された通常のコメント（//、#、/* ... */）を識別するための組み込み定数です。この定数の値は整数型です。同様に、T_DOC_COMMENTは、/** ... */のような、PHPDoc形式のドキュメントコメントを識別するための定数として用意されています。

サンプルコードのextractComments関数は、token_get_all()でPHPコードをトークンに分解し、その中からT_COMMENTやT_DOC_COMMENTと判定された部分だけを抽出する仕組みを示しています。この関数は、引数として解析したいPHPコードの文字列を受け取り、コード内のすべてのコメント文字列を要素とする配列を戻り値として返します。このように、PHPの組み込み定数を利用することで、プログラム的にPHPコードの構造を分析し、特定の要素（ここではコメント）を効率的に取り出すことができます。

Copy
1<?php
2
3/**
4 * PHPコードを字句解析し、検出されたトークン情報を出力します。
5 *
6 * この関数は、`token_get_all()` を使用してPHPのソースコードを個々のトークンに分解し、
7 * 各トークンのID、名前、内容、および行番号を表示します。
8 * 特に、キーワードである `T_ENCAPSED_AND_WHITESPACE` トークンが検出された場合には、
9 * そのことを強調して出力します。
10 *
11 * @param string $code 分析対象となるPHPコードの文字列。
12 */
13function analyzePhpCodeTokens(string $code): void
14{
15    echo "--- 分析対象コード ---\n";
16    echo $code . "\n";
17    echo "----------------------\n";
18
19    // `token_get_all()` 関数は、PHPのソースコードを解析し、トークンの配列を返します。
20    // 各トークンは通常、以下の形式の配列で表現されます。
21    // [トークンID (int), トークン文字列 (string), 行番号 (int)]
22    // また、PHPの演算子や括弧などの単一文字のトークンは、その文字自身が返されます。
23    $tokens = token_get_all($code);
24
25    echo "--- 検出されたトークン ---\n";
26    foreach ($tokens as $token) {
27        if (is_array($token)) {
28            // トークンIDは整数値 (int) です。
29            // `token_name()` 関数は、トークンIDに対応する人間が読める定数名（例: "T_VARIABLE"）を返します。
30            $tokenName = token_name($token[0]);
31            $tokenContent = $token[1];
32            $tokenLine = $token[2];
33
34            // `T_ENCAPSED_AND_WHITESPACE` は、ダブルクォーテーションで囲まれた文字列内で
35            // 変数展開された部分以外のリテラル部分やホワイトスペースを表すトークンです。
36            // 例: `echo "Hello $name!";` の場合、"Hello " や "!" の部分がこれに該当します。
37            if ($token[0] === T_ENCAPSED_AND_WHITESPACE) {
38                echo sprintf(
39                    "  - ID: %d (%s), 内容: '%s', 行: %d [キーワード関連トークン]\n",
40                    $token[0],
41                    $tokenName,
42                    $tokenContent,
43                    $tokenLine
44                );
45            } else {
46                echo sprintf(
47                    "  - ID: %d (%s), 内容: '%s', 行: %d\n",
48                    $token[0],
49                    $tokenName,
50                    $tokenContent,
51                    $tokenLine
52                );
53            }
54        } else {
55            // 単一文字のトークン (例: '{', ';', '=')
56            echo sprintf("  - 内容: '%s'\n", $token);
57        }
58    }
59    echo "--------------------------\n\n";
60}
61
62// サンプルコード1: 変数展開を含む文字列リテラル
63// "Hello " と "!" の部分が `T_ENCAPSED_AND_WHITESPACE` として識別されることがあります。
64$sampleCode1 = '<?php $username = "Alice"; echo "Hello, $username!"; ?>';
65analyzePhpCodeTokens($sampleCode1);
66
67// サンプルコード2: より複雑な変数展開を含む文字列リテラル
68// "Your age is " と " and your height is " と "." の部分が `T_ENCAPSED_AND_WHITESPACE` として識別されます。
69$sampleCode2 = '<?php $age = 30; $height = 175.5; echo "Your age is {$age} and your height is {$height} cm."; ?>';
70analyzePhpCodeTokens($sampleCode2);

このサンプルコードは、PHPの token_get_all() 関数を用いて、与えられたPHPコードを個々の構成要素（トークン）に分解し、その詳細情報を表示する方法を示しています。token_get_all() 関数は、PHPのソースコード文字列を引数として受け取り、解析されたトークンの配列を返します。この配列の各要素は、トークンの種類を示す数値ID、実際のコード内容、そしてコード中の行番号を含む配列、または単一文字（例えば演算子など）のどちらかで表現されます。

特に T_ENCAPSED_AND_WHITESPACE は、ダブルクォーテーションで囲まれた文字列リテラル内で、変数展開される部分以外の静的な文字列や空白文字を表すトークンです。例えば、"Hello $name!" というコードでは、「Hello 」と「!」の部分がこのトークンとして認識されます。token_name() 関数は、トークンの数値IDを引数にとり、それに対応する人間が読みやすい定数名（例: "T_VARIABLE"）を文字列として返します。

この analyzePhpCodeTokens 関数は、分析対象となるPHPコードの文字列を引数 $code として受け取ります。関数内部で解析結果を標準出力に表示するため、特に値を返すことはありません（void）。これにより、PHPがソースコードをどのように内部的に解釈し、処理しているかの基本的な仕組みを視覚的に理解することができます。