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

Copy
1<?php
2
3/**
4 * 指定されたPHPコード文字列を解析し、特定のトークン（T_BREAK, T_STRING）を検出して表示します。
5 * システムエンジニアを目指す初心者向けに、PHPコードがどのようにトークンに分解されるかを示します。
6 *
7 * @param string $code 解析対象のPHPコード文字列。
8 */
9function analyzeCodeTokensForBeginners(string $code): void
10{
11    echo "--- PHPコードトークン解析 (初心者向け) ---" . PHP_EOL;
12    echo "以下のPHPコードを解析します:" . PHP_EOL;
13    echo "```php" . PHP_EOL;
14    echo $code . PHP_EOL;
15    echo "```" . PHP_EOL . PHP_EOL;
16
17    // PHP 8 で導入された PhpToken::tokenize() を使用して、コードをトークンの配列に分解します。
18    // 各トークンは PhpToken オブジェクトとして扱われます。
19    $tokens = PhpToken::tokenize($code);
20
21    echo "検出された特定のトークン:" . PHP_EOL;
22    foreach ($tokens as $token) {
23        // T_BREAK: 'break' キーワードを表すトークンです。
24        // ループや switch 文から抜け出すために使用されます。
25        if ($token->id === T_BREAK) {
26            echo "  [T_BREAK]    'break'キーワードを検出しました。"
27                . " (ID: {$token->id}, 名前: {$token->tokenName()}, 値: '{$token->text}', 行: {$token->line})" . PHP_EOL;
28        }
29        // T_STRING: 変数名、関数名、クラス名、定数名など、様々な識別子を表すトークンです。
30        // コード内のユーザー定義の名前やPHPの組み込み関数名などがこれに該当します。
31        else if ($token->id === T_STRING) {
32            echo "  [T_STRING]   識別子（文字列）を検出しました。"
33                . " (ID: {$token->id}, 名前: {$token->tokenName()}, 値: '{$token->text}', 行: {$token->line})" . PHP_EOL;
34        }
35    }
36    echo PHP_EOL;
37    echo "補足:" . PHP_EOL;
38    echo "- T_BREAK は、PHPの 'break' 文を表すトークン定数です。" . PHP_EOL;
39    echo "- T_STRING は、関数名やクラス名、PHPの組み込み関数名などの文字列リテラル（識別子）を表すトークン定数です。" . PHP_EOL;
40    echo "- PHPのパーサーは、このようなトークンを使ってコードの構造を理解します。" . PHP_EOL;
41}
42
43// 解析対象となるPHPコードのサンプル
44// break文と、T_STRINGに該当するいくつかの要素（例: 関数名、echoなど）を含みます。
45$sampleCode = <<<'EOD'
46<?php
47// PHPスクリプトの開始タグ
48
49/**
50 * 指定回数ループし、特定の条件でループを中断する関数です。
51 * 関数名 'performLoopAndBreak' は T_STRING に該当します。
52 */
53function performLoopAndBreak()
54{
55    $limit = 10;
56    for ($i = 0; $i < $limit; $i++) {
57        if ($i === 5) {
58            echo "条件が満たされたため、ループを中断します。\n"; // 'echo' は T_STRING に該当します。
59            break; // ここが T_BREAK に該当します。
60        }
61        echo "現在の繰り返し: " . $i . "\n";
62    }
63}
64
65// 関数を呼び出します。関数名 'performLoopAndBreak' は再度 T_STRING として検出されます。
66performLoopAndBreak();
67
68?>
69EOD;
70
71// 解析関数を呼び出して実行
72analyzeCodeTokensForBeginners($sampleCode);

このPHPサンプルコードは、PHP 8で導入されたPhpToken::tokenize()関数を使用して、指定されたPHPコード文字列を内部的に「トークン」と呼ばれる小さな構成要素に分解し、特定のトークンを検出して表示する方法を示します。システムエンジニアを目指す初心者の方に、PHPがコードをどのように理解しているかの基礎を説明します。

analyzeCodeTokensForBeginners関数は、$codeという文字列引数に解析対象のPHPコードを受け取ります。この関数は画面に解析結果を出力し、明示的な戻り値は持ちません（void）。関数内でPhpToken::tokenize($code)を呼び出すことで、入力されたPHPコードはPhpTokenオブジェクトの配列に変換されます。

ループ処理で各トークンを確認し、T_BREAKまたはT_STRINGを検出した場合に詳細情報を表示します。T_BREAKはPHPのbreakキーワードに対応するトークン定数であり、ループやswitch文の実行を中断するために使用されます。一方、T_STRINGは関数名、変数名、クラス名、定数名、あるいはechoなどのキーワードを含む、様々な識別子を表すトークン定数です。例えば、サンプルコード内のperformLoopAndBreak関数名やechoキーワードがこれに該当します。このコードは、PHPの内部処理がソースコードをどのように解釈し、構文を理解しているかの一端を視覚的に示しています。

Copy
1<?php
2
3/**
4 * PHPコードを解析し、特定のトークン（T_BREAK, T_VARIABLE）を検出して表示します。
5 *
6 * システムエンジニア初心者向けに、PHPが内部的にコードをどのように
7 * トークンに分解するかを示します。T_BREAKは'break'キーワード、
8 * T_VARIABLEは'$'で始まる変数名を表します。
9 *
10 * @param string $code 解析対象のPHPソースコード文字列。
11 * @return void
12 */
13function analyzePhpCodeTokens(string $code): void
14{
15    echo "--- 解析対象のPHPコード ---\n";
16    echo $code . "\n";
17    echo "---------------------------\n\n";
18
19    // token_get_all() 関数は、PHPソースコードをトークンに分割します。
20    // 各トークンは配列（タイプ、値、行番号）または単一文字（演算子など）で構成されます。
21    $tokens = token_get_all($code);
22
23    echo "--- 検出されたトークン ---\n";
24    foreach ($tokens as $token) {
25        if (is_array($token)) {
26            // トークンが配列の場合 (例: [T_VARIABLE, '$myVar', 3])
27            $tokenName = token_name($token[0]); // トークンIDを人間が読める名前に変換
28            $tokenValue = $token[1];
29            $lineNumber = $token[2];
30
31            echo sprintf(
32                "  - 行 %d: タイプ '%s' (ID: %d), 値: '%s'",
33                $lineNumber,
34                $tokenName,
35                $token[0],
36                $tokenValue
37            );
38
39            // T_BREAK（'break'キーワード）とT_VARIABLE（変数）を特に強調表示
40            if ($token[0] === T_BREAK) {
41                echo " <<< T_BREAK を検出しました！";
42            } elseif ($token[0] === T_VARIABLE) {
43                echo " <<< T_VARIABLE を検出しました！";
44            }
45            echo "\n";
46        } else {
47            // トークンが文字列の場合 (例: ';', '=', '{')
48            echo sprintf("  - タイプ: 演算子/記号, 値: '%s'\n", $token);
49        }
50    }
51    echo "---------------------------\n";
52}
53
54// 解析するPHPコードの例
55$samplePhpCode = <<<'PHP_CODE'
56<?php
57$counter = 0; // $counter は T_VARIABLE
58for ($i = 0; $i < 5; $i++) {
59    if ($i === 3) {
60        echo "3に到達したのでループを中断します。\n";
61        break; // ここで T_BREAK が検出されます
62    }
63    $counter++; // $counter は T_VARIABLE
64}
65echo "最終的なカウンターの値: " . $counter . "\n";
66PHP_CODE;
67
68// 関数を呼び出し、サンプルコードを解析します
69analyzePhpCodeTokens($samplePhpCode);
70

このコードは、PHPがソースコードをどのように解釈しているかを示すものです。PHPは、実行前にコードを「トークン」と呼ばれる小さな要素に分解します。token_get_all()関数は、この分解プロセスを実行し、各トークンの情報（タイプ、値、行番号）を配列として取得します。

本サンプルコードでは、analyzePhpCodeTokens関数がその役割を担います。この関数は、引数$codeとして渡されたPHPソースコード文字列を解析対象とします。そして、分解されたトークンを一つずつ確認し、その詳細を表示します。特に、T_BREAK（breakキーワード）とT_VARIABLE（$で始まる変数名）というPHPの内部定数を検出した場合に、その情報を強調して表示します。

T_BREAKやT_VARIABLEは、PHPが特定のキーワードや構造を識別するために内部的に使用する数値IDです。この関数は、そうしたトークンIDをtoken_name()関数で人間が読める名前に変換しています。analyzePhpCodeTokens関数の戻り値はvoidであり、解析結果は直接画面に出力されるだけで、関数自体は特定の値を返しません。これにより、PHPがコードを構成する要素をどのように識別しているかを視覚的に学ぶことができます。