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

Copy
1<?php
2
3/**
4 * PHPコードを解析し、その構成要素（トークン）を初心者にも分かりやすく表示する関数です。
5 * PHPが内部でコードをどのように解釈しているかを理解する手助けとなります。
6 * 特に、ダブルクォートで囲まれた文字列内の変数展開における「T_ENCAPSED_AND_WHITESPACE」トークンに焦点を当てます。
7 *
8 * @param string $phpCode 解析するPHPコードの文字列
9 */
10function analyzePhpTokens(string $phpCode): void
11{
12    echo "--- 解析対象のPHPコード ---\n";
13    echo $phpCode . "\n";
14    echo "--------------------------\n\n";
15
16    // token_get_all() 関数は、指定されたPHPコードをトークンに分割します。
17    // 各トークンは配列または単一の文字（例: セミコロンや括弧など）で表現されます。
18    // 配列の場合: [0 => トークンID (PHPのT_定数), 1 => トークンの内容, 2 => コード上の行番号]
19    // token_get_all() は、入力コードが必ず `<?php` で始まっていることを期待するため、プレフィックスを追加します。
20    $tokens = token_get_all("<?php " . $phpCode);
21
22    echo "--- トークン解析結果 ---\n";
23    foreach ($tokens as $token) {
24        if (is_array($token)) {
25            // トークンID (例: 260) を人間が読みやすい定数名 (例: T_VARIABLE) に変換します。
26            $tokenName = token_name($token[0]);
27            $tokenContent = $token[1];
28            $lineNumber = $token[2];
29
30            echo "タイプ: " . str_pad($tokenName, 30) . " | 内容: '" . $tokenContent . "' | 行: " . $lineNumber . "\n";
31
32            // ここで、キーワードである「T_ENCAPSED_AND_WHITESPACE」トークンに関する詳細な説明を追加します。
33            if ($token[0] === T_ENCAPSED_AND_WHITESPACE) {
34                echo "    ↑ このトークンは、ダブルクォートで囲まれた文字列内で、\n";
35                echo "      変数展開やエスケープシーケンスの後に続く通常の文字列や空白を表します。\n";
36                echo "      PHPが文字列リテラル内の動的な部分（変数など）と静的な部分（固定の文字列）を\n";
37                echo "      内部で区別していることを示しており、文字列処理の理解に役立ちます。\n";
38            }
39        } else {
40            // 単一文字のトークン (例: ';', '=', '{', '}' など)
41            echo "タイプ: " . str_pad("SINGLE_CHAR_TOKEN", 30) . " | 内容: '" . $token . "'\n";
42        }
43    }
44    echo "--------------------------\n";
45}
46
47// キーワード「T_ENCAPSED_AND_WHITESPACE」が最もよく現れる典型的なPHPコード例です。
48// ダブルクォート文字列内に変数を展開することで、その変数展開の前後にある静的な文字列が
49// T_ENCAPSED_AND_WHITESPACE トークンとして識別されます。
50$sampleCode = <<<'CODE'
51$userName = "ゲスト";
52$currentDate = "2023-10-27";
53$greetingMessage = "こんにちは、{$userName}さん！本日は{$currentDate}です。";
54echo $greetingMessage;
55CODE;
56
57// 作成した関数を実行し、サンプルコードのトークン解析結果を表示します。
58analyzePhpTokens($sampleCode);

このPHPサンプルコードは、PHPが内部でコードをどのように解釈し、処理しているかを示す「トークン」の概念を、システムエンジニアを目指す初心者の方にも分かりやすく解説します。analyzePhpTokens関数は、引数として渡されたPHPコードの文字列を分析し、コードの構成要素であるトークンを種類、内容、コード上の行番号とともに画面に表示します。この関数は処理結果を表示するだけで、特定の値を戻り値として返しません。

特に注目していただきたいのは、「T_ENCAPSED_AND_WHITESPACE」というトークンです。これは、ダブルクォートで囲まれた文字列内で変数が展開される際、その変数展開部分の前後にある通常の文字列や空白を表します。例えば、"こんにちは、{$userName}さん！"という文字列の場合、"こんにちは、"と"さん！"の部分がこのトークンに該当します。PHPが文字列リテラル内の動的な要素（変数など）と静的な要素（固定の文字列）を明確に区別して扱っていることを示しており、PHPの内部動作への理解を深めるのに役立ちます。この知識は、より効率的で安全なPHPコードを書くための基礎となります。

Copy
1<?php
2
3/**
4 * PHPコードを解析し、特定のトークン（キーワードや文字列リテラル）を検出するサンプル関数。
5 * この関数は、PHPがどのようにコードを内部的に「単語」や「記号」に分解（トークン化）し、
6 * それらを識別しているかを示すことで、システムエンジニアを目指す初心者の方に
7 * プログラミング言語の裏側にある仕組みを理解してもらうことを目的としています。
8 */
9function analyzePhpCodeForTokens(): void
10{
11    // このファイル自身のPHPコードを取得します。
12    // token_get_all() 関数は、PHPコードを構文要素（トークン）の配列に分解します。
13    // これはPHPのパーサー（コードを解釈するプログラム）が内部で行う処理を模倣しています。
14    $code = file_get_contents(__FILE__);
15    $tokens = token_get_all($code);
16
17    echo "PHPコード内の特定のトークンを検出:\n";
18    echo "---------------------------------\n";
19
20    // 分解されたトークン配列を一つずつ処理します。
21    foreach ($tokens as $token) {
22        // 各トークンは通常、[トークンID, 値, 行番号] の配列形式で格納されています。
23        // （空白文字や一部の単一文字演算子などは文字列として格納されることもあります。）
24        if (is_array($token)) {
25            $tokenName = token_name($token[0]); // トークンIDから人間が読める名前を取得します。
26
27            // T_EXTENDS トークンの検出:
28            // T_EXTENDS は、クラスが別のクラスを継承する際に使用されるキーワード 'extends' に対応します。
29            // 例: class MyClass extends BaseClass
30            if ($token[0] === T_EXTENDS) {
31                echo "行 {$token[2]}: '{$token[1]}' は T_EXTENDS です (クラス継承キーワード 'extends').\n";
32            }
33
34            // T_CONSTANT_ENCAPSED_STRING トークンの検出:
35            // T_CONSTANT_ENCAPSED_STRING は、シングルクォート ('...') またはダブルクォート ("...")
36            // で囲まれた文字列リテラル（プログラム内で固定された文字列データ）に対応します。
37            // 例: "Hello, World!" や 'これは文字列です'
38            if ($token[0] === T_CONSTANT_ENCAPSED_STRING) {
39                echo "行 {$token[2]}: '{$token[1]}' は T_CONSTANT_ENCAPSED_STRING です (文字列リテラル).\n";
40            }
41        }
42    }
43    echo "---------------------------------\n";
44}
45
46// トークン検出の対象となるサンプルコード部分。
47// ここに T_EXTENDS と T_CONSTANT_ENCAPSED_STRING が含まれます。
48
49// T_EXTENDS の例: BaseClass を継承する MyClass
50class BaseClass
51{
52    public function getBaseInfo(): string
53    {
54        return '基底クラスの情報';
55    }
56}
57
58class MyClass extends BaseClass // ここで 'extends' が T_EXTENDS として検出されます
59{
60    public function greet(): string
61    {
62        // T_CONSTANT_ENCAPSED_STRING の例: ダブルクォートで囲まれた文字列
63        $greeting = "こんにちは、プログラミング学習者！"; // ここでこの文字列が T_CONSTANT_ENCAPSED_STRING として検出されます
64        return $greeting . ' ' . parent::getBaseInfo();
65    }
66}
67
68// 別の T_CONSTANT_ENCAPSED_STRING の例: シングルクォートで囲まれた文字列
69$message = 'PHPは楽しく学べます。'; // ここでこの文字列が T_CONSTANT_ENCAPSED_STRING として検出されます
70
71// 関数を実行して、上記コード内のトークン検出結果を表示します。
72analyzePhpCodeForTokens();

このサンプルコードは、PHPがどのようにプログラムコードを内部的に「単語」や「記号」といった最小単位（トークン）に分解し、識別しているかを示すものです。analyzePhpCodeForTokens関数は引数を取らず、戻り値もありません。この関数は、token_get_all()関数を用いてPHPコードを読み込み、それを構文要素ごとのトークン配列に変換します。

コード内で検出されるトークンの一つがT_EXTENDSです。これは、class MyClass extends BaseClassのように、クラスが別のクラスの機能を「継承する」ことを示すPHPのキーワードextendsに対応します。また、T_CONSTANT_ENCAPSED_STRINGは、"こんにちは"や'PHPは楽しく学べます。'のように、シングルクォートまたはダブルクォートで囲まれた、プログラム内で固定的に使われる「文字列リテラル」を表します。この解析を通じて、PHPがコードをどのように解釈しているかの仕組みを理解する一助となります。