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

Copy
1<?php
2
3/**
4 * T_PUBLIC定数の使用例を示します。
5 * この定数はPHPのトークナイザー拡張機能の一部であり、
6 * コード内の 'public' キーワードを表すトークンIDです。
7 */
8function demonstrateTPublicConstant(): void
9{
10    // T_PUBLIC定数の整数値を出力します。
11    // この値はPHPの内部で 'public' キーワードを識別するために使われます。
12    echo "T_PUBLIC 定数の値: " . T_PUBLIC . "\n\n";
13
14    // 'public' キーワードを含むPHPコードのサンプルを定義します。
15    $sampleCode = '<?php
16class MyClass
17{
18    public string $name; // public プロパティ
19    
20    public function __construct(string $name) // public メソッド
21    {
22        $this->name = $name;
23    }
24}';
25
26    echo "以下のサンプルコードをトークン化します:\n";
27    echo "```php\n" . $sampleCode . "\n```\n\n";
28
29    // token_get_all() を使用して、PHPコードをトークンの配列に分解します。
30    // 各トークンは文字列（単一文字の演算子など）または
31    // [トークンID, トークンテキスト, 行番号] の配列のいずれかです。
32    $tokens = token_get_all($sampleCode);
33
34    echo "T_PUBLIC を含むトークンを検索します:\n";
35    foreach ($tokens as $token) {
36        // トークンが配列形式の場合（PHPのキーワードや識別子など）
37        if (is_array($token)) {
38            // トークンIDが T_PUBLIC と一致するか確認します。
39            if ($token[0] === T_PUBLIC) {
40                echo "- T_PUBLIC を検出しました (ID: {$token[0]}, テキスト: '{$token[1]}', 行: {$token[2]}行目)\n";
41            }
42        }
43    }
44}
45
46// 関数を実行して、T_PUBLIC定数の動作を確認します。
47demonstrateTPublicConstant();

PHP 8で利用できるT_PUBLIC定数は、PHPの内部でコードを解析する「トークナイザー拡張機能」に属する定数です。この定数は、PHPのソースコード中に書かれたキーワード「public」を識別するための、固有の整数値（トークンID）を表します。引数はなく、その戻り値は常に整数型です。

サンプルコードは、このT_PUBLIC定数の具体的な使い方を示しています。まず、T_PUBLIC定数自体が持つ整数値を出力し、PHPが内部でpublicキーワードをどのように数値で識別しているかを紹介します。その後、publicキーワードを含む簡単なPHPコードを文字列として定義し、token_get_all()関数を使ってそのコードを構成する個々の要素（「トークン」と呼びます）の配列に分解します。コードは、分解されたトークンの中からT_PUBLIC定数と一致するトークンIDを持つものを見つけ出し、それがpublicキーワードであることを示しています。これにより、T_PUBLIC定数がPHPコード内の特定のキーワードをプログラム的に検出・識別するために役立つことが理解できます。

Copy
1<?php
2
3/**
4 * 指定されたPHPコード文字列を解析し、
5 * 定数 `T_PUBLIC` (アクセス修飾子 `public` を表すトークン) の出現を検出します。
6 *
7 * この関数は、PHPの内部的な構文解析の仕組みの一端を示します。
8 * `T_PUBLIC` は、`token_get_all()` 関数がPHPコードを解析する際に、
9 * `public` キーワードを識別するために使用するトークンIDです。
10 *
11 * システムエンジニアを目指す初心者の方へ：
12 * `token_get_all()` は、PHPコードを「トークン」（最小単位の単語や記号）に分解する関数です。
13 * 例えば、`class MyClass { public string $name; }` というコードは、
14 * `class`、`MyClass`、`{`、`public`、`string`、`$name`、`;`、`}` といった
15 * トークンに分解されます。`T_PUBLIC` はその中の `public` を識別するIDです。
16 *
17 * キーワード「tpl」との関連性について：
18 * テンプレートファイル（`.tpl` など）がPHPコードを含んでいる場合、
19 * そのPHPコードをこのように解析し、特定のキーワードの存在をチェックする
20 * ようなシナリオに応用できる可能性もあります。
21 *
22 * @param string $phpCode 解析対象のPHPコード文字列。
23 * @return void 結果は標準出力に出力されます。
24 */
25function analyzePhpCodeForPublicTokens(string $phpCode): void
26{
27    echo "--- PHPコード解析開始 ---\n";
28    echo "解析対象コード:\n";
29    echo "```php\n" . $phpCode . "\n```\n\n";
30
31    // token_get_all() は、PHPコードをトークンの配列に変換します。
32    // PHPコードが `<?php` で始まっていない場合でも動作するように、
33    // ここで明示的に `<?php` タグを追加しています。
34    $tokens = token_get_all("<?php " . $phpCode);
35
36    echo "検出された 'public' キーワード:\n";
37    $publicFound = false;
38
39    foreach ($tokens as $token) {
40        // 各トークンは文字列（例: '{', '}'）か、
41        // 配列 `[トークンID, トークン値, 行番号]` の形式です。
42        if (is_array($token)) {
43            // トークンIDが `T_PUBLIC` と一致するかを確認します。
44            // `T_PUBLIC` は定数で、PHPの 'public' キーワードを表す識別子です。
45            if ($token[0] === T_PUBLIC) {
46                echo "- 'public' キーワードを検出しました (値: '{$token[1]}', 行: {$token[2]}行目)\n";
47                $publicFound = true;
48            }
49        }
50    }
51
52    if (!$publicFound) {
53        echo "- 'public' キーワードは検出されませんでした。\n";
54    }
55
56    echo "\n--- PHPコード解析終了 ---\n";
57}
58
59// サンプル1: 'public' アクセス修飾子を含むPHPコード
60$sampleCodeWithPublic = <<<'EOT'
61class User {
62    public string $name; // public プロパティ
63
64    public function __construct(string $name) { // public メソッド
65        $this->name = $name;
66    }
67
68    protected function getInternalInfo(): string {
69        return "User ID: 123";
70    }
71}
72EOT;
73
74// サンプル2: 明示的な 'public' キーワードを含まないPHPコード
75$sampleCodeWithoutExplicitPublic = <<<'EOT'
76class Product {
77    protected int $id;
78
79    // PHP 8では、メソッドにアクセス修飾子がない場合、デフォルトで public となります。
80    // しかし、token_get_all() は明示的な 'public' キーワードのみを T_PUBLIC トークンとして識別します。
81    function getName(): string {
82        return "Sample Product";
83    }
84}
85EOT;
86
87// 関数を実行し、結果を確認します
88analyzePhpCodeForPublicTokens($sampleCodeWithPublic);
89echo "\n"; // 出力の区切り
90analyzePhpCodeForPublicTokens($sampleCodeWithoutExplicitPublic);

T_PUBLICは、PHPコード中の「public」というキーワードを識別するためにPHPの内部で利用される定数です。バージョン8のPHPで利用され、この定数自体は整数値を表します。このサンプルコードは、指定されたPHPコード文字列の中から、T_PUBLICが示す「public」キーワードの出現を検出する仕組みを紹介しています。

具体的には、token_get_all()という関数を使ってPHPコードを「トークン」と呼ばれる最小単位の要素に分解します。「public string $name;」のようなコードは、「public」「string」「$name」「;」といった部分に分けられます。T_PUBLIC定数は、これらのトークンの中から「public」キーワードを指し示すIDとして機能します。

analyzePhpCodeForPublicTokens関数は、解析対象となるPHPコード文字列を引数として受け取り、token_get_all()でコードをトークンに変換します。その後、各トークンの種類をT_PUBLICと比較し、もし一致するトークンが見つかれば、その検出情報を標準出力に出力します。この関数自体は特に値を返しません。

この機能は、PHPコードの内容をプログラムで分析する際に非常に有用です。例えば、テンプレートファイル（.tplなど）に含まれるPHPコードの構文を検証したり、特定のキーワードの利用状況をチェックする静的解析ツールなどの開発に応用できます。