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

getTokenNameメソッドは、PhpTokenクラスに属し、PHPコードの最小単位である「トークン」の種類を、人間が読みやすい文字列として取得するために実行するメソッドです。PHP 8で導入されたPhpTokenクラスは、token_get_all()関数が返すトークン情報をオブジェクトとしてカプセル化し、各トークンの詳細な情報を提供します。このgetTokenNameメソッドを呼び出すと、対象のPhpTokenオブジェクトが表すトークンの識別名（例えばT_STRINGやT_LNUMBERなど）を文字列として返します。これにより、数値のトークンIDだけでは分かりにくいトークンの種類を、具体的な名前で簡単に把握できるようになります。例えば、$token->getTokenName()のように使用することで、そのトークンが文字列リテラルなのか、整数値なのか、あるいは予約語なのかといった情報をデバッグ時や構文解析処理の中で効率的に判別することが可能になります。システムエンジニアを目指す方々がPHPの内部動作や構文解析の仕組みを理解する上で、このメソッドは非常に有用なツールとなるでしょう。

Copy
1<?php
2
3$code = '<?php echo "Hello World";';
4$tokens = PhpToken::tokenize($code);
5
6// 最初のトークン（例えば '<?php'）を取得し、その名前を取得する例
7if (!empty($tokens)) {
8    $firstToken = $tokens[0];
9    $tokenName = $firstToken->getTokenName();
10    echo "取得したトークンの名前: " . $tokenName . PHP_EOL;
11}
12
13?>

引数なし

引数はありません

?string

このメソッドは、現在のトークンを表す文字列を返します。トークンが識別子、キーワード、リテラルなどの場合、その名前が返されます。