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

Copy
1<?php
2
3/**
4 * DOMNode::normalize() の動作を示すサンプルコードです。
5 *
6 * このメソッドは、ノード内の隣接するテキストノードを1つにまとめ、
7 * 空のテキストノードを削除することで、DOMツリーを「正規化」します。
8 *
9 * PHP 8の Dom\EntityReference クラスも、内部的にはこの機能を持つ
10 * DOMNode クラスを継承しています。
11 * このサンプルでは、より分かりやすい DOMElement を使って正規化の動作を解説します。
12 */
13function demonstrateDomNormalization(): void
14{
15    // 1. DOMDocumentオブジェクトを準備します
16    $dom = new DOMDocument('1.0', 'UTF-8');
17    // 出力されるXMLを見やすくフォーマットします
18    $dom->formatOutput = true;
19
20    // 2. 正規化の対象となる要素と、断片化されたテキストノードを作成します
21    $parent = $dom->createElement('message');
22    
23    // 意図的にテキストを3つのノードに分割して追加します
24    $text1 = $dom->createTextNode('隣接する');
25    $text2 = $dom->createTextNode('テキストノードは');
26    $text3 = $dom->createTextNode('1つに結合されます。');
27    // 空のテキストノードも追加します（これは削除されます）
28    $emptyText = $dom->createTextNode('');
29
30    $parent->appendChild($text1);
31    $parent->appendChild($text2);
32    $parent->appendChild($emptyText); // 空ノード
33    $parent->appendChild($text3);
34
35    $dom->appendChild($parent);
36
37    // 3. normalize() を呼び出す前の状態を確認します
38    // この時点では、テキストノードは複数に分かれています
39    echo "--- normalize() 実行前 ---\n";
40    echo "子ノードの数: " . $parent->childNodes->length . "\n";
41    echo $dom->saveXML($parent);
42    echo "\n\n";
43
44    // 4. normalize() を実行して、ノードを正規化します
45    $parent->normalize();
46
47    // 5. normalize() を呼び出した後の状態を確認します
48    // 隣接していたテキストノードが1つに結合され、空のノードが削除されたことを確認できます
49    echo "--- normalize() 実行後 ---\n";
50    echo "子ノードの数: " . $parent->childNodes->length . "\n";
51    echo $dom->saveXML($parent);
52    echo "\n";
53}
54
55// 作成した関数を実行します
56demonstrateDomNormalization();

このPHPサンプルコードは、normalize()メソッドを使用してXMLやHTMLの文書構造（DOMツリー）を整理する方法を示しています。normalize()メソッドは、指定した要素内にある隣接した複数のテキストノードを一つのテキストノードに結合し、さらに空のテキストノードを削除する機能を持っています。これにより、文書構造がシンプルになり、プログラムで処理しやすくなります。

サンプルでは、まず<message>という親要素を作成し、その中に意図的に「隣接する」「テキストノードは」「1つに結合されます。」という3つのテキストノードと、1つの空のテキストノードを追加しています。normalize()を実行する前の時点では、これらの4つのノードは別々に存在しています。

次に、この親要素に対してnormalize()を実行すると、隣り合っていた3つのテキストノードが1つにまとめられ、空のテキストノードは取り除かれます。その結果、子ノードは1つに集約され、XMLの構造が整理されていることが確認できます。

このメソッドは引数を必要とせず、呼び出したノード自体を直接変更するため、戻り値はありません（void）。Dom\EntityReferenceクラスのメソッドですが、DOMを扱う多くのクラスで同様に利用できます。

Copy
1<?php
2
3/**
4 * Dom\Node::normalize() の使用例です。
5 *
6 * このメソッドは、指定されたノードとそのサブツリーを「正規化」します。
7 * 主な動作として、隣接するテキストノードを1つにマージします。
8 * リファレンス情報にある Dom\EntityReference::normalize() も、
9 * 親クラスである Dom\Node からこの機能を継承しているため、同様に動作します。
10 */
11function demonstrateDomNodeNormalization(): void
12{
13    // 1. Dom\Document オブジェクトを作成します。
14    $doc = new Dom\Document();
15
16    // 2. <message> というルート要素を作成します。
17    $root = $doc->createElement('message');
18    $doc->appendChild($root);
19
20    // 3. 意図的に3つの隣接するテキストノードを作成し、<message>要素に追加します。
21    $root->appendChild($doc->createTextNode('php '));
22    $root->appendChild($doc->createTextNode('normalize '));
23    $root->appendChild($doc->createTextNode('string'));
24
25    // --- normalize() 呼び出し前 ---
26    // <message>要素は3つの子ノード（テキストノード）を持っています。
27    echo 'Before normalize(): ' . $root->childNodes->length . ' child nodes' . PHP_EOL;
28
29    // 4. <message>要素に対して normalize() を呼び出します。
30    $root->normalize();
31
32    // --- normalize() 呼び出し後 ---
33    // 隣接していた3つのテキストノードが1つにマージされました。
34    echo 'After normalize(): ' . $root->childNodes->length . ' child node' . PHP_EOL;
35
36    // 5. 最終的なXML構造を確認します。
37    echo 'Final XML: ' . $doc->saveXML($root) . PHP_EOL;
38}
39
40demonstrateDomNodeNormalization();

Dom\EntityReference::normalize() は、ノードとその内部を正規化するためのメソッドです。このメソッドの主な役割は、隣り合って存在する複数のテキストノードを、内容を維持したまま一つのテキストノードに結合することです。これにより、XMLやHTMLの構造がよりシンプルで扱いやすい形に整理されます。

このメソッドは引数を必要とせず、呼び出すだけで動作します。また、戻り値は void であり、何も返しません。その代わり、メソッドを呼び出したノードオブジェクトの状態が直接変更されます。

サンプルコードでは、まず <message> という要素を作成し、その子要素として 'php ', 'normalize ', 'string' という3つの独立したテキストノードを追加しています。この段階では、<message> 要素は3つの子ノードを持っています。次に、<message> 要素に対して normalize() を呼び出すと、隣接していた3つのテキストノードが結合され、'php normalize string' という一つのテキストノードにまとめられます。その結果、<message> 要素の子ノードは1つになります。Dom\EntityReference は親クラスの Dom\Node からこの機能を継承しているため、同様に動作します。