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

Copy
1<?php
2
3/**
4 * T_NAME_QUALIFIED 定数の使用例を示す関数。
5 *
6 * T_NAME_QUALIFIED は、PHPコードを解析する際に使われるトークンIDの一つで、
7 * 名前空間によって修飾された名前（例: MyNamespace\MyClass）を表します。
8 * 主に `token_get_all()` 関数と組み合わせて、PHPソースコードの構文解析に利用されます。
9 */
10function demonstrateTNameQualified(): void
11{
12    // T_NAME_QUALIFIED 定数自体の値（整数）を表示
13    // この値はPHPのバージョンによって異なる可能性がありますが、定数名は一貫しています。
14    echo "T_NAME_QUALIFIED の値: " . T_NAME_QUALIFIED . "\n\n";
15
16    // 解析対象とするPHPコード文字列を定義します。
17    // このコードには、名前空間修飾された名前の例が含まれています。
18    $code = <<<'PHP_CODE'
19<?php
20namespace App\Services;
21
22use App\Models\UserData; // ここに 'App\Models\UserData' が T_NAME_QUALIFIED として現れます
23
24class UserService
25{
26    public function getUserDetails(): array
27    {
28        $data = new UserData(); // 'UserData' は T_STRING などになるため、ここでは検出されません
29        echo "詳細: " . \App\Config\System::APP_VERSION; // '\App\Config\System' の 'App\Config\System' が T_NAME_QUALIFIED として現れます
30        return $data->getDetails();
31    }
32}
33PHP_CODE;
34
35    echo "--- 解析対象コード ---\n";
36    echo $code . "\n\n";
37    echo "--- トークン解析結果（T_NAME_QUALIFIED のみ）---\n";
38
39    // `token_get_all()` 関数を使用して、PHPコードを個々のトークンに分解します。
40    // 各トークンは配列（[トークンID, 値, 行番号]）または単一の文字列として返されます。
41    $tokens = token_get_all($code);
42
43    foreach ($tokens as $token) {
44        // トークンが配列形式（IDと値を持つ）であるかを確認します。
45        // T_NAME_QUALIFIED のような識別子系のトークンは配列で返されます。
46        if (is_array($token)) {
47            // トークンIDが T_NAME_QUALIFIED と一致するかチェックします。
48            if ($token[0] === T_NAME_QUALIFIED) {
49                // T_NAME_QUALIFIED トークンが見つかった場合、その情報（IDと値）を表示します。
50                echo "発見: T_NAME_QUALIFIED (ID: " . $token[0] . ", 値: '" . $token[1] . "')\n";
51            }
52        }
53    }
54
55    echo "\n--- 処理完了 ---\n";
56}
57
58// 関数を実行し、T_NAME_QUALIFIED の動作を確認します。
59demonstrateTNameQualified();

PHPのT_NAME_QUALIFIEDは、PHP 8で導入された特別な定数で、PHPのソースコードを解析する際に利用される「トークンID」の一つです。これは、名前空間によって完全に修飾された名前、例えばMyNamespace\MyClassのような形式の文字列を識別するために使われます。この定数自体は引数を持たず、その値はPHP内部で定義された特定の整数（int型）を返します。

主にtoken_get_all()関数と組み合わせて、PHPのソースコードを個々の要素（トークン）に分解し、その構造をプログラム的に分析する際に役立ちます。サンプルコードでは、token_get_all()を使って与えられたPHPコードを解析し、use App\Models\UserData;文のApp\Models\UserDataや、\App\Config\System::APP_VERSION内のApp\Config\Systemといった名前空間修飾された名前をT_NAME_QUALIFIEDとして検出する様子を示しています。このように、PHPコード内の特定の構文要素を効率的に見つけ出すために活用される定数です。

Copy
1<?php
2
3/**
4 * 指定されたPHPコード文字列を解析し、T_NAME_QUALIFIED トークンを検出します。
5 *
6 * T_NAME_QUALIFIED は、名前空間付きの修飾名（例: MyNamespace\MyClass）を
7 * 識別するために使用されるトークン定数です。
8 * 完全修飾名（例: \MyNamespace\MyClass）は T_NAME_FULLY_QUALIFIED として扱われます。
9 *
10 * @param string $phpCode 解析するPHPコード文字列
11 */
12function findQualifiedNames(string $phpCode): void
13{
14    echo "--- 解析対象のPHPコード ---" . PHP_EOL;
15    echo $phpCode . PHP_EOL;
16    echo "---------------------------" . PHP_EOL . PHP_EOL;
17
18    // token_get_all 関数は、PHPコードをトークン（PHPが認識できる最小単位）の配列に分解します。
19    // 各トークンは、配列（[トークンID, テキスト内容, 行番号]）または単一の文字（識別子でないもの）です。
20    $tokens = token_get_all($phpCode);
21
22    echo "検出された T_NAME_QUALIFIED トークン:" . PHP_EOL;
23    $found = false;
24
25    foreach ($tokens as $token) {
26        // トークンが配列形式の場合（キーワード、識別子、名前など）のみ処理します。
27        if (is_array($token)) {
28            // トークンIDが T_NAME_QUALIFIED と一致するか確認します。
29            if ($token[0] === T_NAME_QUALIFIED) {
30                // 一致した場合、そのトークンのテキスト（名前）と行番号を表示します。
31                echo "  - '" . $token[1] . "' (行: " . $token[2] . ")" . PHP_EOL;
32                $found = true;
33            }
34        }
35    }
36
37    if (!$found) {
38        echo "  T_NAME_QUALIFIED トークンは見つかりませんでした。" . PHP_EOL;
39    }
40}
41
42// サンプルPHPコード文字列
43// このコードには、T_NAME_QUALIFIED として検出される可能性のある要素が含まれています。
44$sampleCode = <<<'PHP_CODE'
45<?php
46
47namespace App\Core; // 'App\Core' は名前空間宣言であり T_NAME_QUALIFIED
48
49use Project\Utils\Helper; // 'Project\Utils\Helper' は use 文の名前であり T_NAME_QUALIFIED
50
51class MyService
52{
53    public function __construct()
54    {
55        // 名前空間付きのクラス名を直接指定した場合
56        $obj = new External\Module\Service(); // 'External\Module\Service' は T_NAME_QUALIFIED
57        
58        // use 文でインポートされたクラス名（Helper）は、通常 T_STRING として扱われます。
59        $helper = new Helper();
60        
61        // 型宣言での使用例
62        $this->processTask(new Internal\Sub\Task()); // 'Internal\Sub\Task' は T_NAME_QUALIFIED
63    }
64
65    // メソッドの引数や戻り値の型宣言で名前空間付きの型を使用した場合
66    public function processTask(External\Module\Service $service): void // 'External\Module\Service' は T_NAME_QUALIFIED
67    {
68        // 完全修飾名の例（これは T_NAME_FULLY_QUALIFIED に分類されます）
69        $date = new \DateTime(); 
70    }
71}
72
73// 関数の引数型宣言で名前空間付きの型を使用した場合
74function execute(Project\Models\Data $data): void // 'Project\Models\Data' は T_NAME_QUALIFIED
75{
76    // 何らかの処理...
77}
78PHP_CODE;
79
80// 関数を実行し、サンプルコード内の T_NAME_QUALIFIED トークンを検索します。
81findQualifiedNames($sampleCode);

PHPのT_NAME_QUALIFIEDは、PHPコードを解析する際に使われる特別な定数（トークン）の一つです。これは、名前空間（namespace）を含む「修飾名」を識別するために利用され、その値は整数型です。例えば、MyNamespace\MyClassのように、名前空間とクラス名がバックスラッシュ（\）で結合された形式の名前がこれに該当します。ただし、\MyNamespace\MyClassのように先頭にバックスラッシュが付く「完全修飾名」は、T_NAME_FULLY_QUALIFIEDという別のトークンとして区別されます。

提供されたサンプルコードは、PHPのtoken_get_all関数を使って、与えられたPHPコード文字列をPHPが認識する最小単位の「トークン」に分解し、その中からT_NAME_QUALIFIEDに該当するものを検出する例です。findQualifiedNames関数は、解析したいPHPコード文字列を引数として受け取り、特定の戻り値はありません。関数は、取得したトークンをループで確認し、トークンIDがT_NAME_QUALIFIEDと一致するものがあれば、その名前とコード内の行番号を表示します。

具体的には、namespace宣言の名前（例: App\Core）、use文で指定される名前（例: Project\Utils\Helper）、そして名前空間付きで直接記述されるクラス名やインターフェース名（例: External\Module\Serviceや型宣言におけるProject\Models\Dataなど）がT_NAME_QUALIFIEDとして検出されます。この定数を利用することで、PHPの構文をプログラム的に理解し、コードを解析する応用が可能になります。