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

Copy
1<?php
2
3// DOMDocument クラスを使用してXMLドキュメントを操作します。
4// DOM（Document Object Model）は、XMLやHTMLドキュメントをプログラムで操作するためのAPIです。
5
6// DOMDocument の新しいインスタンスを作成します。
7// '1.0' はXMLのバージョン、'UTF-8' はエンコーディングを指定します。
8$dom = new DOMDocument('1.0', 'UTF-8');
9
10// XML出力時に整形（インデントなどを追加）するように設定します。
11$dom->formatOutput = true;
12
13// ルート要素（例: <root>）を作成し、ドキュメントの最上位に追加します。
14$root = $dom->createElement('root');
15$dom->appendChild($root);
16
17// `data`要素を作成し、ルート要素の子として追加します。
18$dataElement = $dom->createElement('data');
19$root->appendChild($dataElement);
20
21// ここで、意図的に複数のテキストノードを連続して追加します。
22// DOMをプログラムで構築する際、このようにテキストノードが複数に分かれることがあります。
23$dataElement->appendChild($dom->createTextNode('これは'));
24$dataElement->appendChild($dom->createTextNode('連続する'));
25$dataElement->appendChild($dom->createTextNode('テキストです。'));
26
27// さらに、空のテキストノードを追加します。
28// `normalizeDocument` メソッドは、このような空のテキストノードも削除します。
29$dataElement->appendChild($dom->createTextNode(''));
30
31// --- normalizeDocument メソッド実行前のDOMの状態 ---
32echo "--- normalizeDocument 実行前の状態 ---\n";
33// `data`要素直下のテキストノードの数を確認します。
34echo "data要素の子ノード数: " . $dataElement->childNodes->length . "個\n";
35echo "各子ノードの情報:\n";
36foreach ($dataElement->childNodes as $index => $node) {
37    if ($node->nodeType === XML_TEXT_NODE) {
38        // テキストノードの場合、その値を表示します。
39        echo "  - テキストノード[" . $index . "]: '" . $node->nodeValue . "'\n";
40    } else {
41        // その他のノードタイプ
42        echo "  - ノード[" . $index . "]: " . $node->nodeName . " (タイプ: " . $node->nodeType . ")\n";
43    }
44}
45echo "XML出力例:\n";
46echo $dom->saveXML();
47echo "\n";
48
49// DOMツリーを正規化します。
50// `normalizeDocument` メソッドは、DOMツリー内部の連続するテキストノードを結合し、
51// 空のテキストノードを削除するなどの処理を行います。
52// これにより、DOMツリーの構造が簡潔になり、処理が効率的になることがあります。
53$dom->normalizeDocument();
54
55// --- normalizeDocument メソッド実行後のDOMの状態 ---
56echo "--- normalizeDocument 実行後の状態 ---\n";
57echo "data要素の子ノード数: " . $dataElement->childNodes->length . "個\n";
58echo "各子ノードの情報:\n";
59foreach ($dataElement->childNodes as $index => $node) {
60    if ($node->nodeType === XML_TEXT_NODE) {
61        echo "  - テキストノード[" . $index . "]: '" . $node->nodeValue . "'\n";
62    } else {
63        echo "  - ノード[" . $index . "]: " . $node->nodeName . " (タイプ: " . $node->nodeType . ")\n";
64    }
65}
66echo "正規化後のXML出力例:\n";
67echo $dom->saveXML();
68
69?>

PHPのDOMDocument::normalizeDocumentメソッドは、XMLやHTMLドキュメントの内部構造であるDOMツリーを整理し、簡潔にするために使用されます。DOMツリーをプログラムで構築する際、連続するテキストが複数のテキストノードに分かれてしまったり、内容が空のテキストノードが意図せず生成されたりすることがあります。このメソッドは、これらを自動的に結合・削除することで、ツリーの整合性を高め、処理を効率化するのに役立ちます。

サンプルコードでは、まずDOMDocumentオブジェクトを作成し、<root>要素の子として<data>要素を追加しています。そして、この<data>要素に対し、「これは」「連続する」「テキストです。」という三つのテキストノードと、さらに一つの空のテキストノードを意図的に追加しています。normalizeDocumentを実行する前は、これらがそれぞれ別の子ノードとして存在していることが確認できます。

しかし、$dom->normalizeDocument();を実行すると、連続していたテキストノードは「これは連続するテキストです。」という一つのテキストノードに結合され、空のテキストノードは削除されます。これにより、<data>要素の子ノードの数が減り、より整理されたXML構造になります。

このメソッドに引数は必要ありません。また、特定の値を返すことはなく、呼び出したDOMDocumentオブジェクトの内部状態を直接変更します。ドキュメントの操作中にDOMツリーが複雑になってしまった場合に、手軽に構造を標準化したい際に利用すると良いでしょう。

Copy
1<?php
2
3/**
4 * DOMDocument::normalizeDocument メソッドの使用例を示します。
5 *
6 * このメソッドは、DOMツリー内の連続するテキストノードを結合し、
7 * 空のテキストノードを削除することで、ツリー構造を正規化します。
8 * これは、DOMツリーの操作を効率化し、一貫性を保つために役立ちます。
9 */
10function demonstrateDomNormalization(): void
11{
12    // 1. DOMDocument オブジェクトを初期化
13    $dom = new DOMDocument('1.0', 'UTF-8');
14    // 出力XMLを読みやすく整形するために設定
15    $dom->formatOutput = true;
16    // XMLパーサーが空白文字のみのテキストノードも保持するように設定します。
17    // これにより、normalizeDocument メソッドの効果がより明確に視覚化されます。
18    $dom->preserveWhiteSpace = true;
19
20    // 2. 正規化が必要な状態のXML文字列をロード
21    // わざと連続するテキストや不要な空白テキストノードを含ませています。
22    $xmlString = <<<XML
23<root>
24    <!-- ルート要素の直下にある改行やスペースはテキストノードとして扱われます -->
25    Hello
26    World!
27    <!-- 空のテキストノードや空白のみのテキストノードも存在します -->
28
29    <item>
30        Item Part 1
31        Item Part 2
32    </item>
33    Final
34    Text.
35</root>
36XML;
37    $dom->loadXML($xmlString);
38
39    echo "--- 正規化前のDOMツリー ---\n";
40    // preserveWhiteSpace が true のため、改行やインデントの空白も
41    // テキストノードとしてXML出力に含まれています。
42    echo $dom->saveXML();
43    echo "\n";
44
45    // 3. DOMツリーを正規化
46    // - 連続するテキストノード (例: 'Hello' と 'World!' の間の改行やスペース) が結合されます。
47    // - 空のテキストノード (例: '<!-- 空のテキストノードや空白のみのテキストノードも存在します -->' の後の改行) が削除されます。
48    $dom->normalizeDocument();
49
50    echo "--- 正規化後のDOMツリー ---\n";
51    // 正規化後、不要な空白テキストノードが削除され、
52    // 連続するテキストノードが結合されていることがXML出力で確認できます。
53    echo $dom->saveXML();
54    echo "\n";
55}
56
57// デモンストレーション関数を実行
58demonstrateDomNormalization();

PHPのDOMDocument::normalizeDocumentメソッドは、XMLやHTMLのDOMツリー構造を効率的で一貫性のある状態に「正規化」するために使用されます。正規化とは、DOMツリー内の連続するテキストノードを一つにまとめ、内容が空のテキストノード（または空白文字のみのテキストノード）を削除する処理を指します。これにより、DOMツリーを扱う際の複雑さを軽減し、後続のDOM操作をより安定して行えるようになります。

このメソッドは引数を取りません。そのため、呼び出すだけで現在のDOMDocumentオブジェクトの内部状態が直接変更されます。また、戻り値もありませんので、メソッドの実行結果は、呼び出し元のDOMDocumentオブジェクト自体を介して確認することになります。

サンプルコードでは、意図的に複数のテキストノードが連続していたり、不要な空白文字のみのテキストノードが含まれるXML文字列をロードしています。normalizeDocumentメソッドを実行する前のXML出力と、実行後のXML出力を比較することで、連続するテキストが結合され、空のテキストノードが取り除かれている様子が明確にわかります。特に、preserveWhiteSpaceプロパティをtrueに設定しているため、通常は無視されがちな改行やインデントの空白もテキストノードとして保持され、正規化の効果がより視覚的に確認できるようになっています。このメソッドは、XMLの構文解析後にデータのクリーンアップや加工を行う際によく利用されます。