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

Copy
1<?php
2
3/**
4 * DOMNode::normalize() の動作を示すサンプルコードです。
5 *
6 * この関数は、DOM要素内に意図的に分割して追加された複数のテキストノードが、
7 * normalize() メソッドの呼び出しによって、どのように1つのノードに結合
8 * (正規化) されるかを示します。
9 *
10 * 指定された DOMEntityReference::normalize() も、すべてのDOMノードが
11 * 継承するこの DOMNode::normalize() の仕組みに基づいています。
12 */
13function demonstrateNodeNormalization(): void
14{
15    // 1. 新しいDOMDocumentオブジェクトを作成します。
16    $doc = new DOMDocument('1.0', 'UTF-8');
17    // 出力されるXMLを見やすくするためにフォーマットを有効にします。
18    $doc->formatOutput = true;
19
20    // 2. ルート要素 <message> を作成し、ドキュメントに追加します。
21    $rootElement = $doc->createElement('message');
22    $doc->appendChild($rootElement);
23
24    // 3. 複数の隣接するテキストノードを作成し、ルート要素に追加します。
25    // これらは内部的に別々のノードとして扱われます。
26    $rootElement->appendChild($doc->createTextNode('Hello'));
27    $rootElement->appendChild($doc->createTextNode(', '));
28    $rootElement->appendChild($doc->createTextNode('World!'));
29
30    // 4. normalize() を呼び出す前の状態を出力します。
31    // 子ノードが3つ存在することを確認できます。
32    echo "--- Before normalize() ---\n";
33    echo "Child node count: " . $rootElement->childNodes->length . "\n";
34    echo $doc->saveXML();
35
36    // 5. ルート要素に対して normalize() を呼び出します。
37    // これにより、<message>要素直下の隣接するテキストノードが1つに結合されます。
38    $rootElement->normalize();
39
40    // 6. normalize() を呼び出した後の状態を出力します。
41    // 子ノードが1つに結合されたことを確認できます。
42    echo "\n--- After normalize() ---\n";
43    echo "Child node count: " . $rootElement->childNodes->length . "\n";
44    echo $doc->saveXML();
45}
46
47// 関数を実行して結果を表示します。
48demonstrateNodeNormalization();

このDOMEntityReference::normalize()メソッドは、ノードとその子孫ツリー内にある隣接したテキストノードを1つのノードに結合し、DOM構造を正規化するために使用されます。この機能は、すべてのDOMノードの基盤となるDOMNodeクラスから継承されたものです。

サンプルコードでは、まず<message>という要素の中に「Hello」「, 」「World!」という3つの独立したテキストノードが追加されます。normalize()を呼び出す前は、これらのノードは別々に存在するため、子ノードの数は3つです。

次に、親である<message>要素に対してnormalize()メソッドを呼び出します。これにより、3つの隣接するテキストノードが1つに統合され、「Hello, World!」という単一のテキストノードが生成されます。その結果、normalize()実行後の子ノード数は1つとなり、DOM構造がより単純で扱いやすい形に整理されていることがわかります。

このメソッドは引数を必要とせず、戻り値もありません。呼び出したノード自体の状態を直接変更する操作を行います。

Copy
1<?php
2
3/**
4 * DOMNode::normalize の動作を実演します。
5 *
6 * DOMEntityReference は DOMNode クラスを継承しており、normalize メソッドも利用できます。
7 * このメソッドは、ノードとそのサブツリー全体を「正規化」します。
8 * 具体的には、隣接するテキストノードを1つにマージし、空のテキストノードを削除します。
9 * これにより、DOMツリー内の文字列の断片化が解消されます。
10 */
11function demonstrateDomNodeNormalize(): void
12{
13    // 1. DOMDocument オブジェクトを作成
14    $doc = new DOMDocument('1.0', 'UTF-8');
15    // 出力を見やすくフォーマットする
16    $doc->formatOutput = true;
17
18    // 2. 親要素と、意図的に断片化された子ノードを作成
19    $parentElement = $doc->createElement('message');
20
21    // 隣接する2つのテキストノード
22    $textNode1 = $doc->createTextNode('隣接するテキストノードは');
23    $textNode2 = $doc->createTextNode('1つに結合されます。');
24
25    // テキストノードの間にエンティティ参照を挟む例
26    $entityRef = $doc->createEntityReference('amp'); // & のエンティティ参照
27    $textNode3 = $doc->createTextNode('これはエンティティ参照です。');
28
29    // 親要素に子ノードを追加
30    $parentElement->appendChild($textNode1);
31    $parentElement->appendChild($textNode2);
32    $parentElement->appendChild($entityRef);
33    $parentElement->appendChild($textNode3);
34    $doc->appendChild($parentElement);
35
36    // 3. 正規化前のXMLを出力
37    // $textNode1 と $textNode2 が別々のノードとして存在することに注目
38    echo "--- Before normalize() ---\n";
39    echo $doc->saveXML();
40    echo "\n";
41
42    // 4. 親要素に対して normalize() を実行
43    // この操作により、$parentElement の子ノードが正規化されます。
44    // $textNode1 と $textNode2 は隣接しているため、1つのテキストノードにマージされます。
45    $parentElement->normalize();
46
47    // 5. 正規化後のXMLを出力
48    // テキストノードが1つに結合されていることを確認できます。
49    echo "--- After normalize() ---\n";
50    echo $doc->saveXML();
51}
52
53// 関数を実行して結果を確認
54demonstrateDomNodeNormalize();

DOMEntityReferenceクラスのnormalizeメソッドは、XMLやHTMLのドキュメント構造（DOMツリー）を整理するための機能です。このメソッドは親クラスであるDOMNodeから継承しており、特定のノードとそのすべての子孫ノードを「正規化」します。正規化の主な処理として、隣り合って存在する複数のテキストノードを、内容を維持したまま1つのテキストノードに結合します。また、内容が空のテキストノードは削除されます。これにより、プログラムによる操作で断片化してしまったテキスト情報を整理し、扱いやすい状態に整えることができます。

サンプルコードでは、まず親要素の中に「隣接するテキストノードは」と「1つに結合されます。」という2つのテキストノードを意図的に隣接させて配置しています。normalizeメソッドを呼び出す前は、これらが別々のノードとして出力されます。次に、親要素に対してnormalizeメソッドを実行すると、この2つのテキストノードが1つにマージされ、XMLの構造がシンプルになることを確認できます。

このメソッドは引数を取らず、呼び出し元に値を返しません（戻り値なし）。代わりに、メソッドを呼び出したノードオブジェクトの状態を直接変更します。