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

Copy
1<?php
2
3/**
4 * Dom\Node::normalize() の動作を示すサンプルコード。
5 * このメソッドは、要素内の隣接するテキストノードを1つにマージし、
6 * 空のテキストノードを削除することで、DOMツリーを正規化します。
7 * Dom\Entity は Dom\Node を継承しているため、同じ normalize() メソッドを持ちます。
8 * この例では、より一般的な Dom\Element を使用して normalize() の効果を実証します。
9 */
10function demonstrateDomNormalize(): void
11{
12    // DOMDocumentオブジェクトを作成
13    $doc = new DOMDocument('1.0', 'UTF-8');
14    // 出力されるXMLを整形する
15    $doc->formatOutput = true;
16
17    // ルート要素 <book> を作成
18    $book = $doc->createElement('book');
19    $doc->appendChild($book);
20
21    // <title> 要素を作成
22    $title = $doc->createElement('title');
23    $book->appendChild($title);
24
25    // 意図的に複数の隣接するテキストノードを作成して <title> に追加
26    $text1 = $doc->createTextNode('PHP 8 ');
27    $text2 = $doc->createTextNode('Cookbook');
28    $emptyText = $doc->createTextNode(''); // 空のテキストノード
29    $text3 = $doc->createTextNode(' Sample');
30
31    $title->appendChild($text1);
32    $title->appendChild($text2);
33    $title->appendChild($emptyText); // 空のノードも追加
34    $title->appendChild($text3);
35
36    // --- 正規化前の状態を出力 ---
37    echo "--- Before normalize() ---" . PHP_EOL;
38    // <title> 要素の子ノードの数を確認（テキストノードが複数存在）
39    echo "Number of child nodes in <title>: " . $title->childNodes->length . PHP_EOL;
40    echo $doc->saveXML();
41    echo PHP_EOL;
42
43    // --- ドキュメント全体を正規化 ---
44    // book要素やtitle要素など、特定のノードに対して normalize() を呼び出すことも可能です。
45    $doc->normalize();
46
47    // --- 正規化後の状態を出力 ---
48    echo "--- After normalize() ---" . PHP_EOL;
49    // <title> 要素の子ノードの数を確認（テキストノードが1つにマージされ、空ノードが削除されている）
50    echo "Number of child nodes in <title>: " . $title->childNodes->length . PHP_EOL;
51    echo $doc->saveXML();
52}
53
54demonstrateDomNormalize();

Dom\Entity::normalize()メソッドは、XMLやHTMLの文書構造（DOMツリー）を整理し、正規化するための機能です。このメソッドを呼び出すと、隣り合って存在する複数のテキストノードが1つのテキストノードに結合され、内容が空のテキストノードは削除されます。これにより、文書の構造がシンプルになり、プログラムでの処理がしやすくなります。

このメソッドは引数を取らず、戻り値もありません（void）。呼び出されたノードとその子孫ノードの状態が直接変更されます。

サンプルコードでは、まず<title>という要素の中に「PHP 8 」「Cookbook」「 Sample」という3つのテキストと、1つの空のテキストを、それぞれ別々のノードとして追加しています。normalize()を呼び出す前は、これらの4つのノードが個別に存在しているため、子ノードの数は4つです。

次に、ドキュメント全体に対してnormalize()を実行すると、バラバラだった3つのテキストノードが「PHP 8 Cookbook Sample」という1つのテキストノードに統合され、空のテキストノードは取り除かれます。その結果、<title>要素が持つ子ノードの数は1つに減り、XMLの構造が整理されていることが確認できます。このように、意図せず分割されたテキスト情報をきれいな形に整える目的で利用されます。

Copy
1<?php
2
3/**
4 * DOMNode::normalize() の使用例を示します。
5 *
6 * DOMNode::normalize() は、指定されたノードとそのすべての子孫ノードを正規化します。
7 * 主な処理として、隣接するテキストノードを1つのノードにマージし、
8 * 空のテキストノードを削除します。
9 * DOM操作によって断片化したテキストノードを整理し、構造をクリーンにする際に役立ちます。
10 *
11 * 指定された Dom\Entity クラスは DOMNode を継承しているため、このメソッドを持っています。
12 * このサンプルでは、より一般的な DOMDocument を使ってメソッドの動作を解説します。
13 *
14 * ※キーワード「php normalize string」が意図するであろう文字列のUnicode正規化
15 * （Normalizerクラスなど）とは機能が異なる点にご注意ください。
16 */
17function demonstrateDomNormalization(): void
18{
19    // 1. DOMDocumentオブジェクトを作成します。
20    $doc = new DOMDocument('1.0', 'UTF-8');
21    // 出力されるXMLを人間が読みやすいように整形します。
22    $doc->formatOutput = true;
23
24    // 2. ルート要素と、意図的に分割した複数のテキストノードを作成します。
25    $root = $doc->createElement('message');
26    $doc->appendChild($root);
27
28    $root->appendChild($doc->createTextNode('これは '));
29    $root->appendChild($doc->createTextNode('分割された '));
30    $root->appendChild($doc->createTextNode('テキストです。'));
31    $root->appendChild($doc->createTextNode('')); // 空のテキストノードも追加
32
33    // 3. normalize() を呼び出す前の状態を確認します。
34    // この時点では、<message>要素は4つの子ノード（テキストノード）を持っています。
35    echo "--- normalize() 実行前 ---" . PHP_EOL;
36    echo "子ノードの数: " . $root->childNodes->length . PHP_EOL;
37    echo $doc->saveXML();
38    echo PHP_EOL;
39
40    // 4. ドキュメント全体を正規化します。
41    // これにより、<message>要素内の隣接するテキストノードが1つにマージされ、
42    // 空のテキストノードは削除されます。
43    $doc->normalize();
44
45    // 5. normalize() を呼び出した後の状態を確認します。
46    // 子ノードが1つに結合されたことが確認できます。
47    echo "--- normalize() 実行後 ---" . PHP_EOL;
48    echo "子ノードの数: " . $root->childNodes->length . PHP_EOL;
49    echo $doc->saveXML();
50}
51
52// 関数を実行して結果を表示します。
53demonstrateDomNormalization();

Dom\Entity::normalize() メソッドは、XMLやHTMLの文書構造（DOMツリー）を整理整頓するための機能です。主な役割は2つあり、1つは隣り合って存在する複数のテキストノードを1つのノードに結合すること、もう1つは中身が空のテキストノードを削除することです。プログラムによってDOMを操作していると、テキストが意図せず細かく分割されてしまう場合があります。このメソッドを使うことで、そうした断片化されたノードを整理し、文書の構造をシンプルで扱いやすい状態に戻すことができます。

このメソッドに引数は必要ありません。また、戻り値はなく（void）、呼び出したノードとその子孫ノードの状態を直接変更します。

サンプルコードでは、まず意図的に「これは 」「分割された 」「テキストです。」という3つのテキストノードと、1つの空のテキストノードを作成しています。normalize() を呼び出す前は、これらは4つの別々のノードとして存在します。しかし、normalize() を実行すると、隣接するテキストノードが1つに結合され、空のノードは削除されます。その結果、最終的に「これは 分割された テキストです。」という内容を持つ1つのテキストノードにまとめられ、文書構造がクリーンになります。