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

Copy
1<?php
2
3/**
4 * DOMText::isWhitespaceInElementContent メソッドの動作を示すサンプルコード。
5 *
6 * このメソッドは、DOMTextノードが要素の内容として空白文字（スペース、タブ、改行）のみで
7 * 構成されているかを判断します。
8 * DOMDocument::preserveWhiteSpace の設定がこのメソッドの動作に与える影響も合わせて示します。
9 */
10function demonstrateIsWhitespaceInElementContent(): void
11{
12    // サンプルXML文字列
13    // - XMLソース内のインデントや改行も、DOMツリー上ではDOMTextノードとして扱われることがあります。
14    // - <element_with_text_and_whitespace> はテキストと空白の両方を含む例です。
15    // - <just_whitespace> は空白文字のみで構成されるノードの例です。
16    $xmlString = <<<XML
17<root>
18    <item>
19        これは意味のあるテキストです。
20        <subitem>別の意味のあるテキスト。</subitem>
21        さらにテキスト。
22    </item>
23    <element_with_text_and_whitespace>
24        末尾にスペースがあるテキスト。   
25    </element_with_text_and_whitespace>
26    <just_whitespace>
27        <!-- この要素の中身は改行とスペースのみです -->
28        
29    </just_whitespace>
30    <empty_element/>
31</root>
32XML;
33
34    $dom = new DOMDocument();
35    // DOMDocument::preserveWhiteSpace を true に設定することで、
36    // XMLソース内のインデントや改行もDOMTextノードとしてDOMツリーに保持されます。
37    // この設定が false の場合、これらの空白のみのノードはほとんどが削除され、
38    // isWhitespaceInElementContent メソッドのデモンストレーションが難しくなります。
39    $dom->preserveWhiteSpace = true;
40    $dom->loadXML($xmlString);
41
42    $xpath = new DOMXPath($dom);
43
44    // すべてのDOMTextノードを取得
45    $textNodes = $xpath->query('//text()');
46
47    echo "DOMText::isWhitespaceInElementContent() のデモンストレーション:\n";
48    echo "---------------------------------------------------------\n";
49
50    $nodeCounter = 1;
51    foreach ($textNodes as $node) {
52        if ($node instanceof DOMText) {
53            $isWhitespace = $node->isWhitespaceInElementContent();
54            
55            // ノードの内容をより分かりやすく表示するため、特殊文字を変換し、
56            // 複数の空白を1つに圧縮してからトリムします。
57            $displayContent = str_replace(["\n", "\r", "\t"], ['\\n', '\\r', '\\t'], $node->textContent);
58            $displayContent = preg_replace('/\s+/', ' ', $displayContent); // 複数の空白を1つのスペースに
59            $displayContent = trim($displayContent); // 前後の空白をトリム
60
61            echo "ノード #" . $nodeCounter++ . ":\n";
62            echo "  コンテンツ (表示用): '" . (empty($displayContent) ? '[空白のみのノード]' : $displayContent) . "'\n";
63            echo "  isWhitespaceInElementContent(): " . ($isWhitespace ? 'true' : 'false') . "\n";
64            echo "---------------------------------------------------------\n";
65        }
66    }
67}
68
69// 関数を実行して、DOMText::isWhitespaceInElementContent の動作を確認します。
70demonstrateIsWhitespaceInElementContent();
71

PHP 8のDOMText::isWhitespaceInElementContentメソッドは、DOMツリー内のテキストノードが要素の内容における空白文字（スペース、タブ、改行など）のみで構成されているかを判定します。引数はなく、結果は真偽値（bool）で返されます。テキストノードが純粋な空白文字で、かつその空白がXMLの構造的なインデントや整形のためのものである場合にtrueを返し、意味のあるテキストや要素の内容として重要な空白を含む場合はfalseを返します。

このサンプルコードでは、DOMDocument::preserveWhiteSpaceプロパティをtrueに設定することで、XMLソース内のインデントや改行もDOMツリー上のDOMTextノードとして保持されるようにしています。この設定がないと、ほとんどの空白のみのノードがDOMツリーから削除され、isWhitespaceInElementContentのデモンストレーションが難しくなります。コードは、定義されたXMLを解析し、すべてのDOMTextノードを抽出します。そして、それぞれのノードに対してisWhitespaceInElementContentメソッドを適用し、その結果とノードの表示内容を比較することで、XML構造における空白文字の役割と、本メソッドの振る舞いを具体的に確認できます。

Copy
1<?php
2
3// Create a new DOMDocument instance.
4// DOMDocument is a core PHP class for working with XML and HTML documents.
5$dom = new DOMDocument();
6
7// To correctly identify "ignorable whitespace" using isWhitespaceInElementContent(),
8// it's essential to preserve whitespace nodes during parsing and load a Document Type Definition (DTD).
9// The DTD defines the content model for elements, which in turn determines
10// whether whitespace between elements is considered ignorable formatting or significant content.
11$dom->preserveWhiteSpace = true;
12// Setting validateOnParse to true can also help ensure the DTD is actively used for content model interpretation.
13// $dom->validateOnParse = true;
14
15// Example XML string with an internal DTD and various types of whitespace text nodes.
16// The DTD dictates that:
17// - 'document' contains 'items'
18// - 'items' contains one or more 'item' elements
19// - 'item' contains '#PCDATA' (Parsed Character Data), meaning its content is raw text.
20// This setup allows us to demonstrate how whitespace between elements (ignorable)
21// differs from whitespace within an element defined as (#PCDATA) (non-ignorable).
22//
23// The keyword "white spaces are required between publicid and systemid" refers to a
24// specific syntactic rule within a DOCTYPE declaration (e.g., <!DOCTYPE root PUBLIC "..." "...">).
25// While `isWhitespaceInElementContent` does not directly check *that* specific whitespace,
26// the DTD (where publicid and systemid are used) is crucial for this method, as it defines
27// the content models that determine if other whitespace *within the document body* is ignorable.
28$xmlString = <<<XML
29<?xml version="1.0"?>
30<!DOCTYPE document [
31  <!ELEMENT document (items)>
32  <!ELEMENT items (item+)>
33  <!ELEMENT item (#PCDATA)>
34]>
35<document>
36    <items>
37        <!-- Text Node 1: This is ignorable whitespace for formatting between <items> and the first <item> -->
38        <item id="1">Some Text Content</item>
39        <!-- Text Node 2: This is ignorable whitespace for formatting between <item> elements -->
40        <item id="2">
41            <!-- Text Node 3: This whitespace and text are part of #PCDATA of <item>, thus NOT ignorable -->
42            More Text With Spaces
43        </item>
44        <!-- Text Node 4: This is ignorable whitespace for formatting between <item> elements -->
45        <item id="3">
46            <!-- Text Node 5: This text node contains ONLY whitespace. However, because its parent <item>
47                 is defined as (#PCDATA), this whitespace is considered part of the element's character data
48                 and is therefore NOT ignorable. -->
49            
50        </item>
51    </items>
52    <!-- Text Node 6: This is ignorable whitespace for formatting between </items> and </document> -->
53</document>
54XML;
55
56// Load the XML string into the DOMDocument.
57$dom->loadXML($xmlString);
58
59echo "Analyzing DOM text nodes for whitespace properties:\n";
60echo "-----------------------------------------------------\n";
61
62/**
63 * Recursively traverses DOM nodes to find DOMText instances and analyze their whitespace.
64 *
65 * @param DOMNode $node   The current node to start traversal from.
66 * @param int     $indent Current indentation level for output formatting.
67 */
68function analyzeWhitespace(DOMNode $node, int $indent = 0): void
69{
70    foreach ($node->childNodes as $child) {
71        $prefix = str_repeat('  ', $indent);
72
73        if ($child instanceof DOMText) {
74            // Get the raw value of the text node, including all newlines and spaces.
75            $textValue = $child->nodeValue;
76            
77            // For display, replace common whitespace characters with their escaped versions
78            // to make them visible in the output.
79            $displayValue = str_replace(["\n", "\r", "\t"], ['\\n', '\\r', '\\t'], $textValue);
80            
81            echo $prefix . "Text Node (Raw Value: \"{$displayValue}\"):\n";
82            
83            // isWhitespaceInElementContent() checks two main conditions:
84            // 1. If the text node consists solely of whitespace characters (spaces, tabs, newlines).
85            // 2. If, according to the document's DTD/schema and the parent element's content model,
86            //    this whitespace is considered "ignorable" (i.e., purely for formatting and not meaningful content).
87            //    Whitespace within elements defined as (#PCDATA) is generally NOT ignorable.
88            $isIgnorable = $child->isWhitespaceInElementContent();
89            
90            echo $prefix . "  -> isWhitespaceInElementContent(): " . ($isIgnorable ? "true" : "false") . "\n";
91        } elseif ($child instanceof DOMElement) {
92            echo $prefix . "Element: <" . $child->nodeName . ">\n";
93            // Recursively call the function for child elements to traverse deeper.
94            analyzeWhitespace($child, $indent + 1);
95        }
96    }
97}
98
99// Start the analysis from the root element of the document.
100analyzeWhitespace($dom->documentElement);
101
102?>

PHP 8のDOMText::isWhitespaceInElementContentメソッドは、XMLやHTMLドキュメント内で見つかったテキストノードが、その親要素のコンテンツにおいて「無視できる空白」であるかを判断します。このメソッドは引数を受け取らず、結果を真偽値（bool）で返します。trueであればそのテキストノードは無視できる空白であり、falseであればそうではないと判断されます。

このメソッドが「無視できる空白」と判断するかどうかは、ドキュメントのDTD（Document Type Definition）やXMLスキーマによって定義される要素のコンテンツモデルに大きく依存します。例えば、XML構造を整形するための要素間の改行やインデントは、一般的に「整形目的の無視できる空白」と見なされることがあります。しかし、要素の内容がパース済み文字データ（#PCDATA）として定義されている場合、その内部に含まれる空白は意味を持つ内容の一部として扱われるため、無視できない空白と判断されます。

サンプルコードでは、DOMツリー構築時に空白ノードを保持するため$dom->preserveWhiteSpace = true;を設定し、さらにDTDを用いてXMLをロードしています。これにより、<item>要素間の空白は整形目的と判断されtrueを返しますが、#PCDATAとして定義された<item>要素内部の空白は内容の一部とみなされfalseを返します。この挙動は、DTDが空白の役割を決定する上で極めて重要であることを示しています。キーワードである「publicidとsystemidの間に空白が必要」はDTD宣言の構文ルールを指しますが、このメソッド自体はDTDの内容に基づいて文書内の空白を評価するという点で、DTDの重要性に関連しています。