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

Copy
1<?php
2
3/**
4 * PHPのトークナイザーを利用して、T_END_HEREDOC と T_ENCAPSED_AND_WHITESPACE トークンを識別する例。
5 *
6 * T_END_HEREDOC はheredoc文字列の終了マーカーを表します。
7 * T_ENCAPSED_AND_WHITESPACE は、ダブルクォート文字列やheredoc内の文字列コンテンツを表します。
8 * これらの定数は、PHPのコードを解析する際に使用されます。
9 *
10 * @param string $phpCode 分析対象のPHPコード文字列。
11 */
12function analyzeHeredocTokens(string $phpCode): void
13{
14    // 指定されたPHPコード文字列をトークンに分解します。
15    // 各トークンは配列または単一文字の文字列として返されます。
16    $tokens = token_get_all($phpCode);
17
18    echo "--- トークン分析結果 ---\n";
19    foreach ($tokens as $token) {
20        // トークンが配列の場合、[トークンID, トークン内容, 行番号] の形式です。
21        if (is_array($token)) {
22            $tokenId = $token[0];
23            $tokenContent = $token[1];
24            $lineNumber = $token[2];
25
26            // T_END_HEREDOC トークンをチェックします。
27            if ($tokenId === T_END_HEREDOC) {
28                echo sprintf("Line %d: T_END_HEREDOC (Heredoc終了マーカー) を検出: '%s'\n", $lineNumber, $tokenContent);
29            }
30            // T_ENCAPSED_AND_WHITESPACE トークンをチェックします。
31            elseif ($tokenId === T_ENCAPSED_AND_WHITESPACE) {
32                echo sprintf("Line %d: T_ENCAPSED_AND_WHITESPACE (文字列コンテンツ) を検出: '%s'\n", $lineNumber, str_replace("\n", '\n', $tokenContent));
33            }
34        }
35    }
36    echo "------------------------\n";
37}
38
39// heredoc文字列を含むPHPコードの例。
40// `<<<MESSAGE` でheredocが始まり、`MESSAGE;` でheredocが閉じます。
41// この例では、`MESSAGE;` が T_END_HEREDOC トークンとして識別され、
42// heredoc内のテキストが T_ENCAPSED_AND_WHITESPACE トークンとして識別されます。
43$codeExample = <<<'EOT'
44<?php
45$user = "開発者";
46$greeting = <<<MESSAGE
47こんにちは、{$user}さん！
48これはheredoc構文を使った
49複数行のメッセージです。
50MESSAGE; // この行が T_END_HEREDOC を含みます。
51
52echo $greeting;
53?>
54EOT;
55
56// 作成した関数でPHPコードを分析します。
57analyzeHeredocTokens($codeExample);

本サンプルコードは、PHPのソースコードを解析する際に用いられる特別な定数について、システムエンジニアを目指す初心者の方にもわかるように説明します。T_END_HEREDOCはPHPのheredoc構文で定義される複数行文字列の「終了マーカー」を表す定数で、その値は内部的に整数値として扱われます。一方、T_ENCAPSED_AND_WHITESPACEは、heredocやダブルクォートで囲まれた文字列の「内容」そのものを表すトークンです。

コードの中心となるanalyzeHeredocTokens関数は、引数として受け取ったPHPコード文字列をtoken_get_all関数で小さな部品（トークン）に分解します。この関数は分解された各トークンが何であるか、その内容とコード上の行番号を識別し、特にT_END_HEREDOCとT_ENCAPSED_AND_WHITESPACEが検出された場合に、その詳細な情報を表示します。

token_get_all関数は、PHPコードを分析可能な配列形式のトークンに変換する役割を持ち、その戻り値はトークンのリストです。analyzeHeredocTokens関数は戻り値がvoidであるため、直接値を返さず、処理結果を画面に出力する挙動をします。これらの定数やトークンは、PHPがコードをどのように解釈し、処理しているかを理解する上で重要であり、構文解析ツールやエディタの構文ハイライト機能などで利用されています。

Copy
1<?php
2
3/**
4 * WordPressの the_excerpt() 関数のような機能を模倣し、
5 * 長いテキストから抜粋を生成する関数です。
6 * HTMLタグを除去し、指定された文字数で切り詰め、単語の途中で切れないように調整します。
7 *
8 * @param string $content 元のコンテンツ文字列。
9 * @param int $length 抜粋の最大文字数。デフォルトは55。
10 * @param string $more 抜粋の末尾に追加する文字列。デフォルトは '...'。
11 * @return string 生成された抜粋。
12 */
13function generateExcerpt(string $content, int $length = 55, string $more = '...'): string
14{
15    // HTMLタグを除去し、プレーンテキストにする
16    $text = strip_tags($content);
17    // 前後の空白を除去
18    $text = trim($text);
19
20    // 文字列の長さが指定された長さ以下であれば、そのまま返す
21    if (mb_strlen($text) <= $length) {
22        return $text;
23    }
24
25    // 指定された長さで文字列を切り取る（マルチバイト対応）
26    $excerpt = mb_substr($text, 0, $length);
27
28    // 途中で単語が切れないように、最後のスペースまでを抽出
29    // これにより、抜粋の終わりが単語の途中になるのを避ける
30    $lastSpacePos = mb_strrpos($excerpt, ' ');
31    if ($lastSpacePos !== false) {
32        $excerpt = mb_substr($excerpt, 0, $lastSpacePos);
33    }
34
35    // 末尾文字列を追加して返す
36    return $excerpt . $more;
37}
38
39// サンプルコンテンツとしてPHPのHeredoc構文を使用します。
40// Heredocは複数行の長い文字列を読みやすく定義するのに便利です。
41// T_END_HEREDOC は、このHeredoc構文の終了デリミタ (この例では EOT;) を
42// PHPが内部的に構文解析する際に識別するためのトークン定数です。
43$longArticleContent = <<<EOT
44    PHPは動的なウェブサイト開発に広く使用されるプログラミング言語です。
45    バージョン8では、JITコンパイラの導入やタイプヒンティングの強化など、多くの改善が加えられました。
46    この言語は、シンプルさと柔軟性を兼ね備えており、初心者から経験豊富な開発者まで幅広く支持されています。
47    WordPressのような世界的に人気のあるCMSもPHPで構築されており、多くのウェブサイトで活用されています。
48    the_excerpt() 関数はWordPressでよく使われる機能の一つで、記事の長い本文から簡潔な要約を生成するのに役立ちます。
49    例えば、ブログのトップページやアーカイブページで、各記事の冒頭部分だけを表示したい場合に利用されます。
50    これはウェブページの読み込み速度向上やSEOにも貢献し、ユーザーがコンテンツの概要を素早く把握するのを助けます。
51    この例では、PHPのHeredoc構文を使って長い文字列を定義し、それを処理する様子を示しています。
52    EOT;
53
54// 抜粋を生成して表示
55echo "--- 元の記事コンテンツ ---\n";
56echo $longArticleContent . "\n\n";
57
58echo "--- 生成された抜粋 (デフォルトの55文字) ---\n";
59echo generateExcerpt($longArticleContent) . "\n\n";
60
61echo "--- 生成された抜粋 (100文字に指定) ---\n";
62echo generateExcerpt($longArticleContent, 100) . "\n\n";
63
64// T_END_HEREDOC の値を出力します。
65// この定数は、PHPがHeredoc構文の終了（上記の EOT; の部分）を検出するために
66// 内部で使用する整数値です。
67// 通常のアプリケーション開発で直接扱うことは稀ですが、PHPの構文解析の
68// 仕組みを理解する上で、このようなトークンが存在することを知っておくと良いでしょう。
69echo "--- T_END_HEREDOC の情報 ---\n";
70echo "T_END_HEREDOC (Heredoc構文の終了を示すトークンID): " . T_END_HEREDOC . "\n";
71// token_name() 関数を使って、このトークンIDが表す名前を取得できます。
72echo "T_END_HEREDOC のトークン名: " . token_name(T_END_HEREDOC) . "\n";
73
74?>

PHPバージョン8は、動的なウェブサイト開発に広く利用されるプログラミング言語です。このサンプルコードは、WordPressで記事の要約を表示するthe_excerpt()関数のような機能を模倣し、長いテキストから指定された長さの抜粋を生成するgenerateExcerpt関数を提供しています。

generateExcerpt関数は、3つの引数を受け取ります。最初の$contentは元の長いテキスト文字列、次の$lengthは生成する抜粋の最大文字数を整数で指定し（デフォルトは55）、最後の$moreは抜粋の末尾に追加される文字列です（デフォルトは'...'）。この関数は、HTMLタグを除去し、指定された文字数でテキストを切り詰め、さらに単語の途中で切れないように調整した抜粋文字列を返します。内部では、strip_tags関数でHTMLタグを除去し、mb_strlenやmb_substrといったマルチバイト文字対応の関数を使って、日本語のような複数バイト文字を含むテキストも正確に処理しています。

サンプルコンテンツの定義には、複数行の長い文字列を読みやすく記述できるPHPのHeredoc構文が使われています。この構文は<<<EOTのような開始デリミタで始まり、EOT;のような終了デリミタで終わる形式です。

T_END_HEREDOCは、PHPがHeredoc構文の終了デリミタを構文解析する際に、その位置を識別するために内部的に使用する整数値の定数です。これはPHPの拡張機能の一部であり、PHPがコードをどのように解釈しているかを示す「トークン」の一つです。通常のアプリケーション開発でこの定数を直接扱うことはほとんどありませんが、PHPの構文解析の仕組みを理解する上で役立ちます。token_name()関数を使うと、この整数値がどのようなトークン名を表しているかを確認できます。