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

Copy
1<?php
2
3/**
4 * 指定されたPHPコード文字列を解析し、'while' キーワードの出現を検出します。
5 * T_WHILE 定数は、PHPの字句解析器が 'while' キーワードを認識した際に割り当てるIDです。
6 *
7 * @param string $code 解析するPHPコード文字列。
8 */
9function detectWhileKeywordInCode(string $code): void
10{
11    echo "--- コード解析開始 ---\n";
12    echo "対象コード:\n" . $code . "\n";
13
14    // PHP 8以降では PhpToken::tokenize() を使用してコードをトークンに分解します。
15    // 各トークンは PhpToken クラスのオブジェクトとして表現されます。
16    $tokens = PhpToken::tokenize($code);
17
18    $foundWhile = false;
19
20    // 分解された各トークンをループして調べます。
21    foreach ($tokens as $token) {
22        // 各トークンオブジェクトは 'id' プロパティを持ち、これがトークンの種類を表します。
23        // T_WHILE 定数は 'while' キーワードのトークンIDです。
24        if ($token->id === T_WHILE) {
25            echo "行番号 {$token->line}: 'while' キーワード ('{$token->text}') が見つかりました。\n";
26            $foundWhile = true;
27        }
28    }
29
30    if (!$foundWhile) {
31        echo "このコードには 'while' キーワードは見つかりませんでした。\n";
32    }
33    echo "--- コード解析終了 ---\n\n";
34}
35
36// サンプルPHPコード1: 'while' キーワードを含む
37$sampleCodeWithWhile = <<<'PHP'
38<?php
39$i = 0;
40while ($i < 3) {
41    echo "現在の値: " . $i . "\n";
42    $i++;
43}
44?>
45PHP;
46
47// サンプルPHPコード2: 'while' キーワードを含まない
48$sampleCodeWithoutWhile = <<<'PHP'
49<?php
50function calculateSum(int $a, int $b): int
51{
52    return $a + $b;
53}
54echo "合計: " . calculateSum(5, 10) . "\n";
55?>
56PHP;
57
58// 関数を実行して、各サンプルコードで 'while' キーワードが検出されるか確認します。
59detectWhileKeywordInCode($sampleCodeWithWhile);
60detectWhileKeywordInCode($sampleCodeWithoutWhile);

T_WHILEはPHP 8以降で利用可能な定数で、PHPのプログラムコードを解析する際に「while」というキーワードを識別するために使われます。この定数は整数値（int型）を持っており、PHPの内部的な仕組みである字句解析器がコード内のwhileキーワードを見つけた際に、それを表すトークンに割り当てる特別な識別子として機能します。

提供されたサンプルコードでは、detectWhileKeywordInCode関数が指定されたPHPコード文字列を受け取り、PhpToken::tokenize()関数を用いてコードを構成する小さな単位である「トークン」の集合に分解しています。その後、分解された各トークンを一つずつ検査し、そのトークンが持つIDがT_WHILE定数と一致するかどうかを判定することで、元のコードにwhileキーワードが含まれているかを検出しています。これは、例えば特定の制御構造がコード内に存在するかどうかをプログラムで確認したい場合に非常に有効な手法です。

T_WHILE定数自体は引数を持ちません。これは特定の機能を実行する関数ではなく、whileキーワードの種類を示すための固定値であるためです。このように、PHPの内部で定義されているT_で始まる定数群は、コードの構造をプログラムから理解し、静的解析ツールなどを開発する際に活用されます。システムエンジニアにとって、コードの振る舞いを深く理解する上でこのような定数の知識は役立ちます。

Copy
1<?php
2
3/**
4 * PHPコードスニペットを解析し、T_WHILEトークン（'while'キーワード）の検出方法を示す関数。
5 *
6 * T_WHILE定数は、PHPのトークン化処理において、'while' キーワードを表す数値IDです。
7 * この関数は、token_get_all()関数を使用してPHPのソースコードを個々のトークンに分解し、
8 * 各トークンの種類（ID）、内容、行番号を特定します。
9 *
10 * @param string $code 解析対象のPHPコード文字列。
11 */
12function detectTWhileToken(string $code): void
13{
14    echo "--- 解析対象のPHPコード ---\n";
15    echo $code . "\n\n";
16
17    echo "--- T_WHILEトークンの検出結果 ---\n";
18
19    // token_get_all()関数は、有効なPHPコードを引数に取ります。
20    // そのため、解析したいコードスニペットの前に '<?php ' を付与します。
21    $tokens = token_get_all("<?php " . $code);
22
23    $foundWhile = false;
24
25    foreach ($tokens as $token) {
26        // token_get_all()の戻り値は、単一文字のトークン（例: '{', ';')は文字列、
27        // それ以外のトークン（キーワード、変数名など）は配列 [トークンID, 内容, 行番号] となります。
28        if (is_array($token) && $token[0] === T_WHILE) {
29            echo "  T_WHILEトークンを検出しました。\n";
30            // token_name()関数でトークンIDを人間が読める名前に変換できます。
31            echo "    ID: " . $token[0] . " (" . token_name($token[0]) . ")\n";
32            echo "    内容: '" . $token[1] . "'\n";
33            echo "    行番号: " . $token[2] . "\n";
34            $foundWhile = true;
35        }
36    }
37
38    if (!$foundWhile) {
39        echo "  解析対象コードに T_WHILEトークン（'while'キーワード）は見つかりませんでした。\n";
40    }
41    echo "\n"; // 結果の視認性向上のための改行
42}
43
44// 'while' キーワードを含むPHPコードの例
45$codeWithWhile = <<<'EOD'
46$i = 0;
47while ($i < 3) {
48    echo "Iteration: " . $i . PHP_EOL;
49    $i++;
50}
51EOD;
52
53// 'while' キーワードを含まないPHPコードの例
54$codeWithoutWhile = <<<'EOD'
55for ($j = 0; $j < 2; $j++) {
56    echo "Loop: " . $j . PHP_EOL;
57}
58EOD;
59
60// サンプル関数の実行
61detectTWhileToken($codeWithWhile);
62detectTWhileToken($codeWithoutWhile);
63
64?>

PHPのT_WHILE定数は、PHPのソースコードが内部的にどのように解釈されるかを示す特殊な定数の一つです。これは、whileというキーワードがコード中に現れた際に、PHPのパーサーがそれを識別するために用いる数値IDを表します。この定数自体は引数を持たず、整数値を返します。

提供されたサンプルコードは、T_WHILE定数を利用して、与えられたPHPコード文字列の中からwhileキーワードを検出する方法を具体的に示しています。detectTWhileToken関数は、解析したいPHPコードをtoken_get_all()関数に渡します。token_get_all()は、PHPのソースコードを意味のある「トークン」（キーワード、変数名、演算子など）の配列に分解して返します。この配列には、各トークンの種類を示すID、内容、そしてコード中の行番号が含まれています。

関数内では、これらのトークンを一つずつ確認し、そのトークンIDがT_WHILE定数と一致するかどうかを調べています。一致が見つかれば、それは元のコードにwhileキーワードが存在することを意味します。T_WHILEは数値ですが、token_name()関数を使うことで「T_WHILE」という分かりやすい名前に変換して表示できることも示されています。この仕組みは、PHPのコード分析ツールやシンタックスハイライト機能などで活用されており、PHPがコードをどのように「読んでいる」かを理解する上で役立ちます。