【PHP8.x】PhpToken::__toString()メソッドの使い方

Copy
1<?php
2
3/**
4 * PhpTokenクラスの__toStringマジックメソッドの動作を示す関数。
5 *
6 * このメソッドは、PhpTokenオブジェクトが文字列として扱われたときに自動的に呼び出され、
7 * そのトークンのテキストコンテンツを返します。
8 *
9 * @param string $phpCode 解析するPHPコード文字列
10 * @return void
11 */
12function demonstratePhpTokenToString(string $phpCode): void
13{
14    echo "--- Original PHP Code ---\n";
15    echo $phpCode . "\n\n";
16
17    // PhpToken::tokenize() メソッドを使ってPHPコードをトークンに分解します。
18    // このメソッドはPHP 8以降で利用可能です。
19    $tokens = PhpToken::tokenize($phpCode);
20
21    echo "--- Token Information and __toString() Usage ---\n";
22
23    foreach ($tokens as $token) {
24        // トークンの基本情報を表示します（ID、名前、テキスト）。
25        echo "Token ID: {$token->id}, Name: " . ($token->name ?? 'N/A') . ", Text: '{$token->text}'\n";
26
27        // PhpToken オブジェクトを直接 echo で出力したり、文字列結合したりすると、
28        // PHPは自動的にこのオブジェクトの__toString()メソッドを呼び出します。
29        // PhpTokenの__toString()は、そのトークンのテキスト内容を返します。
30        echo "  __toString() output (via echo \$token): '" . $token . "'\n"; 
31        
32        // 直接 text プロパティにアクセスした場合の結果と比較します。
33        echo "  Direct text property (\$token->text): '" . $token->text . "'\n"; 
34        
35        // __toString() の結果がトークンのtextプロパティと一致することを確認します。
36        if ((string) $token === $token->text) {
37            echo "  Result matches token's text property.\n\n";
38        } else {
39            echo "  Mismatch detected! This should not normally happen.\n\n";
40        }
41    }
42}
43
44// PhpToken::__toString()の動作を示すための簡単なPHPコードを定義します。
45$sampleCode = '<?php echo "Hello World!"; $var = 123; /* comment */';
46
47// デモンストレーションを実行します。
48demonstratePhpTokenToString($sampleCode);
49

PHP 8で導入されたPhpTokenクラスは、PHPコードをより詳細に分析するため、コードを「トークン」と呼ばれる最小単位に分解する際に使用されます。このPhpTokenクラスに定義されている__toStringメソッドは、PHPの「マジックメソッド」の一つであり、PhpTokenオブジェクトが文字列として扱われるときに自動的に呼び出される特別なメソッドです。

このメソッドは引数を一切とりませんが、呼び出されると、そのPhpTokenオブジェクトが表すトークンの実際のテキスト内容を文字列として返します。例えば、echo $token;のようにPhpTokenオブジェクトを直接出力しようとしたり、文字列結合演算子（.）を使って他の文字列と連結しようとしたりすると、PHPは内部的にこの__toStringメソッドを呼び出し、オブジェクトのテキスト表現を取得します。

提供されたサンプルコードでは、まずPhpToken::tokenize()メソッドを使用してPHPコードを個々のトークンに分解しています。その後のループ処理では、各PhpTokenオブジェクトをecho $token;のように直接出力し、__toStringメソッドが自動的に呼び出される様子を示しています。この出力は、トークンが本来持っているテキストコンテンツである$token->textプロパティの内容と完全に一致することが確認できます。この機能は、PHPコードの解析やデバッグ作業において、トークンの内容を簡潔に表示したい場合に非常に便利です。

Copy
1<?php
2
3// PHPコード文字列を定義します。
4// この文字列がPhpToken::tokenize()によってトークンに分解されます。
5$phpCode = '<?php echo "Hello World!"; ?>';
6
7// PhpToken::tokenize() メソッドを使用してPHPコードをトークンの配列に分解します。
8// 各要素はPhpTokenオブジェクトです。
9$tokens = PhpToken::tokenize($phpCode);
10
11echo "PHPコードをトークンに分解し、各トークンの内容を文字列として表示します。\n\n";
12
13// 分解されたトークン配列をループ処理します。
14foreach ($tokens as $token) {
15    // PhpTokenオブジェクトを文字列コンテキスト（例: echoや文字列結合）で使用すると、
16    // 内部的に __toString() マジックメソッドが呼び出され、そのトークンの文字列表現が返されます。
17    echo "タイプ: " . $token->getTokenName() . ",\t内容: '" . $token . "'\t(行: " . $token->line . ", カラム: " . $token->pos . ")\n";
18}
19
20echo "\n最初のトークンを文字列として直接使用する例:\n";
21
22// 配列が空でないことを確認します。
23if (!empty($tokens)) {
24    // 配列の最初のPhpTokenオブジェクトを取得します。
25    $firstToken = $tokens[0];
26
27    // PhpTokenオブジェクトを直接echoすることで、__toString() メソッドが呼び出され、
28    // そのトークンの内容（この場合は'<?php '）が文字列として出力されます。
29    echo "最初のトークンの内容: '" . $firstToken . "'\n";
30}
31
32?>

PHP 8のPhpToken::__toStringメソッドは、PhpTokenオブジェクトを文字列として扱おうとした際に自動的に呼び出される特殊な（マジック）メソッドです。このメソッドは引数を一切取らず、そのPhpTokenオブジェクトが表す実際のコードの内容を文字列として返します。

提供されたサンプルコードでは、まずPHPのコード文字列をPhpToken::tokenize()メソッドによって個々の「トークン」に分解しています。トークンとは、PHPコードを構成する最小単位の要素（キーワード、変数名、演算子、文字列など）のことです。分解された各PhpTokenオブジェクトは、ループ処理で一つずつ取り出されます。

ここで重要なのは、echo文の中で$tokenのようにPhpTokenオブジェクトを直接文字列コンテキストで使用している点です。PHPはこのような場合、そのオブジェクトに__toString()メソッドが定義されていれば、自動的にそのメソッドを呼び出し、返された文字列を使って出力を行います。これにより、各トークンの種類だけでなく、そのトークンが実際にどのような文字列内容を持っているかを簡単に確認できます。例えば、<?php という開始タグのトークンは、__toString()メソッドを通じて'<?php 'という文字列として表示されます。この機能は、コードの構文解析やデバッグにおいて非常に便利です。