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

Copy
1<?php
2
3/**
4 * PHPコード文字列を解析し、特定のトークン (T_ENDSWITCH, T_ENCAPSED_AND_WHITESPACE) を検出して表示します。
5 * システムエンジニアを目指す初心者向けに、PHPのトークン解析の基本を示します。
6 *
7 * @param string $phpCode 解析対象のPHPコード文字列
8 */
9function analyzePhpCodeForSpecificTokens(string $phpCode): void
10{
11    // token_get_all() 関数を使用して、PHPコードをトークン（要素）の配列に分解します。
12    // 各トークンは、その種類（ID）、内容、および行番号を含む配列、
13    // または単一の文字（オペレータや区切り文字など）として返されます。
14    $tokens = token_get_all($phpCode);
15
16    echo "--- PHPコードトークン解析結果 ---\n";
17
18    foreach ($tokens as $token) {
19        // トークンが配列形式の場合（PHPのキーワード、変数、定数など）
20        if (is_array($token)) {
21            $tokenId = $token[0];    // トークンID (例: T_ENDSWITCH の場合は 356)
22            $tokenValue = $token[1]; // トークンの実際の文字列 (例: 'endswitch;')
23            $tokenLine = $token[2];  // トークンが見つかった行番号
24
25            // T_ENDSWITCH は switch/case ブロックの代替構文 (endswitch;) の終了を示すトークンです。
26            // 通常の {} 構文では T_CLOSE_CURLY が使用されますが、代替構文でこのトークンが現れます。
27            if ($tokenId === T_ENDSWITCH) {
28                echo sprintf(
29                    "検出: T_ENDSWITCH (ID: %d) - 内容: '%s' - 行: %d\n",
30                    $tokenId,
31                    $tokenValue,
32                    $tokenLine
33                );
34                echo "  -> これは 'switch (...): ... endswitch;' の 'endswitch;' 部分に対応します。\n";
35            }
36            // T_ENCAPSED_AND_WHITESPACE は、ダブルクォーテーションで囲まれた文字列内における、
37            // 変数展開されない静的な文字列部分や空白文字を示します。
38            // 例: "$var text here" の " text here" の部分。
39            elseif ($tokenId === T_ENCAPSED_AND_WHITESPACE) {
40                echo sprintf(
41                    "検出: T_ENCAPSED_AND_WHITESPACE (ID: %d) - 内容: '%s' - 行: %d\n",
42                    $tokenId,
43                    $tokenValue,
44                    $tokenLine
45                );
46                echo "  -> これはダブルクォーテーション文字列内（例: \"Hello \$name, this is a message.\"）で\n";
47                echo "     変数の後に続く静的な文字列部分や空白 (' this is a message.') を示します。\n";
48            }
49            // その他のトークンも表示したい場合は、ここに条件を追加できます。
50            // 例: echo sprintf("トークン: %s ('%s') - 行: %d\n", token_name($tokenId), $tokenValue, $tokenLine);
51        }
52        // トークンが単一の文字（例: '=', ';', '{', '}' など）の場合
53        // else {
54        //     echo sprintf("文字トークン: '%s'\n", $token);
55        // }
56    }
57    echo "----------------------------\n";
58}
59
60// 解析対象のPHPコード文字列を定義します。
61// T_ENDSWITCH を生成するために、switch文の代替構文 (endswitch;) を含めます。
62// T_ENCAPSED_AND_WHITESPACE を生成するために、ダブルクォーテーション内に変数と静的文字列を含めます。
63$examplePhpCode = <<< 'EOT'
64<?php
65$username = "Alice";
66$greeting = "Hello $username, welcome to the system.";
67
68switch (true):
69    case ($username === "Alice"):
70        echo "ユーザーはAliceです。\n";
71        break;
72    default:
73        echo "不明なユーザーです。\n";
74        break;
75endswitch; // この 'endswitch;' が T_ENDSWITCH に対応します
76?>
77EOT;
78
79// 定義したPHPコードを解析する関数を実行します。
80analyzePhpCodeForSpecificTokens($examplePhpCode);

PHPのトークン解析の基本を示すこのサンプルコードは、token_get_all()関数を使用して、与えられたPHPコード文字列を意味のある最小単位である「トークン」の配列に分解します。これにより、PHPコードが内部的にどのように構成されているかを確認できます。

特にT_ENDSWITCHは、switch文の代替構文であるswitch (...): ... endswitch;におけるendswitch;部分に対応する整数値の定数です。これは、特定のswitchブロックの終わりを示す役割を果たします。引数はなく、戻り値は整数型です。

また、T_ENCAPSED_AND_WHITESPACEは、ダブルクォーテーションで囲まれた文字列（例: "Hello $name, welcome."）において、変数展開された後に続く静的な文字列部分や空白文字（上記の例では", welcome."）を示すトークンです。

これらのトークンを検出することで、PHPの構文がどのように処理され、文字列がどのように解析されるかを学ぶことができます。システムエンジニアを目指す方にとって、PHPコードの内部動作を理解する上での一助となるでしょう。

Copy
1<?php
2
3/**
4 * 指定された果物の種類に基づいてメッセージを表示します。
5 * この関数は、PHPのswitch文の代替構文（endswitch;）の使用例を示します。
6 * T_ENDSWITCHは、このendswitchキーワードがPHPの内部でコード解析時に使われるトークン定数に関連します。
7 *
8 * @param string $fruitName 調べたい果物の名前
9 * @return void
10 */
11function describeFruit(string $fruitName): void
12{
13    echo "果物: {$fruitName} -> ";
14
15    // switch文の代替構文を使用
16    switch ($fruitName):
17        case 'apple':
18            echo "これは美味しいリンゴです。\n";
19            break;
20        case 'banana':
21            echo "これは甘いバナナです。\n";
22            break;
23        case 'grape':
24            echo "これはジューシーなブドウです。\n";
25            break;
26        default:
27            echo "未知の果物です。\n";
28            break;
29    endswitch; // ここでswitch文のブロックが終了します。T_ENDSWITCHはこのキーワードを指します。
30}
31
32// 関数の実行例
33describeFruit('apple');
34describeFruit('banana');
35describeFruit('orange'); // defaultケースの例
36describeFruit('grape');
37
38?>

PHPのT_ENDSWITCHは、endswitchというキーワードがプログラム内で出現した際に、PHPの内部処理でそのキーワードを数値（int型）として識別するために使用される定数です。これは開発者が直接コード内で利用するものではなく、PHP言語自体がコードを解析する際に用いる「トークン」の一つに過ぎません。

提供されたサンプルコードは、PHPのswitch文の代替構文を示しています。通常、switch文は波括弧{}でブロックを囲みますが、この代替構文ではコロン:でブロックを開始し、endswitch;でブロックを終了します。

describeFruit関数は、引数として$fruitName（string型）に指定された果物の名前を受け取り、その種類に応じたメッセージを画面に出力します。戻り値はvoidであるため、この関数は特定の値を返しません。 関数内では、switch ($fruitName):からendswitch;までのブロックで処理が分岐します。例えば、$fruitNameが'apple'であれば「これは美味しいリンゴです。」と表示され、break;でswitch文の処理を抜けます。いずれのcaseにも当てはまらない場合は、default:の「未知の果物です。」というメッセージが出力されます。

このendswitch;というキーワードが、PHP内部でT_ENDSWITCHという定数に対応付けられ、適切にコードが解釈される仕組みです。