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

Copy
1<?php
2
3// DOMDocumentオブジェクトを初期化します。
4// XML宣言を1.0、エンコーディングをUTF-8に設定します。
5$dom = new DOMDocument('1.0', 'UTF-8');
6$dom->formatOutput = true; // 出力を見やすく整形します。
7
8// ルート要素（例: html）を作成し、DOMドキュメントに追加します。
9$htmlElement = $dom->createElement('html');
10$dom->appendChild($htmlElement);
11
12// コメントノードを作成します。
13$commentNode = $dom->createComment("これはテストコメントです。");
14
15// 作成したコメントノードをHTML要素の子として追加します。
16$htmlElement->appendChild($commentNode);
17
18echo "--- normalize() 呼び出し前のXML ---" . PHP_EOL;
19echo $dom->saveXML() . PHP_EOL;
20
21// DOMComment オブジェクトに対して normalize() メソッドを呼び出します。
22// DOMNodeから継承された normalize() メソッドは、通常、
23// 隣接するDOMTextノードを結合したり、空のDOMTextノードを削除したりするために使用されます。
24// しかし、DOMCommentノード自体は子にDOMTextノードを持たないため、
25// このメソッドをDOMCommentオブジェクトに対して直接呼び出しても、
26// コメントノードの内容に目に見える変化は生じません。
27$commentNode->normalize();
28
29echo "--- normalize() 呼び出し後のXML ---" . PHP_EOL;
30echo $dom->saveXML() . PHP_EOL;
31
32// コメントノードの内容は normalize() によって変化しないことを確認できます。
33echo "コメントノードの内容: " . $commentNode->nodeValue . PHP_EOL;
34
35?>

PHPのDOMComment::normalize()メソッドは、DOM（Document Object Model）ツリーの構造を正規化するために使用されるメソッドです。このメソッドは引数を取らず、戻り値もありません。

本来、DOMNodeクラスから継承されたnormalize()は、DOMツリー内の隣接するDOMTextノードを結合したり、空のDOMTextノードを削除したりすることで、ツリーの表現を簡潔にする役割があります。

しかし、DOMCommentはXMLやHTMLのコメントを表すノードであり、その内部に子ノードとしてテキストノードを持つことはありません。そのため、サンプルコードが示すように、DOMCommentオブジェクトに対してnormalize()を呼び出しても、コメントノードの内容自体に変化は生じません。

サンプルコードでは、DOMDocumentにコメントノードを追加し、normalize()呼び出し前後でXML出力を比較しています。結果、コメントノードの内容に変化がないことが確認でき、DOMComment::normalize()がコメントノードには影響を与えないことを実証しています。このメソッドは、主にテキストノードの最適化に用いられると理解してください。