【PHP8.x】XMLReader::TEXT定数の使い方

Copy
1<?php
2
3/**
4 * XMLReader を使用して XML 文字列からテキストコンテンツを抽出し、HTML の textarea に表示します。
5 * XMLReader::TEXT 定数を用いてテキストノードを識別する方法を示します。
6 *
7 * @param string $xmlString 読み込むXML文字列
8 * @return string HTMLのtextareaタグを含む文字列
9 */
10function extractAndDisplayXmlTextInTextarea(string $xmlString): string
11{
12    // XMLReader オブジェクトを初期化します。
13    // XMLReader は、XMLドキュメントを前方のみに移動しながら効率的に読み込むためのクラスです。
14    $reader = new XMLReader();
15
16    // 提供されたXML文字列をXMLReaderに読み込ませます。
17    // 失敗した場合はエラーメッセージを返します。
18    if (!$reader->xml($xmlString)) {
19        return '<textarea rows="10" cols="50">XMLの読み込みに失敗しました。</textarea>';
20    }
21
22    $allTextContent = []; // 抽出したすべてのテキストコンテンツを保存する配列
23
24    // XMLドキュメント内の各ノードを順に読み進めます。
25    while ($reader->read()) {
26        // 現在のノードのタイプがテキストノードであるかを確認します。
27        // XMLReader::TEXT は、テキストノードを識別するための定数です（int型）。
28        if ($reader->nodeType === XMLReader::TEXT) {
29            // テキストノードの場合、その値（テキストコンテンツ）を取得し、配列に追加します。
30            $allTextContent[] = $reader->value;
31        }
32    }
33
34    // XMLReader の使用を終了し、リソースを解放します。
35    $reader->close();
36
37    // 抽出されたすべてのテキストコンテンツを改行で結合します。
38    $combinedText = implode("\n", $allTextContent);
39
40    // 結合されたテキストコンテンツを HTML の textarea タグで囲んで返します。
41    // htmlspecialchars 関数を使用して、XSS (クロスサイトスクリプティング) 攻撃を防ぐためにHTMLエンティティに変換します。
42    return '<textarea rows="10" cols="50">' . htmlspecialchars($combinedText, ENT_QUOTES | ENT_HTML5) . '</textarea>';
43}
44
45// サンプルとして使用するXMLデータ。
46// textarea に表示されることを想定し、複数の要素と改行を含むテキストを含めます。
47$sampleXmlData = <<<XML
48<document>
49    <paragraph>
50        これは最初の段落です。
51        複数の行にわたるテキストを含んでいます。
52    </paragraph>
53    <section>
54        <title>セクションタイトル</title>
55        <content>
56            このセクションには、重要な情報が含まれます。
57            例えば、日付: 2023-10-27 や、
58            特別な記号: &amp;lt;script&amp;gt; などです。
59        </content>
60    </section>
61    <note>
62        XMLReader::TEXT は要素間の空白や改行もテキストノードとして認識することがあります。
63    </note>
64</document>
65XML;
66
67// 上記の関数を呼び出し、生成された HTML をブラウザに出力します。
68echo extractAndDisplayXmlTextInTextarea($sampleXmlData);
69
70?>

このPHPのサンプルコードは、XMLReaderクラスとXMLReader::TEXT定数を用いて、XML文字列からテキストコンテンツを抽出し、HTMLの<textarea>に表示する手順を説明します。XMLReaderは、XMLドキュメントをメモリ効率良く、前方のみに移動しながら読み込むためのクラスです。

extractAndDisplayXmlTextInTextarea関数は、読み込みたいXML文字列を$xmlString引数として受け取ります。関数が実行されると、まずXMLReaderオブジェクトが初期化され、提供されたXML文字列を読み込みます。

その後、XMLドキュメント内の各ノードを順に処理します。ループ内で、現在のノードタイプがXMLReader::TEXT定数（テキストノードを示す整数値）と一致するかを確認します。この定数を使用することで、要素間のテキスト、CDATAセクションの内容など、XML内の純粋なテキスト部分を正確に識別できます。テキストノードが見つかった場合、その値（テキストコンテンツ）を抽出し、一時的に保存します。XMLReaderは要素間の空白や改行もテキストノードとして認識することがあります。

全てのノードの読み込みが完了したら、抽出されたテキストコンテンツは改行で結合されます。最終的に、結合されたテキストは、XSS（クロスサイトスクリプティング）攻撃を防ぐためにhtmlspecialchars関数で適切にエスケープされ、HTMLの<textarea>タグに包まれた文字列として返されます。この戻り値は、ウェブページでXMLから抽出されたテキストをユーザーが確認・編集できる形で表示するために利用されます。

Copy
1<?php
2
3/**
4 * フォームからのテキスト入力を受け取り、XMLに埋め込み、
5 * XMLReaderでテキストノードを読み取り、改行を処理して表示するサンプルコードです。
6 *
7 * XMLReader::TEXT 定数を使用して、ノードタイプがテキストノードであることを識別します。
8 * textareaからの入力には改行が含まれるため、XMLに埋め込む際は安全にエスケープし、
9 * 表示時には nl2br 関数でHTMLの <br> タグに変換します。
10 */
11function handleTextareaAndXmlTextNode(): void
12{
13    $xmlContent = '';
14    $originalText = '';
15    $foundTextNodes = [];
16
17    // POSTリクエストがあり、'user_input' が設定されている場合
18    if ($_SERVER['REQUEST_METHOD'] === 'POST' && isset($_POST['user_input'])) {
19        $originalText = (string)$_POST['user_input'];
20
21        // textarea からの改行を含むテキストを XML 要素の内容として安全に埋め込む
22        // ENT_XML1 フラグを使用して、XMLに適したエンティティに変換します。
23        // 改行文字 (\n) はXMLではそのまま許容されるため、エスケープされずに残ります。
24        $escapedXmlText = htmlspecialchars($originalText, ENT_XML1, 'UTF-8');
25
26        // 生成するXMLドキュメント
27        $xmlContent = <<<XML
28<?xml version="1.0" encoding="UTF-8"?>
29<data>
30    <message>{$escapedXmlText}</message>
31    <note>これは別のテキストノードです。</note>
32</data>
33XML;
34
35        echo "<h2>入力されたテキスト（元の状態）:</h2>";
36        // 表示時にHTML特殊文字をエスケープして <pre> タグで整形して表示
37        echo '<pre>' . htmlspecialchars($originalText) . '</pre>';
38        echo "<hr>";
39
40        echo "<h2>生成されたXML:</h2>";
41        // 生成したXML自体をHTML特殊文字をエスケープして表示
42        echo '<pre>' . htmlspecialchars($xmlContent) . '</pre>';
43        echo "<hr>";
44
45        echo "<h2>XMLReaderによるテキストノードの読み込み結果:</h2>";
46        $reader = new XMLReader();
47        // XML文字列を読み込みソースとして設定
48        $reader->XML($xmlContent);
49
50        // XMLドキュメント内の各ノードを順に読み進める
51        while ($reader->read()) {
52            // 現在のノードのタイプが XMLReader::TEXT (テキストノード) であるかを確認
53            // XMLReader::TEXT は、要素の内容など、純粋なテキストデータを表します。
54            if ($reader->nodeType === XMLReader::TEXT) {
55                // テキストノードの値を取得
56                $nodeValue = $reader->value;
57                $foundTextNodes[] = $nodeValue;
58            }
59        }
60        $reader->close(); // XMLReaderのリソースを解放
61
62        if (!empty($foundTextNodes)) {
63            echo "<h3>検出されたテキストノードの内容:</h3>";
64            foreach ($foundTextNodes as $text) {
65                // textarea由来の改行をHTMLで表示するために <br> タグに変換します。
66                // その後、HTML特殊文字を再度エスケープして安全に表示します。
67                echo nl2br(htmlspecialchars($text));
68                echo "<br>";
69            }
70        } else {
71            echo "<p>XMLドキュメントからテキストノードは検出されませんでした。</p>";
72        }
73        echo "<hr>";
74    }
75
76    // テキスト入力フォームを表示
77    echo '<h2>テキスト入力フォーム:</h2>';
78    echo '<form method="post">';
79    echo '<label for="user_input_textarea">複数行のテキストを入力してください:</label><br>';
80    echo '<textarea id="user_input_textarea" name="user_input" rows="10" cols="50">';
81    // 前回入力されたテキストがあれば表示（HTML特殊文字をエスケープ）
82    echo htmlspecialchars($originalText);
83    echo '</textarea><br>';
84    echo '<input type="submit" value="XMLを生成して読み込む">';
85    echo '</form>';
86}
87
88// 関数を実行して、Webページとして動作させる
89handleTextareaAndXmlTextNode();
90
91?>

PHPのXMLReader::TEXT定数は、XMLドキュメントを効率的に読み解くためのXMLReaderクラスにおいて、現在処理しているノードが「テキストノード」であることを示すために用いられる整数値の定数です。この定数自体に引数はなく、戻り値は内部的に定義された整数値です。XMLにおけるテキストノードとは、要素の開始タグと終了タグの間に含まれる純粋な文字データのことです。

サンプルコードでは、ユーザーがWebフォームのtextareaに入力した複数行のテキストデータを受け取ります。このテキストは、改行を含んだままhtmlspecialchars関数で安全にXML要素内に埋め込まれます。その後、XMLReaderを使って生成されたXMLドキュメントを解析し、各ノードを順に読み進める過程で、if ($reader->nodeType === XMLReader::TEXT)という条件式を用いてテキストノードであるかを判断しています。XMLReader::TEXT定数とノードタイプが一致した場合、そのノードの値（$reader->value）がテキストデータとして抽出されます。抽出されたテキストは、元のtextareaの改行をWebブラウザ上で<br>タグとして表示するためにnl2br関数で変換され、最終的に画面に表示されます。このように、XMLReader::TEXT定数は、XMLの内容から特定のテキスト情報を正確に識別し、抽出する際に中心的な役割を果たします。