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

Copy
1<?php
2
3// DOMDocumentオブジェクトを生成します。
4$doc = new \DOMDocument('1.0', 'UTF-8');
5// 出力されるXMLを見やすくするためにフォーマットを有効にします。
6$doc->formatOutput = true;
7
8// ルート要素 <data> を作成し、ドキュメントに追加します。
9$root = $doc->createElement('data');
10$doc->appendChild($root);
11
12// 隣接する2つのテキストノードと、1つのコメントノードを作成して追加します。
13// この時点では、これらは3つの独立した子ノードとして存在します。
14$textPart1 = $doc->createTextNode('隣接するテキストノード１。');
15$textPart2 = $doc->createTextNode('隣接するテキストノード２。');
16$comment = $doc->createComment(' このコメントは正規化の影響を受けません ');
17
18$root->appendChild($textPart1);
19$root->appendChild($textPart2);
20$root->appendChild($comment);
21
22// --- 正規化前の状態を出力 ---
23// 子ノードは Text, Text, Comment の3つです。
24echo "--- Before normalize() ---\n";
25echo "Child node count: " . $root->childNodes->length . "\n";
26echo $doc->saveXML($root);
27echo "\n\n";
28
29// --- ノードの正規化を実行 ---
30// Dom\Comment は Dom\Node クラスを継承しており、normalize() メソッドも継承しています。
31// このメソッドは、指定されたノードのサブツリー全体を「正規化」します。
32// 主な動作として、隣接するテキスト(Text)ノードを1つのノードにマージします。
33// ここでは、各ノードの親要素である $root に対して呼び出し、その効果を確認します。
34$root->normalize();
35
36// --- 正規化後の状態を出力 ---
37// 2つのテキストノードが1つに結合されたため、子ノードは Text, Comment の2つになります。
38echo "--- After normalize() ---\n";
39echo "Child node count: " . $root->childNodes->length . "\n";
40echo $doc->saveXML($root);
41echo "\n";
42
43?>

このPHPサンプルコードは、DOMドキュメントの構造を整理するnormalize()メソッドの動作を解説するものです。

まず、<data>という親要素を作成し、その中に2つの隣接するテキストノードと1つのコメントノードを追加します。このコードを実行した直後の状態では、親要素はテキスト、テキスト、コメントという3つの子ノードを持っています。

ここで使用するnormalize()メソッドは、DOMNodeクラスから継承された機能で、指定したノードとその全ての子孫ノードを対象に、隣り合って存在するテキストノードを1つに結合します。これにより、ドキュメントの構造が単純化されます。このメソッドは引数を取らず、戻り値もありません（void）。呼び出したノードオブジェクトの内部状態を直接変更する点が特徴です。

サンプルコードで親要素に対してnormalize()を実行すると、隣接していた2つのテキストノードが1つにマージされます。その結果、子ノードの数は3つから2つに減少します。このようにnormalize()は、プログラムによって動的に生成・変更されたDOMツリー内のテキスト断片を整理し、構造を最適化したい場合に役立ちます。