【PHP8.x】PhpToken::textプロパティの使い方
textプロパティの使い方について、初心者にもわかりやすく解説します。
基本的な使い方
textプロパティは、PhpTokenオブジェクトが表すトークンの実際の文字列値を保持するプロパティです。
PHP 8で導入されたPhpTokenクラスは、PHPのソースコードをプログラムが解釈しやすいように、キーワード、変数名、演算子、文字列リテラルといった個々の「トークン」と呼ばれる小さな要素に分割した際に、それぞれのトークンを表現するためのオブジェクトです。このtextプロパティは、各PhpTokenオブジェクトが具体的にソースコード上でどのような文字列として存在しているかを提供します。
例えば、PHPコードのifというキーワードがPhpTokenオブジェクトとして生成された場合、そのオブジェクトのtextプロパティは文字列"if"を保持します。同様に、変数$myVariableであれば"$myVariable"を、文字列リテラル"Hello, world!"であれば"Hello, world!"を保持します。このプロパティは、コメントや空白文字、改行文字なども含め、ソースコード上のあらゆる文字の並びをトークンとして捉え、その内容を正確に取得するために利用されます。
開発者は、このtextプロパティを参照することで、PHPコードの解析、シンタックスハイライト、静的解析ツール、コードフォーマッタなどの開発において、各トークンの具体的な内容をプログラム上で容易に識別し、適切な処理を施すことができます。PhpTokenオブジェクト群を走査し、textプロパティの値を参照することで、元のソースコードを再構築することも可能です。
構文(syntax)
1<?php 2$code = '<?php echo "Hello World"; ?>'; 3$tokens = PhpToken::tokenize($code); 4 5// PhpToken::tokenize() で生成された PhpToken オブジェクトから 6// トークンが表す元のソースコードの文字列を取得します。 7// 例として、トークン列の最初のトークンのテキストを表示します。 8// ここでは通常 '<?php' が出力されます。 9echo $tokens[0]->text; 10 11// 別の例として、文字列リテラルを扱うトークンのテキストを表示します。 12// この例では '"Hello World"' が出力されます。 13foreach ($tokens as $token) { 14 if ($token->id === T_CONSTANT_ENCAPSED_STRING) { 15 echo $token->text; 16 break; 17 } 18} 19?>
引数(parameters)
引数なし
引数はありません
戻り値(return)
string
このプロパティは、PHPトークンを表す文字列を返します。
サンプルコード
PHPコードを PhpToken::text で解析する
1<?php 2 3/** 4 * ユーザーが入力したPHPコードをトークン化し、 5 * 各トークンの元の文字列（textプロパティ）を表示する関数。 6 * 7 * @param string $phpCode 解析するPHPコード文字列 8 * @return string HTML形式で整形されたトークンリスト 9 */ 10function tokenizeAndDisplay(string $phpCode): string 11{ 12 // 入力されたPHPコードが空の場合はメッセージを返す 13 if (empty($phpCode)) { 14 return '<p>解析するPHPコードが入力されていません。</p>'; 15 } 16 17 // PhpToken::tokenize() を使用してPHPコードをトークン化します。 18 // PHP 8で導入されたこの関数は、PhpTokenオブジェクトの配列を返します。 19 $tokens = PhpToken::tokenize($phpCode); 20 21 $output = '<h3>解析結果:</h3>'; 22 $output .= '<ul>'; 23 24 // 各トークンについてループし、その情報とtextプロパティを表示します。 25 foreach ($tokens as $token) { 26 // PhpToken::text プロパティは、トークンが表す元の文字列を返します。 27 // 例: '<?php', 'echo', ';', '"Hello, World!"' など。 28 // htmlspecialchars() でHTML特殊文字をエスケープし、安全に表示します。 29 $output .= '<li>' . 30 '<strong>タイプ:</strong> ' . htmlspecialchars($token->getTokenName() ?? 'N/A') . 31 ' (ID: ' . $token->id . ')' . 32 ' | <strong>テキスト:</strong> <code>' . htmlspecialchars($token->text) . '</code>' . 33 ' | <strong>行:</strong> ' . $token->line . 34 ' | <strong>位置:</strong> ' . $token->pos . 35 '</li>'; 36 } 37 $output .= '</ul>'; 38 39 return $output; 40} 41 42// フォームが送信された場合の処理 43$resultHtml = ''; 44// $_SERVER['REQUEST_METHOD'] は、リクエストがGETかPOSTかを判別します。 45if ($_SERVER['REQUEST_METHOD'] === 'POST' && isset($_POST['php_code'])) { 46 // ユーザーがテキストエリアに入力したPHPコードを取得 47 $phpCodeInput = $_POST['php_code']; 48 // 取得したPHPコードをtokenizeAndDisplay関数で解析し、結果をHTMLとして受け取る 49 $resultHtml = tokenizeAndDisplay($phpCodeInput); 50} 51 52?> 53<!DOCTYPE html> 54<html lang="ja"> 55<head> 56 <meta charset="UTF-8"> 57 <meta name="viewport" content="width=device-width, initial-scale=1.0"> 58 <title>PHP Token Parser (PhpToken::text プロパティ)</title> 59 <style> 60 body { font-family: Arial, sans-serif; margin: 20px; background-color: #f4f4f4; color: #333; } 61 .container { max-width: 800px; margin: auto; background-color: #fff; padding: 20px; border-radius: 8px; box-shadow: 0 0 10px rgba(0,0,0,0.1); } 62 h1, h3 { color: #0056b3; } 63 textarea { width: 100%; height: 180px; padding: 10px; margin-bottom: 10px; border: 1px solid #ddd; border-radius: 4px; box-sizing: border-box; font-family: 'Consolas', 'Monaco', monospace; font-size: 14px; } 64 button { background-color: #007bff; color: white; padding: 10px 15px; border: none; border-radius: 4px; cursor: pointer; font-size: 16px; } 65 button:hover { background-color: #0056b3; } 66 ul { list-style-type: none; padding: 0; } 67 li { background-color: #e9ecef; margin-bottom: 5px; padding: 8px 12px; border: 1px solid #dee2e6; border-radius: 4px; font-size: 14px; } 68 code { background-color: #f8f9fa; padding: 2px 4px; border-radius: 3px; font-family: 'Consolas', 'Monaco', monospace; color: #c82333; } 69 p { font-size: 15px; } 70 </style> 71</head> 72<body> 73 <div class="container"> 74 <h1>PHPコード トークンアナライザー</h1> 75 <p> 76 以下のテキストエリアにPHPコードを入力し、「解析」ボタンをクリックしてください。<br> 77 入力されたコードがどのようにPHPのトークンに分割されるか、それぞれのトークンが持つ元の文字列 (<code>PhpToken::text</code> プロパティ) とともに表示されます。 78 </p> 79 80 <form method="POST"> 81 <label for="php_code">PHPコードを入力:</label><br> 82 <!-- テキストエリアの初期値として、簡単なPHPコードを予め設定しておきます --> 83 <textarea id="php_code" name="php_code" placeholder="例: <?php echo 'Hello, PHP!'; ?>" required><?php echo htmlspecialchars($_POST['php_code'] ?? "<?php\n\n\$name = \"PHP\";\n// この変数を表示します\necho \"Hello, {\$name}!\";\n\n?>"); ?></textarea><br> 84 <button type="submit">トークンを解析</button> 85 </form> 86 87 <?php 88 // 解析結果がある場合はここに表示されます 89 echo $resultHtml; 90 ?> 91 </div> 92</body> 93</html>
PHP 8で導入されたPhpTokenクラスは、PHPコードを解析して個々の要素（トークン）に分解する際に使用されます。このクラスのtextプロパティは、各トークンが表す「元の文字列」を返します。例えば、echoキーワードは'echo'という文字列として、';'セミコロンは';'として、文字列リテラル"Hello"は'"Hello"'として、それぞれ元の形を保持した文字列を返します。このプロパティには引数はなく、常にstring型の値を戻り値として提供します。
提供されたサンプルコードでは、ユーザーがテキストエリアに入力したPHPコードをPhpToken::tokenize()関数でトークン化し、その結果得られるPhpTokenオブジェクトの配列を処理しています。それぞれのPhpTokenオブジェクトからtextプロパティを取得することで、そのトークンがコードのどの部分に該当するのかを正確に把握し、ウェブページ上に表示しています。これにより、PHPコードがどのように小さな構成要素に分割され、各要素がどのような文字列として認識されているかを、システムエンジニアを目指す初心者の方にも視覚的に理解しやすくなっています。この機能は、コードの構文解析や静的解析ツールなどの開発において非常に役立ちます。
PHP 8で導入されたPhpToken::textプロパティは、PHPコードを解析して得られる各トークンの、元の文字列を正確に取得できます。これは、コードの静的解析ツールやシンタックスハイライト機能などの開発に役立つ強力な機能です。サンプルコードのようにユーザーが入力したPHPコードを処理し、その結果をウェブページに表示する際には、セキュリティ上の脆弱性であるXSS（クロスサイトスクリプティング）攻撃を防ぐため、必ずhtmlspecialchars()関数を使用して特殊文字をエスケープしてください。生の文字列を直接出力すると、悪意のあるスクリプトが実行される危険性があります。また、このクラスとプロパティはPHP 8以降で利用可能であるため、お使いのPHPのバージョンが8以上であることをご確認ください。
PHPトークン解析とtextarea改行の扱い
1<?php 2 3/** 4 * PhpToken::textプロパティと、textareaからのPHPコード入力における改行の扱いを示すサンプルコード。 5 * 6 * このスクリプトは、ユーザーがtextareaに入力したPHPコードを受け取り、 7 * PhpToken::tokenize()関数を使ってそのコードを個々のトークンに分解します。 8 * そして、各トークンのPhpToken::textプロパティを表示し、元のソースコードにおける 9 * 改行やその他の空白文字がどのようにトークンとして保持されているかを確認します。 10 * 11 * PhpToken::textプロパティは、トークンが表す元のソースコードの文字列そのものを返します。 12 * これにより、PHPコード内の改行文字などもそのまま取得できることが分かります。 13 */ 14 15// POSTリクエストがあり、'php_code'という名前のデータが送信された場合のみ処理を実行 16if ($_SERVER['REQUEST_METHOD'] === 'POST' && isset($_POST['php_code'])) { 17 $phpCode = $_POST['php_code']; 18 19 // HTML出力の開始 20 echo "<h2>入力されたPHPコードのトークン解析結果:</h2>"; 21 echo "<pre>"; // 整形済みテキスト表示のためのタグ 22 23 try { 24 // PhpToken::tokenize() を使用して、入力されたPHPコードをトークンの配列に分解 25 // PHP 8以降で利用可能な機能です。 26 $tokens = PhpToken::tokenize($phpCode); 27 28 // 分解された各トークンをループして表示 29 foreach ($tokens as $token) { 30 // PhpToken::text プロパティは、そのトークンが表す元のソースコード文字列を返します。 31 // 例えば、空白トークンや文字列リテラルに含まれる改行もそのまま取得されます。 32 // 見やすくするため、改行文字(\n, \r)をエスケープして表示しています。 33 $escapedText = str_replace( 34 ["\n", "\r", "\t"], // 置き換える文字 35 ['\\n', '\\r', '\\t'], // 置き換え後の表示文字 36 $token->text 37 ); 38 39 // トークンのID、名前、そしてtextプロパティの値を表示 40 echo sprintf( 41 "ID: %-20s Name: %-20s Text: \"%s\"%s", 42 $token->id, // トークンID (int) 43 $token->name, // トークン名 (string, 例: T_WHITESPACE, T_STRING) 44 $escapedText, // トークンが表す元の文字列 45 PHP_EOL // 改行コード 46 ); 47 } 48 } catch (ParseError $e) { 49 // PHPコードの解析に失敗した場合のエラーメッセージを表示 50 echo "PHPコードの解析エラー: " . htmlspecialchars($e->getMessage()); 51 } 52 53 echo "</pre>"; // 整形済みテキスト表示タグの終了 54} 55 56// HTMLフォーム部分 57?> 58<!DOCTYPE html> 59<html lang="ja"> 60<head> 61 <meta charset="UTF-8"> 62 <meta name="viewport" content="width=device-width, initial-scale=1.0"> 63 <title>PhpToken::text と textarea の改行</title> 64 <style> 65 body { font-family: sans-serif; margin: 20px; line-height: 1.6; } 66 h1, h2 { color: #333; } 67 textarea { 68 width: 80%; 69 height: 150px; 70 padding: 10px; 71 margin-bottom: 10px; 72 border: 1px solid #ccc; 73 border-radius: 4px; 74 font-family: monospace; 75 font-size: 1rem; 76 } 77 button { 78 padding: 10px 20px; 79 background-color: #007bff; 80 color: white; 81 border: none; 82 border-radius: 4px; 83 cursor: pointer; 84 font-size: 1rem; 85 } 86 button:hover { 87 background-color: #0056b3; 88 } 89 pre { 90 background-color: #f4f4f4; 91 padding: 15px; 92 border: 1px solid #ddd; 93 border-radius: 4px; 94 overflow-x: auto; /* 横スクロールを可能にする */ 95 white-space: pre-wrap; /* 自動改行 */ 96 word-wrap: break-word; /* 長い単語も改行 */ 97 } 98 </style> 99</head> 100<body> 101 <h1>PHPコードトークン解析ツール</h1> 102 <p> 103 以下のテキストエリアにPHPコードを入力し、「解析」ボタンを押してください。<br> 104 <code>PhpToken::tokenize()</code> 関数でコードがトークンに分解され、 105 各トークンの <code>text</code> プロパティがどのように元のソースコード（改行を含む）を保持しているかを確認できます。 106 </p> 107 <form method="post"> 108 <textarea name="php_code" placeholder="ここにPHPコードを入力してください。例: <?php echo 'Hello\nWorld'; // コメント $var = 123; ?>"> 109 <?php 110 // フォームが初めて表示される際、またはエラー時に入力内容を保持するためのデフォルト値 111 echo htmlspecialchars($_POST['php_code'] ?? "<?php\n\$message = \"こんにちは\n世界\";\n// これはコメントです\necho \$message;\n?>" 112 ); 113 ?> 114 </textarea><br> 115 <button type="submit">解析</button> 116 </form> 117</body> 118</html>
このサンプルコードは、PHP 8で導入されたPhpTokenクラスのtextプロパティの働きをシステムエンジニアを目指す方にも分かりやすく説明します。ユーザーがHTMLのtextareaに入力したPHPコードは、PhpToken::tokenize()関数によって、意味を持つ最小単位である「トークン」に分解されます。
PhpToken::textプロパティは、分解された各トークンが元のPHPコード上でどのような文字列であったかをそのまま返します。このプロパティは引数はなく、戻り値は文字列型（string）です。特に、textareaからの入力で含まれる改行文字（\nなど）や空白文字も、textプロパティによって元のコードの通りに正確に取得できる点が重要です。
コードを実行すると、入力されたPHPコードがどのようにトークンに分解され、各トークンが改行を含む元のソースコード上の文字列をどのように保持しているか、その詳細が明確に表示されます。これにより、PHPコードが内部的にどのように解析されているか、そして改行などの空白文字がどのように扱われるかを理解する手助けとなります。
PhpToken::textプロパティは、元のPHPコード内の改行や空白、コメントなども含め、トークンが表す「そのままの文字列」を返します。textareaからの入力で改行が含まれる場合も、その改行コードはtextプロパティにそのまま反映されます。これを画面に表示する際は、\nなどの改行文字が見やすいようにstr_replaceで\\nのようにエスケープすると良いでしょう。また、ユーザー入力の内容をHTML出力する際は、常にhtmlspecialchars()を使用してクロスサイトスクリプティング（XSS）などのセキュリティリスクを避けてください。このPhpTokenクラスはPHP 8以降で利用可能な機能であり、入力されたPHPコードに構文エラーがある場合はParseError例外が発生しますので、適切に捕捉しエラー表示をしましょう。