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

Copy
1<?php
2
3/**
4 * 指定されたPHPコードから特定のトークン（Null合体演算子、コメント）を解析し表示します。
5 * この関数は、PHPがコードをどのように内部的に解釈し、個々の要素（トークン）に分解するかを示す例です。
6 *
7 * @param string $code 解析するPHPコード文字列
8 */
9function analyzeCodeTokens(string $code): void
10{
11    echo "--- 解析対象のPHPコード ---\n";
12    echo $code . "\n\n";
13
14    echo "--- 検出されたトークン ---\n";
15
16    // token_get_all() を使用してPHPコードをトークンの配列に分解します。
17    // 各トークンは配列または文字列として返されます。
18    // 配列の場合: [0 => トークンID (int), 1 => トークン文字列 (string), 2 => 行番号 (int)]
19    // 文字列の場合: 単一の文字のトークン (例: ';', '=', '{')
20    $tokens = token_get_all("<?php " . $code);
21
22    // 分解されたトークンを一つずつループして確認します。
23    foreach ($tokens as $token) {
24        // トークンが配列形式の場合（定数トークン）
25        if (is_array($token)) {
26            $tokenId = $token[0];      // トークンID (例: T_COALESCE, T_COMMENT)
27            $tokenValue = $token[1];   // トークンの値 (例: '??', '// これはコメント')
28            $lineNumber = $token[2];   // トークンが存在する行番号
29
30            // T_COALESCE (Null合体演算子 '??') を検出
31            if ($tokenId === T_COALESCE) {
32                echo sprintf(
33                    "行 %d: Null合体演算子 (T_COALESCE) を検出: '%s'\n",
34                    $lineNumber,
35                    $tokenValue
36                );
37            }
38            // T_COMMENT (コメント) を検出
39            elseif ($tokenId === T_COMMENT) {
40                echo sprintf(
41                    "行 %d: コメント (T_COMMENT) を検出: '%s'\n",
42                    $lineNumber,
43                    $tokenValue
44                );
45            }
46        }
47    }
48    echo "---------------------------\n";
49}
50
51// サンプルコードとして、Null合体演算子とコメントを含むPHPコードを定義します。
52$sampleCode = <<<'EOD'
53// これは単一行コメントです
54$name = $_GET['user'] ?? 'Guest'; // こちらもコメントです
55
56/*
57 * これは複数行コメントの例です。
58 * $config['version'] ??= '1.0'; // PHP 8.0以降のNull合体代入演算子もトークンの一部
59 */
60$value = null;
61$result = $value ?? 'Default'; // 別のNull合体演算子
62EOD;
63
64// 定義したPHPコードを解析関数に渡して実行します。
65analyzeCodeTokens($sampleCode);
66
67// 参考：T_COALESCE は int 型の定数であり、その値を確認できます。
68// PHPの内部でトークンとして '??' を識別するために使用されます。
69// echo "\nT_COALESCE の値: " . T_COALESCE . " (トークン名: " . token_name(T_COALESCE) . ")\n";
70// echo "T_COMMENT の値: " . T_COMMENT . " (トークン名: " . token_name(T_COMMENT) . ")\n";
71
72?>

このPHPコードは、指定されたPHPの文字列を内部的な「トークン」という小さな構成要素に分解し、その中から特定のコード要素を検出して表示するものです。T_COALESCEはNull合体演算子??を識別するための定数で、T_COMMENTはPHPコード内のコメント部分を識別するための定数です。どちらの定数も引数はなく、PHPが内部でこれらの要素を識別するために使用する整数値を返します。

サンプルコードのanalyzeCodeTokens関数は、token_get_all()関数を用いて入力されたPHPコードをトークンの配列に変換します。この配列には、各トークンの種類を示すID（例えばT_COALESCEやT_COMMENT）、実際のコード文字列、そして行番号が含まれています。プログラムは、分解されたトークンを一つずつ確認し、Null合体演算子??が使われている箇所をT_COALESCEとして、コメント部分をT_COMMENTとして識別します。そして、それぞれの検出されたトークンの種類と内容を行番号とともに画面に出力します。

この動作を通じて、PHPがコードを読み込み、個々の意味のある部分（トークン）に分解し、それらを内部的にどのように認識しているのかを具体的に理解できます。これにより、システムの内部処理を学ぶ上で非常に役立つでしょう。

Copy
1<?php
2
3/**
4 * PHPコードを解析し、特定のトークンを検出して表示します。
5 *
6 * この関数は、PHPのコードがどのように小さな意味のある単位（トークン）に分解されるかを示します。
7 * システムエンジニアを目指す初心者の方々が、言語の内部動作を理解する第一歩として役立ちます。
8 *
9 * @param string $phpCode 解析するPHPコード文字列。必ず `<?php` タグから始める必要があります。
10 */
11function analyzePhpCodeTokens(string $phpCode): void
12{
13    echo "--- PHPコードトークン解析 ---" . PHP_EOL;
14    echo "解析対象コード:" . PHP_EOL;
15    echo "```php" . PHP_EOL;
16    echo $phpCode . PHP_EOL;
17    echo "```" . PHP_EOL . PHP_EOL;
18
19    // token_get_all() は、与えられたPHPコードをトークンの配列に分解します。
20    // 各トークンは、PHPの文法を構成する最小の意味単位（キーワード、演算子、文字列など）を表します。
21    $tokens = token_get_all($phpCode);
22
23    echo "検出された特定のトークン:" . PHP_EOL;
24    $foundTokens = false;
25
26    foreach ($tokens as $token) {
27        // トークンは、ID（整数）、値（文字列）、行番号（整数）を含む配列、
28        // または単一の文字（例: ';' や ',' などの記号）のいずれかです。
29        if (is_array($token)) {
30            // token_name() は、トークンID（整数）を人間が読める名前に変換します。
31            $tokenName = token_name($token[0]);
32            $tokenValue = $token[1];
33            $tokenLine = $token[2];
34
35            // T_COALESCE は、Null合体演算子 (??) に対応するトークンです。
36            // 変数が未定義またはnullの場合にデフォルト値を設定する際に使用されます。
37            if ($token[0] === T_COALESCE) {
38                echo "- " . $tokenName . " (Null合体演算子 '??') 検出！" . PHP_EOL;
39                echo "  値: '" . $tokenValue . "'" . PHP_EOL;
40                echo "  行番号: " . $tokenLine . PHP_EOL;
41                // T_COALESCE はPHPが内部的に使用する整数定数です。
42                echo "  T_COALESCE 定数値: " . T_COALESCE . " (型: int)" . PHP_EOL . PHP_EOL;
43                $foundTokens = true;
44            }
45
46            // T_CONSTANT_ENCAPSED_STRING は、シングルクォートまたはダブルクォートで囲まれた
47            // 文字列リテラル（例: 'hello', "world"）を表すトークンです。
48            if ($token[0] === T_CONSTANT_ENCAPSED_STRING) {
49                echo "- " . $tokenName . " (文字列リテラル '...' または \"...\") 検出！" . PHP_EOL;
50                echo "  値: " . $tokenValue . PHP_EOL;
51                echo "  行番号: " . $tokenLine . PHP_EOL;
52                // T_CONSTANT_ENCAPSED_STRING はPHPが内部的に使用する整数定数です。
53                echo "  T_CONSTANT_ENCAPSED_STRING 定数値: " . T_CONSTANT_ENCAPSED_STRING . " (型: int)" . PHP_EOL . PHP_EOL;
54                $foundTokens = true;
55            }
56        }
57    }
58
59    if (!$foundTokens) {
60        echo "  指定されたトークンは検出されませんでした。" . PHP_EOL;
61    }
62
63    echo "--- 解析終了 ---" . PHP_EOL;
64}
65
66// 解析対象のPHPコードを文字列として定義します。
67// ここには Null合体演算子 (??) と文字列リテラル ('...' と "...") の両方が含まれています。
68// heredoc構文を使用して、複数行のコードを読みやすく記述しています。
69$codeToAnalyze = <<<'EOD'
70<?php
71
72// T_COALESCE (Null合体演算子) の例:
73// $_GET['user'] が設定されていないか null の場合、'Guest' が $username に代入されます。
74$username = $_GET['user'] ?? 'Guest';
75
76// T_CONSTANT_ENCAPSED_STRING (文字列リテラル) の例:
77// ダブルクォートで囲まれた文字列
78$greeting = "Hello, " . $username . "!";
79
80// シングルクォートで囲まれた文字列
81$status = 'Active';
82
83if ($status === 'Active') {
84    echo $greeting;
85}
86
87?>
88EOD;
89
90// 上記で定義したPHPコード文字列を解析する関数を実行します。
91analyzePhpCodeTokens($codeToAnalyze);
92

このサンプルコードは、PHPのソースコードがどのように小さな意味のある単位、つまり「トークン」に分解されるかを示すものです。システムエンジニアを目指す初心者の方が、プログラミング言語の内部的な動きを理解する一助となります。

analyzePhpCodeTokens関数は、引数として渡されたPHPコード文字列（$phpCode）をtoken_get_all()関数を使って解析し、そのコードを構成するトークンの配列を取得します。この関数は解析結果を画面に出力するだけで、特定の値を返しません（戻り値はvoidです）。

コード内で特に注目するのは、T_COALESCEとT_CONSTANT_ENCAPSED_STRINGという二つのPHP内部定数です。T_COALESCEはPHP 7で導入されたNull合体演算子（??）を識別するための整数定数であり、変数が未定義またはnullの場合にデフォルト値を設定する際に使用されます。一方、T_CONSTANT_ENCAPSED_STRINGは、シングルクォートまたはダブルクォートで囲まれた文字列リテラル（例: 'Hello'や"World"）を識別するための整数定数です。これらの定数は、token_name()関数と組み合わせることで、PHPがコードの各部分をどのように認識しているかを知る手がかりとなります。このコードは、指定されたPHPコードの中からこれらのトークンを見つけ出し、その種類、値、そしてコード中の行番号を表示します。これにより、PHPが内部的にコードを解析する際の仕組みを視覚的に理解できます。