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

Copy
1<?php
2
3/**
4 * PHPコードスニペットからエンカプセルされた文字列リテラルを抽出します。
5 *
6 * T_CONSTANT_ENCAPSED_STRING は、ダブルクォートやシングルクォートで囲まれた
7 * 文字列（例: "hello", 'world'）を表すPHPのトークン定数です。
8 * この関数は、PHPの token_get_all() 関数とこのトークン定数を使用して、
9 * コード内の文字列リテラルを識別する方法を、システムエンジニアを目指す初心者にも
10 * わかりやすく示します。
11 *
12 * @param string $phpCode 解析するPHPコード
13 * @return array<string> 抽出された文字列リテラルの配列
14 */
15function extractEncapsulatedStrings(string $phpCode): array
16{
17    // token_get_all関数は、与えられたPHPコードをPHPパーサーが解釈する
18    // 個々の要素（トークン）の配列に分解します。
19    // 各トークンは、その種類（ID）、値、行番号を含む配列、または単一の文字（例: 演算子）です。
20    $tokens = token_get_all($phpCode);
21    $encapsulatedStrings = [];
22
23    // 分解されたトークンの配列を一つずつ検査します。
24    foreach ($tokens as $token) {
25        // トークンが配列形式（つまり、IDと値を持つ）であり、かつ
26        // そのIDが T_CONSTANT_ENCAPSED_STRING であるかをチェックします。
27        // T_CONSTANT_ENCAPSED_STRING は、"..." や '...' の形式で書かれた文字列リテラルを示します。
28        if (is_array($token) && $token[0] === T_CONSTANT_ENCAPSED_STRING) {
29            // トークンの2番目の要素（インデックス1）がその値（文字列リテラル自体）です。
30            $encapsulatedStrings[] = $token[1];
31        }
32    }
33
34    return $encapsulatedStrings;
35}
36
37// 解析対象となるPHPコードの例
38$samplePhpCode = <<<'EOD'
39<?php
40    class Configuration {
41        public string $appName = "My Application"; // T_CONSTANT_ENCAPSED_STRING
42        const VERSION = '2.0.1';                  // T_CONSTANT_ENCAPSED_STRING
43        private $description = "A simple demo application."; // T_CONSTANT_ENCAPSED_STRING
44        
45        public function __construct(string $env) {
46            echo "Environment: " . $env; // この "Environment: " も文字列リテラルです
47            // 数値やブール値、キーワードなどは文字列として抽出されません
48            $maxUsers = 100;
49            $debugMode = false;
50        }
51    }
52
53    $config = new Configuration("development");
54    $status = 'Application started successfully!'; // T_CONSTANT_ENCAPSED_STRING
55    echo $status;
56EOD;
57
58// 上記のサンプルPHPコードから文字列リテラルを抽出します
59$extractedStrings = extractEncapsulatedStrings($samplePhpCode);
60
61// 抽出された文字列リテラルを一つずつ表示します
62echo "--- 抽出されたエンカプセルされた文字列リテラル ---" . PHP_EOL;
63foreach ($extractedStrings as $str) {
64    echo $str . PHP_EOL;
65}
66echo "---------------------------------------------" . PHP_EOL;
67
68?>

このPHPサンプルコードは、PHPのT_CONSTANT_ENCAPSED_STRINGというトークン定数を利用して、指定されたPHPコードの中からダブルクォートやシングルクォートで囲まれた文字列リテラルを抽出する方法を説明しています。T_CONSTANT_ENCAPSED_STRINGは、"文字列"や'別の文字列'のように書かれたテキストをPHPがコードとして認識する際の識別子（整数値）です。

extractEncapsulatedStrings関数は、解析したいPHPコード全体を文字列として引数$phpCodeで受け取ります。この関数は、token_get_all()関数を使ってPHPコードを小さな部品（トークン）の配列に分解します。その後、これらのトークンを一つずつ調べ、トークンの種類がT_CONSTANT_ENCAPSED_STRINGであるかを判断します。もし一致した場合、そのトークンが持つ実際の文字列の値を結果の配列に追加していきます。関数の処理が終わると、抽出されたすべての文字列リテラルを含む配列が戻り値として返されます。

このコードは、PHPがどのようにコードを構成する要素（トークン）に分解し、特定の種類を識別しているかという、PHPの内部的な動作の一端を理解するのに役立ちます。

Copy
1<?php
2
3/**
4 * PHPコードを解析し、トークン情報を表示する関数。
5 * T_PROPERTY_C (PHP 8で導入されたコンストラクタプロパティ) と
6 * T_VARIABLE (通常の変数やプロパティ) の違いを示します。
7 *
8 * システムエンジニアを目指す初心者の方へ:
9 * `token_get_all()` 関数は、PHPのコードを小さな部品（トークン）に分解します。
10 * これらのトークンは、PHPがコードを理解し、実行するために使われる内部的な表現です。
11 * `T_PROPERTY_C` や `T_VARIABLE` は、コード内の特定の要素（変数やプロパティ）が
12 * どのような役割を持っているかを識別するための定数です。
13 */
14function demonstratePhpTokens(): void
15{
16    // PHP 8のコンストラクタプロパティプロモーションを含むコードスニペット
17    $codeSnippet = <<<'PHP_CODE'
18<?php
19
20class Product
21{
22    // T_PROPERTY_C の例: コンストラクタ引数で直接プロパティとして宣言・初期化
23    // `$name` と `$price` は T_PROPERTY_C として識別されます。
24    public function __construct(
25        public string $name,
26        private float $price
27    ) {
28        // コンストラクタ内で追加の処理を行うことも可能
29    }
30
31    // T_VARIABLE の例: 通常のクラスプロパティ宣言
32    // `$isAvailable` は T_VARIABLE として識別されます。
33    public bool $isAvailable = true;
34
35    // T_VARIABLE の例: メソッド内のローカル変数
36    public function getFormattedPrice(): string
37    {
38        $currencySymbol = "$"; // `$currencySymbol` は T_VARIABLE
39        return $currencySymbol . number_format($this->price, 2);
40    }
41}
42PHP_CODE;
43
44    echo "--- 解析対象のPHPコードスニペット ---\n";
45    echo $codeSnippet;
46    echo "-------------------------------------\n\n";
47
48    // `token_get_all()` 関数でコードをトークンに分解
49    $tokens = token_get_all($codeSnippet);
50
51    echo "--- トークン解析結果 ---\n";
52    foreach ($tokens as $token) {
53        if (is_array($token)) {
54            // トークンが配列の場合: [ID (整数), 内容 (文字列), 行番号 (整数)]
55            $tokenId = $token[0];
56            $tokenContent = $token[1];
57            $tokenLine = $token[2];
58            $tokenName = token_name($tokenId); // トークンIDを人間が読める名前に変換
59
60            // T_PROPERTY_C と T_VARIABLE を特に強調して表示
61            if ($tokenName === 'T_PROPERTY_C') {
62                echo "行 {$tokenLine}: [{$tokenName}] -> '{$tokenContent}' (PHP 8 コンストラクタプロパティ)\n";
63            } elseif ($tokenName === 'T_VARIABLE') {
64                echo "行 {$tokenLine}: [{$tokenName}] -> '{$tokenContent}' (通常の変数またはプロパティ)\n";
65            } else {
66                echo "行 {$tokenLine}: [{$tokenName}] -> '{$tokenContent}'\n";
67            }
68        } else {
69            // トークンが文字列の場合: 単一文字の演算子や区切り文字など
70            echo "        ['{$token}']\n"; // 行番号は配列の場合にのみ取得可能
71        }
72    }
73    echo "---------------------------\n";
74}
75
76// 関数を実行し、トークン解析の結果を表示
77demonstratePhpTokens();

「T_PROPERTY_C」は、PHP 8で導入された定数です。これは、PHPコードを解析する際に使用され、特に「コンストラクタプロパティプロモーション」というPHP 8の新機能で宣言されたプロパティを識別するために用いられます。コンストラクタプロパティとは、クラスのコンストラクタ引数として直接プロパティを宣言し、初期化できる機能のことです。この定数の戻り値は整数（int）であり、PHPの内部処理で特定のトークン（コードの最小単位）を区別するためのIDとして機能します。

対照的に、「T_VARIABLE」は、PHPコード内の通常の変数、クラスのプロパティ、またはメソッド内で宣言されたローカル変数を識別するための定数です。

サンプルコードでは、token_get_all()関数を用いてPHPコードをトークンに分解し、これらの定数の違いを明確に示しています。例えば、Productクラスのコンストラクタ内でpublic string $nameのように宣言されたプロパティはT_PROPERTY_Cとして識別されます。一方で、クラス内で通常のpublic bool $isAvailable = true;と宣言されたプロパティや、メソッド内の$currencySymbolのようなローカル変数はT_VARIABLEとして識別されます。このように、PHPがコードの異なる要素を内部でどのように認識し、区別しているかを、これらの定数を通じて学ぶことができます。システムエンジニアにとって、PHPのコードがどのように解釈されるかを理解することは、より深く言語を習得する上で役立ちます。