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

Copy
1<?php
2
3/**
4 * PHPコード文字列内の 'namespace' キーワードを識別する例。
5 * PHPの内部定数 T_NAMESPACE の利用を示します。
6 *
7 * T_NAMESPACE は、PHPのパーサーが 'namespace' キーワードを識別するために使用する
8 * 内部トークンID (整数値) です。
9 *
10 * @param string $phpCode 解析するPHPコード文字列
11 */
12function demonstrateNamespaceToken(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コードを個々のトークンに分解します。
19    // 各トークンは、その種類、値、行番号を含む配列として返されます。
20    // 例: [トークンID (整数), トークン文字列, 行番号]
21    $tokens = token_get_all($phpCode);
22
23    echo "--- T_NAMESPACE トークンの検索結果 ---" . PHP_EOL;
24    $found = false;
25    foreach ($tokens as $token) {
26        // トークンが配列形式（キーワードや変数など）であり、
27        // そのトークンIDが T_NAMESPACE と一致するかをチェックします。
28        // T_NAMESPACE は 'namespace' キーワードに割り当てられた定数です。
29        if (is_array($token) && $token[0] === T_NAMESPACE) {
30            echo "キーワード '{$token[1]}' を発見しました (行: {$token[2]})" . PHP_EOL;
31            $found = true;
32        }
33    }
34
35    if (!$found) {
36        echo "'namespace' キーワード（T_NAMESPACE トークン）はコード内で見つかりませんでした。" . PHP_EOL;
37    }
38    echo "------------------------------------" . PHP_EOL;
39}
40
41// 'namespace' キーワードを含むサンプルPHPコード
42$sampleCodeWithNamespace = <<<'EOD'
43<?php
44
45namespace MyApp\Controllers;
46
47class HomeController {
48    public function index() {
49        echo "Welcome to the Home Page!";
50    }
51}
52
53namespace OtherApp;
54
55function run() {
56    $controller = new \MyApp\Controllers\HomeController();
57    $controller->index();
58}
59
60run();
61EOD;
62
63// 関数を呼び出して T_NAMESPACE の使用例を示します
64demonstrateNamespaceToken($sampleCodeWithNamespace);
65
66echo PHP_EOL . PHP_EOL;
67
68// 'namespace' キーワードを含まない別のサンプルPHPコード
69$sampleCodeWithoutNamespace = <<<'EOD'
70<?php
71
72echo "これは名前空間を使用しないシンプルなPHPコードです。";
73
74function greet(string $name): void {
75    echo "Hello, {$name}!";
76}
77
78greet("World");
79EOD;
80
81// 'namespace' キーワードが見つからない場合の例を示します
82demonstrateNamespaceToken($sampleCodeWithoutNamespace);
83

PHPのT_NAMESPACEは、PHPコードの構文解析時にnamespaceキーワードを識別するために使用される内部定数です。これは整数値を持ち、PHPのパーサー（コードを解釈するプログラム）がnamespaceという文字の並びを特定の意味を持つ「トークン」として認識するための識別子として機能します。この定数自体に引数はなく、常にnamespaceキーワードに対応する整数値を返します。

サンプルコードでは、demonstrateNamespaceToken関数が引数として与えられたPHPコード文字列を、token_get_all()関数を使って個々のトークン（キーワード、演算子、変数名などの最小単位）に分解しています。そして、分解されたトークンの中からT_NAMESPACEと同じトークンIDを持つもの、すなわちnamespaceキーワードを探し出し、その出現箇所を検出して表示します。

このように、コード内の特定のキーワードがどこで使用されているかをプログラム的に検出する方法を示しており、PHPのコードを静的に分析するツールや、構文チェックなどの開発に利用されますが、通常のアプリケーション開発で直接使用することはほとんどありません。

Copy
1<?php
2
3/**
4 * PHPコード文字列から宣言されている最初の名前空間を抽出します。
5 *
6 * この関数は、PHPのトークンパーサーが使用するT_NAMESPACE定数を利用して、
7 * 提供されたPHPコード内の「namespace」キーワードとその後に続く名前空間名を特定します。
8 * これは、簡易的な名前空間解決メカニズムの一部として利用できます。
9 *
10 * @param string $phpCodeString 解析対象のPHPコード文字列
11 * @return string|null 見つかった名前空間名（例: 'App\Utility'）、または名前空間が見つからない場合はnull
12 */
13function getNamespaceFromCode(string $phpCodeString): ?string
14{
15    // PHPコードをPHPの内部トークンに分解します。
16    // 各トークンは、コードの構成要素（キーワード、変数名、記号など）を表します。
17    $tokens = token_get_all($phpCodeString);
18
19    $isParsingNamespace = false; // 名前空間宣言を解析中かどうかのフラグ
20    $namespaceName = '';         // 抽出された名前空間名を格納する変数
21
22    foreach ($tokens as $token) {
23        // トークンが配列の場合、キーワードや定数などPHPの構造体を表します。
24        // $token[0] はトークンID（例: T_NAMESPACE）、$token[1] はトークンの内容（例: 'namespace'）。
25        if (is_array($token)) {
26            // T_NAMESPACE トークンは 'namespace' キーワードを表します。
27            if ($token[0] === T_NAMESPACE) {
28                // 最初の名前空間宣言のみを処理するため、既に検出済みの場合はループを終了します。
29                if ($isParsingNamespace) {
30                    break;
31                }
32                $isParsingNamespace = true; // 名前空間宣言の解析を開始
33                continue; // 'namespace' キーワード自体は名前空間名に含めないのでスキップ
34            }
35
36            // 名前空間宣言の解析中の場合、名前空間名を構成する部分を収集します。
37            if ($isParsingNamespace) {
38                switch ($token[0]) {
39                    case T_STRING:       // 'App', 'Utility' などの文字列部分
40                    case T_NS_SEPARATOR: // 名前空間の区切り文字 '\'
41                        $namespaceName .= $token[1];
42                        break;
43                    case T_WHITESPACE:
44                        // 名前空間名と区切り文字の間の空白は無視します。
45                        break;
46                    default:
47                        // 名前空間名を示すトークン以外（例: '{', ';' など）が現れたら、
48                        // 名前空間名の収集は終わりと判断し、ループを抜けます。
49                        $isParsingNamespace = false;
50                        break 2; // foreach と switch の両方のループを抜ける
51                }
52            }
53        } else { // トークンが文字列の場合、記号（例: ';', '{'）を表します。
54            if ($isParsingNamespace) {
55                // セミコロン ';' または波括弧 '{' は名前空間宣言の終わりを示します。
56                if ($token === ';' || $token === '{') {
57                    $isParsingNamespace = false;
58                    break; // ループを抜ける
59                }
60                // その他、予期せぬ記号があった場合も名前空間名の終わりと判断します。
61                break;
62            }
63        }
64    }
65
66    // 収集した名前空間名の前後の空白を削除し、空文字列でなければ返します。
67    $namespaceName = trim($namespaceName);
68    return empty($namespaceName) ? null : $namespaceName;
69}

このサンプルコードは、PHPコード文字列の中から、最初に宣言されている名前空間名を抽出するgetNamespaceFromCode関数を提供しています。この関数は、PHPの内部でコードを解析する際に利用されるtoken_get_all関数とT_NAMESPACE定数を活用しています。

token_get_all関数は、渡されたPHPコードをキーワード、変数名、記号といった個々の構成要素（トークン）に分解します。その中でT_NAMESPACE定数は、PHPが「namespace」というキーワードを識別するために用いる特別なIDです。コードは、まずこのT_NAMESPACEを検出することで、名前空間の宣言が始まったことを認識します。

T_NAMESPACEの検出後、コードは名前空間名を構成する文字列部分（例: 'App', 'Utility'）や名前空間の区切り文字（''）を順に収集し、名前空間名を組み立てます。そして、名前空間宣言の終わりを示すセミコロン（;）や波括弧（{）といった記号が現れた時点で、名前空間名の収集を停止します。

引数$phpCodeStringには解析したいPHPコードの全文を文字列として渡します。戻り値は、抽出された名前空間名が文字列として返され、名前空間が見つからない場合はnullが返されます。この機能は、PHPコードの簡易的な解析や、宣言されている名前空間の特定に役立ちます。