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

Copy
1<?php
2
3/**
4 * PHPコードを解析し、T_ENCAPSED_AND_WHITESPACEトークンの動作を示します。
5 *
6 * T_ENCAPSED_AND_WHITESPACEは、ダブルクォートで囲まれた文字列中で
7 * 変数が展開される箇所（例: "$name"の後の"です"）や、
8 * それに続く静的な文字列や空白文字を表すトークンです。
9 * これにより、PHPがどのように文字列リテラルを内部的に処理しているかを理解できます。
10 */
11function demonstrateTokenEncapsedAndWhitespace(): void
12{
13    // 解析対象とするPHPコードの例です。
14    // ダブルクォート文字列内の変数展開に注目してください。
15    $codeToAnalyze = '
16$name = "PHP";
17$version = 8;
18$message = "Hello, $name version $version! This is great."; // 複数のT_ENCAPSED_AND_WHITESPACEが現れる可能性
19$output = "The language is {$name}."; // 波括弧を使った変数展開の例
20$simple = "Just a string."; // 変数展開がないダブルクォート文字列はT_CONSTANT_ENCAPSED_STRINGになります
21$singleQuote = \'This is a single-quoted string. $name is ignored.\'; // シングルクォートは変数展開されません
22';
23
24    echo "--- T_ENCAPSED_AND_WHITESPACE トークンのデモンストレーション ---\n";
25    echo "以下のPHPコードを解析します:\n";
26    echo "```php\n" . trim($codeToAnalyze) . "\n```\n\n";
27
28    // token_get_all() 関数は、PHPコードをトークン（最小の言語要素）の配列に分解します。
29    // 正しくPHPコードとして解析させるため、"<?php " を先頭に追加します。
30    $tokens = token_get_all("<?php " . $codeToAnalyze);
31
32    echo "検出された T_ENCAPSED_AND_WHITESPACE トークン:\n";
33    $foundCount = 0;
34
35    foreach ($tokens as $token) {
36        // 各トークンは、[トークンID, トークン値, 行番号] を含む配列か、
37        // もしくは単一の記号文字（例: ';', '{'）です。
38        if (is_array($token) && $token[0] === T_ENCAPSED_AND_WHITESPACE) {
39            echo "- 値: \"" . $token[1] . "\"\n";
40            echo "  コード上の行: " . $token[2] . "\n";
41            $foundCount++;
42        }
43    }
44
45    if ($foundCount === 0) {
46        echo "  (T_ENCAPSED_AND_WHITESPACE トークンは見つかりませんでした。)\n";
47    } else {
48        echo "\n合計 {$foundCount} 個の T_ENCAPSED_AND_WHITESPACE トークンが見つかりました。\n";
49    }
50
51    echo "--- デモンストレーション終了 ---\n";
52}
53
54// 上記で定義した関数を実行し、T_ENCAPSED_AND_WHITESPACEトークンの動作を確認します。
55demonstrateTokenEncapsedAndWhitespace();

このPHPサンプルコードは、ダブルクォートで囲まれた文字列内で変数が展開される際にPHPの内部がどのように処理を行っているかを示すT_ENCAPSED_AND_WHITESPACEトークンの動作を実演しています。demonstrateTokenEncapsedAndWhitespace関数は引数を持たず、特定の値を返しません（void）。

コードでは、$codeToAnalyze変数にダブルクォート文字列を含むPHPコードの例を定義しています。特に、"Hello, $name version $version! This is great."のような文字列内で、変数$nameや$versionが展開される前後の静的な文字列や空白文字がT_ENCAPSED_AND_WHITESPACEとして認識されます。

token_get_all()関数は、与えられたPHPコードを解析し、その構成要素をトークンと呼ばれる最小単位の配列として返します。このサンプルでは、そのトークンの中からT_ENCAPSED_AND_WHITESPACEに該当するものを探し出し、その具体的な値とコード上の行番号を表示しています。これにより、例えば$nameの後に続くversionや$versionの後に続く! This is great.といった部分が、このトークンとして識別されることを確認できます。

このデモンストレーションを通じて、PHPが文字列リテラルと変数展開をどのように区別し、内部的に処理しているかを具体的に理解することができます。変数が展開されない単なるダブルクォート文字列はT_CONSTANT_ENCAPSED_STRINGという別のトークンになることも、この解析の観察から学ぶことができます。

Copy
1<?php
2
3/**
4 * 指定されたPHPコード文字列を解析し、T_CASEとT_STRINGトークンを識別して表示します。
5 * これは、PHPがコードをどのように「単語」や「記号」に分解するかを示す一例です。
6 *
7 * @param string $phpCode 解析するPHPコード文字列
8 * @return void
9 */
10function identifySpecificTokens(string $phpCode): void
11{
12    // 解析対象のPHPコードを表示
13    echo "--- 解析対象のPHPコード ---\n";
14    echo $phpCode . "\n";
15    echo "--------------------------\n\n";
16
17    // PHPコードを内部の「トークン」に分解します。
18    // PHPはこのトークン列を使ってコードの意味を理解します。
19    $tokens = token_get_all($phpCode);
20
21    echo "--- 識別されたT_CASEとT_STRINGトークン ---\n";
22    foreach ($tokens as $token) {
23        // 各トークンは配列（PHPキーワードや演算子など）または
24        // 単一の文字（例: ;, =, ( など）のいずれかです。
25        if (is_array($token)) {
26            // token_name()関数でトークン定数（例: T_CASE）に対応する
27            // 読みやすい名前（例: 'T_CASE'）を取得します。
28            $tokenName = token_name($token[0]); 
29
30            // 'T_CASE'は'case'キーワードを表します。
31            // switch文の選択肢として使われます。
32            if ($tokenName === 'T_CASE') {
33                echo "発見: T_CASE ('{$token[1]}') - switch文の選択肢キーワード\n";
34            }
35            // 'T_STRING'はPHPのコード内で使用される識別子（名前）を表します。
36            // これには、関数名、クラス名、定数名、変数名の一部などが含まれます。
37            // 文字列リテラル（例: "Hello"）とは異なります。
38            elseif ($tokenName === 'T_STRING') {
39                echo "発見: T_STRING ('{$token[1]}') - 識別子（関数名、変数名など）\n";
40            }
41        }
42    }
43    echo "-------------------------------------------\n";
44}
45
46// T_CASEとT_STRINGを含むシンプルなPHPコードの例を定義します。
47// PHP 8の型宣言を含むコードスニペットです。
48$sampleCode = <<<'EOD'
49<?php
50// この関数は与えられた名前に応じて挨拶を返します。
51function greetUser(string $name): string
52{
53    // switch文は、変数$nameの値に基づいて異なる処理を行います。
54    switch ($name) {
55        case "Alice": // 'case'キーワードはT_CASEとして識別されます
56            return "Hello, Alice!";
57        case "Bob":   // ここにも'case'があります
58            return "Hi, Bob!";
59        default:
60            return "Hello, Guest!";
61    }
62}
63?>
64EOD;
65
66// 上記のサンプルコードを解析し、T_CASEとT_STRINGトークンを識別して表示します。
67identifySpecificTokens($sampleCode);

このサンプルコードは、PHPがプログラミングコードをどのように理解しているかを示すために、与えられたPHPコード文字列を解析し、特定の「トークン」を識別して表示します。トークンとは、PHPがコードを構成する最小の意味単位に分解したものです。

token_get_all()関数は、引数として渡されたPHPコード文字列を、PHPの内部で処理しやすいトークン列に分解します。このトークン列には、キーワード、変数名、演算子などが含まれます。

T_CASEは、PHPがコードを解析する際に使用する定数の一つで、switch文のcaseキーワードを識別します。この定数自体に引数はなく、特定の戻り値もありません。T_STRINGは、関数名、変数名、クラス名など、PHPコード内で開発者が定義する「識別子」を表すトークンです。これらのトークンを識別することで、PHPはコードの構造と意味を把握します。

サンプルコード内のidentifySpecificTokens関数は、引数として解析したいPHPコード文字列（$phpCode）を受け取ります。この関数は、token_get_all()でトークンに分解されたコードを一つずつ検査し、T_CASEまたはT_STRINGと識別されたトークンとその内容を画面に表示します。関数はvoidを戻り値としており、解析結果を直接出力するため、特定の値を呼び出し元に返すことはありません。これにより、PHPがコードの各部分をどのように認識しているかを視覚的に確認できます。