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

Copy
1<?php
2
3// XMLDocument::normalize() のサンプルコード
4
5// 新しい XML ドキュメントを作成します。
6$dom = new DomDocument('1.0', 'UTF-8');
7
8// ルート要素を作成します。
9$root = $dom->createElement('root');
10$dom->appendChild($root);
11
12// テキストノードを作成し、ルート要素に追加します。
13$text1 = $dom->createTextNode("Hello, ");
14$root->appendChild($text1);
15$text2 = $dom->createTextNode("World!");
16$root->appendChild($text2);
17
18// ドキュメントを正規化します。
19$dom->normalize();
20
21// 正規化された XML を表示します。
22echo $dom->saveXML();
23
24?>

このサンプルコードは、PHPのDomDocumentクラスのnormalizeメソッドの使い方を示しています。normalizeメソッドは、XMLドキュメントを正規化するために使用されます。具体的には、隣接するテキストノードを結合したり、空のテキストノードを削除したりすることで、ドキュメントの構造を整理します。

この例では、まず新しいDomDocumentオブジェクトを作成し、ルート要素としてroot要素を追加しています。次に、"Hello, "と"World!"という2つのテキストノードを作成し、それぞれをroot要素の子ノードとして追加しています。この時点では、root要素の下に2つの連続したテキストノードが存在します。

$dom->normalize()を呼び出すことで、DomDocumentオブジェクトが正規化されます。その結果、隣接するテキストノードが結合され、"Hello, World!"という一つのテキストノードになります。

最後に、$dom->saveXML()を使って、正規化されたXMLドキュメントを文字列として取得し、画面に出力しています。出力されるXMLは、<root>Hello, World!</root>となります。

このようにnormalizeメソッドは、XMLドキュメントの構造を整理し、より効率的なデータ処理を可能にするために役立ちます。このメソッドは引数を取らず、戻り値もありません（void）。DomDocumentオブジェクト自体が変更されることに注意してください。

Copy
1<?php
2
3/**
4 * Dom\XMLDocument::normalize() メソッドの動作を示すサンプルコード。
5 *
6 * この関数は、XML ドキュメント内の隣接するテキストノードを結合し、
7 * 空のテキストノードを削除することで、ドキュメントを正規化します。
8 * これは、特にXMLデータが文字列として扱われる際に、DOM ツリーの構造を
9 * クリーンアップし、簡潔にするのに役立ちます。
10 */
11function demonstrateXmlNormalization(): void
12{
13    // 新しい Dom\XMLDocument オブジェクトを作成します。
14    // PHP 8 からは Dom\XMLDocument クラスが推奨されます。
15    $dom = new Dom\XMLDocument();
16    $dom->xmlVersion = '1.0';
17    $dom->encoding = 'UTF-8';
18    // 出力時にXMLを整形し、視覚的に分かりやすくします。
19    $dom->formatOutput = true;
20
21    // ルート要素を作成し、ドキュメントに追加します。
22    $root = $dom->createElement('root');
23    $dom->appendChild($root);
24
25    // 意図的に隣接する複数のテキストノードを作成し、ルート要素に追加します。
26    // これらはそれぞれ独立したテキストノードとして扱われます。
27    $root->appendChild($dom->createTextNode('これは '));
28    $root->appendChild($dom->createTextNode('複数の '));
29    $root->appendChild($dom->createTextNode('テキスト '));
30    $root->appendChild($dom->createTextNode('ノードの例です。'));
31    // 空のテキストノードを追加します。これは正規化によって削除されます。
32    $root->appendChild($dom->createTextNode(''));
33    $root->appendChild($dom->createTextNode('これら全てのテキストノードは結合されるでしょう。'));
34
35    echo "--- 正規化前のXMLドキュメント ---\n";
36    // 正規化前のXMLドキュメントを出力します。
37    // 通常、saveXML()では隣接するテキストノードが単一の文字列として表示されるため、
38    // 内部的なノード構造の違いは視覚的に分かりにくい場合がありますが、
39    // DOMツリー上ではまだ個別のノードとして存在しています。
40    echo $dom->saveXML() . "\n";
41
42    // ドキュメントを正規化します。
43    // このメソッドは、隣接するテキストノードを単一のテキストノードに結合し、
44    // 空のテキストノードを削除します。
45    $dom->normalize();
46
47    echo "--- 正規化後のXMLドキュメント ---\n";
48    // 正規化後のXMLドキュメントを出力します。
49    // 複数のテキストノードが結合され、空のテキストノードが削除されていることを確認できます。
50    echo $dom->saveXML() . "\n";
51}
52
53// サンプル関数を実行して、Dom\XMLDocument::normalize() の動作を確認します。
54demonstrateXmlNormalization();
55
56?>

PHP 8のDom\XMLDocument::normalize()メソッドは、XMLドキュメントの内部構造を整理し、より簡潔にするための重要な機能を提供します。このメソッドは引数を取らず、戻り値もありません（void）。その主な役割は二つあり、一つはドキュメント内の隣接する複数のテキストノードを単一のテキストノードに結合すること、もう一つは内容が空のテキストノードを削除することです。これにより、XMLデータがDOMツリーとして扱われる際に、ツリー構造がクリーンアップされ、整合性が高まります。

サンプルコードでは、意図的に複数のテキストノードと空のテキストノードを含むXMLドキュメントを作成し、正規化前後の変化を示しています。正規化前の状態では、たとえsaveXML()で出力された文字列が見た目上は結合されていても、DOMツリー内部ではこれらが個別のノードとして存在します。ここで$dom->normalize()メソッドを呼び出すと、内部的に隣接するテキストノードが結合され、空のテキストノードが削除されます。その結果、正規化後のsaveXML()出力では、より整理されたXML構造を確認でき、XMLデータの処理を安定させ、効率的に行うことが可能になります。