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

Copy
1<?php
2
3/**
4 * 指定されたPHPコード文字列から変数名（例: $name）を抽出する関数。
5 *
6 * この関数は、PHPのソースコードを構成する個々の要素（トークン）に分解し、
7 * その中から変数を示すトークン（T_VARIABLE）を識別します。
8 * システムエンジニアを目指す初心者の方が、PHPコードの内部構造を理解する
9 * 一助となることを意図しています。
10 *
11 * @param string $phpCode 解析するPHPコード文字列。
12 * @return array 見つかった変数名の配列（重複は排除されます）。
13 */
14function extractVariableNames(string $phpCode): array
15{
16    $variableNames = [];
17
18    // token_get_all() は、PHPコードをトークン（要素）の配列に分解します。
19    // 各トークンは、その種類（例: T_VARIABLE）、内容（例: '$myVar'）、行番号などを含む配列です。
20    // または、単一文字の演算子（例: '+', ';'）の場合は文字列として返されます。
21    $tokens = token_get_all($phpCode);
22
23    foreach ($tokens as $token) {
24        // トークンが配列形式の場合（トークンID、内容、行番号）のみ処理します。
25        // 単一文字のトークン（例: ';', '('）は文字列として返されるため、スキップします。
26        if (is_array($token)) {
27            // $token[0] にはトークンIDが含まれます。
28            // T_VARIABLE は、PHPの変数（例: $foo）を表すトークン定数です。
29            if ($token[0] === T_VARIABLE) {
30                // $token[1] にはトークンの内容（変数名そのもの、例: '$name'）が含まれます。
31                $variableNames[] = $token[1];
32            }
33        }
34    }
35
36    // 重複する変数名を排除し、ユニークなリストを返します。
37    return array_unique($variableNames);
38}
39
40// 例として解析するPHPコードを定義します。
41$samplePhpCode = <<<'EOT'
42<?php
43/**
44 * これはPHPのサンプルコードです。
45 * 変数や簡単な演算が含まれています。
46 */
47
48$greeting = "Hello"; // 文字列型の変数
49$target = "World";   // 別の文字列型の変数
50
51// 複数の変数を組み合わせてメッセージを作成します。
52$message = $greeting . ", " . $target . "!";
53
54echo $message; // $message を出力
55
56// 数値型の変数
57$number1 = 10;
58$number2 = 20;
59$sum = $number1 + $number2; // $number1 と $number2 の和を変数 $sum に代入
60
61// 同じ変数が複数回現れても、結果はユニークになります。
62$greeting = "こんにちは"; // $greeting が再度登場
63
64EOT;
65
66// 関数を呼び出し、コード内の変数名を取得します。
67$foundVariables = extractVariableNames($samplePhpCode);
68
69echo "--- 解析対象のPHPコード ---" . PHP_EOL;
70echo $samplePhpCode . PHP_EOL;
71echo "--------------------------" . PHP_EOL;
72
73echo "コード内で見つかった変数名:" . PHP_EOL;
74if (empty($foundVariables)) {
75    echo "  - 変数は見つかりませんでした。" . PHP_EOL;
76} else {
77    foreach ($foundVariables as $variable) {
78        echo "  - " . $variable . PHP_EOL;
79    }
80}
81
82?>

このPHPサンプルコードは、与えられたPHPのソースコード文字列の中から、使用されている変数名（例: $myVar）をすべて抽出し、リストアップする関数 extractVariableNames を示しています。

この関数は、PHPの token_get_all() 関数を利用して、PHPコードを構成する個々の要素（トークン）に分解します。その後、分解されたトークン一つ一つを調べ、その種類がPHPの変数を示す特別な定数である T_VARIABLE に一致するかどうかを確認します。T_VARIABLE は、$foo のような変数をPHPが内部で識別するためのIDです。

関数 extractVariableNames は、解析したいPHPコードの文字列を引数 $phpCode として受け取ります。そして、見つかった変数トークンの内容（$name のような変数名そのもの）を収集し、重複する変数名を排除した上で、ユニークな変数名の配列を戻り値として返します。このコードを通じて、PHPコードがどのように内部で解析され、変数が識別されるかの仕組みを理解する一助となります。

Copy
1<?php
2
3/**
4 * 指定されたPHPファイルのコードを解析し、特定のトークン（定数）を検出して表示します。
5 * T_LOGICAL_XOR（論理XOR演算子）とT_COMMENT（コメント）の検出例を示します。
6 *
7 * @param string $filePath 解析対象のPHPファイルのパス
8 * @return void
9 */
10function analyzeCodeTokens(string $filePath): void
11{
12    // ファイルの内容を読み込む
13    $code = file_get_contents($filePath);
14
15    if ($code === false) {
16        echo "エラー: ファイルを読み込めませんでした。" . PHP_EOL;
17        return;
18    }
19
20    // コードをトークンに分解する
21    // token_get_all() はPHPソースコードをPHPのレキシカルアナライザが認識するトークンの配列に分解します。
22    // 各トークンは単一の文字列（例: '{', '}', ';') か、
23    // あるいは配列（[トークンID, トークンの文字列, 行番号]）の形式を取ります。
24    $tokens = token_get_all($code);
25
26    echo "--- PHPコードのトークン分析 ---" . PHP_EOL;
27    echo "ファイル: " . basename($filePath) . PHP_EOL . PHP_EOL;
28
29    $foundLogicalXor = false;
30    $foundComment = false;
31
32    foreach ($tokens as $token) {
33        // トークンが配列形式の場合（PHPのキーワード、定数、変数名、コメントなど）
34        if (is_array($token)) {
35            // トークンIDから人間が読める名前を取得（例: T_LOGICAL_XOR → 'T_LOGICAL_XOR'）
36            $tokenName = token_name($token[0]);
37            // トークンの実際の文字列内容（例: 'xor', '/* コメント */'）
38            $tokenContent = $token[1];
39            // トークンが出現した行番号
40            $lineNumber = $token[2];
41
42            // T_LOGICAL_XOR（論理XOR演算子 'xor'）を検出
43            if ($token[0] === T_LOGICAL_XOR) {
44                echo "検出: 論理XOR演算子 ({$tokenName}) - 内容: '{$tokenContent}', 行: {$lineNumber}" . PHP_EOL;
45                $foundLogicalXor = true;
46            }
47
48            // T_COMMENT（コメント //, #, /* ... */）を検出
49            if ($token[0] === T_COMMENT) {
50                echo "検出: コメント ({$tokenName}) - 内容: '{$tokenContent}', 行: {$lineNumber}" . PHP_EOL;
51                $foundComment = true;
52            }
53        }
54        // 単一文字のトークン（例: '{', ';', '='）は配列ではないため、ここではスキップされます。
55    }
56
57    if (!$foundLogicalXor) {
58        echo "情報: このコード内で 'xor' 演算子 (T_LOGICAL_XOR) は見つかりませんでした。" . PHP_EOL;
59    }
60    if (!$foundComment) {
61        echo "情報: このコード内でコメント (T_COMMENT) は見つかりませんでした。" . PHP_EOL;
62    }
63
64    echo PHP_EOL . "--- 分析終了 ---" . PHP_EOL;
65}
66
67// このスクリプトファイル自身を解析対象とします。
68// __FILE__ マジック定数は、現在のスクリプトファイルの完全なパスとファイル名を保持します。
69analyzeCodeTokens(__FILE__);
70
71// ここに 'xor' 演算子とコメントの例を記述することで、
72// 上記の関数がこれらを検出する様子を確認できます。
73$a = true;
74$b = false;
75$result = $a xor $b; // この行の 'xor' は T_LOGICAL_XOR として検出されます
76
77/*
78 * これは複数行のコメントです。
79 * このコメント全体が T_COMMENT として検出されます。
80 */
81
82// これは単一行のコメントです。T_COMMENT として検出されます。
83# こちらも単一行コメントです。T_COMMENT として検出されます。

このPHPサンプルコードは、指定されたPHPファイルを解析し、コード内の特定の要素（トークン）を検出する方法を示しています。analyzeCodeTokens関数は、解析対象のPHPファイルのパスを文字列（$filePath）として受け取り、特に値を返しません（void）。関数内部では、まずfile_get_contents()でファイルの内容を読み込み、次にtoken_get_all()関数を使用してそのPHPコードを、PHPがコードを認識する最小単位であるトークンの配列に分解します。

分解された各トークンは、その種類（トークンID）、内容、出現行番号の情報を持っています。このコードでは、PHPの内部定数であるT_LOGICAL_XORとT_COMMENTに注目しています。T_LOGICAL_XORは論理XOR演算子であるxorキーワードに対応するトークンIDであり、T_COMMENTは//、#、/* ... */といったPHPのコメント全般に対応するトークンIDを表します。ループ処理で各トークンを検査し、これらの定数とトークンIDが一致する場合に、そのトークンの種類、内容、出現行番号を画面に表示します。

最終的に、このスクリプトファイル自体をanalyzeCodeTokens関数で解析することで、コード内に記述されたxor演算子や各種コメントが実際に検出される様子を確認できます。これにより、PHPがどのようにソースコードを内部的に処理しているかの一端を理解する手助けとなるでしょう。