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

Copy
1<?php
2
3/**
4 * DOMノードの正規化を実演する関数です。
5 *
6 * 指定されたリファレンスの DOMEntity::normalize() は、DOMNode::normalize() を継承したメソッドです。
7 * このメソッドは、ノードとそのサブツリーを「正規化」します。
8 * 主な動作は、隣接するテキストノードを単一のテキストノードに結合し、
9 * 空のテキストノードを削除することです。
10 *
11 * このサンプルでは、より一般的な DOMElement を使用して normalize() の効果を示します。
12 */
13function demonstrateDomNodeNormalization(): void
14{
15    // 1. DOMDocument オブジェクトを作成
16    $dom = new DOMDocument('1.0', 'UTF-8');
17    // 出力されるXMLを見やすくフォーマットする
18    $dom->formatOutput = true;
19
20    // 2. 親要素と、正規化の対象となる子要素を作成
21    $parentElement = $dom->createElement('parent');
22    $targetElement = $dom->createElement('target');
23
24    // 3. 意図的に分割された、隣接するテキストノードを3つ作成
25    $textNode1 = $dom->createTextNode('断片化された');
26    $textNode2 = $dom->createTextNode('テキスト');
27    $textNode3 = $dom->createTextNode('です。');
28
29    // 4. 作成したノードをDOMツリーに追加
30    $targetElement->appendChild($textNode1);
31    $targetElement->appendChild($textNode2);
32    $targetElement->appendChild($textNode3);
33    $parentElement->appendChild($targetElement);
34    $dom->appendChild($parentElement);
35
36    // 5. normalize() を呼び出す前の状態を出力
37    // <target> 要素の子ノードは3つ (3つのテキストノード)
38    echo "--- Before normalize() ---\n";
39    echo "Number of child nodes in <target>: " . $targetElement->childNodes->length . "\n";
40    echo $dom->saveXML($targetElement);
41    echo "\n\n";
42
43    // 6. 対象要素に対して normalize() を実行
44    // これにより、隣接する3つのテキストノードが1つに結合される
45    $targetElement->normalize();
46
47    // 7. normalize() を呼び出した後の状態を出力
48    // <target> 要素の子ノードは1つ (結合された1つのテキストノード)
49    echo "--- After normalize() ---\n";
50    echo "Number of child nodes in <target>: " . $targetElement->childNodes->length . "\n";
51    echo $dom->saveXML($targetElement);
52    echo "\n";
53}
54
55// 関数を実行
56demonstrateDomNodeNormalization();

このPHPコードは、DOMEntity::normalize()メソッドの動作を実演するものです。このメソッドは、XMLやHTMLのドキュメント構造（DOMツリー）を整理、つまり「正規化」するために使用されます。DOMNodeクラスから継承された機能であり、主に隣り合って存在する複数のテキストノードを1つのテキストノードに結合したり、空のテキストノードを削除したりします。

サンプルコードでは、まず<target>という要素の中に「断片化された」「テキスト」「です。」という3つの別々のテキストノードを意図的に作成しています。normalize()を呼び出す前の<target>要素の子ノード数は3つです。次に、この<target>要素に対してnormalize()を実行すると、3つの隣接するテキストノードが1つに結合されます。その結果、子ノード数は1つになり、その内容は「断片化されたテキストです。」という1つのまとまったテキストに変わります。

このメソッドに引数はなく、呼び出したノード自体とその配下のノードの状態を直接変更するため、戻り値もありません。ドキュメントを解析・操作する過程で断片化したテキストを整理する際に役立ちます。

Copy
1<?php
2
3/**
4 * DOMNode::normalize の使用例を示すクラス
5 *
6 * このメソッドは、DOMツリー内のテキストノードを正規化します。
7 * 具体的には、隣接するテキストノードを1つにマージし、
8 * 空のテキストノードを削除します。
9 * DOMEntityクラスはDOMNodeクラスを継承しているため、このメソッドを利用できます。
10 */
11class DomNormalizeExample
12{
13    /**
14     * サンプルコードの実行
15     *
16     * @return void
17     */
18    public function run(): void
19    {
20        // DOMDocumentオブジェクトを作成
21        $dom = new DOMDocument('1.0', 'UTF-8');
22        // 整形して出力する設定
23        $dom->formatOutput = true;
24
25        // ルート要素 <greeting> を作成し、ドキュメントに追加
26        $root = $dom->createElement('greeting');
27        $dom->appendChild($root);
28
29        // 意図的に隣接する複数のテキストノードを作成して追加
30        // 通常、このような構造は動的なノード操作によって生まれることがあります。
31        $text1 = $dom->createTextNode('Hello, ');
32        $text2 = $dom->createTextNode('World');
33        $text3 = $dom->createTextNode('!');
34        $root->appendChild($text1);
35        $root->appendChild($text2);
36        $root->appendChild($text3);
37
38        // normalize() 実行前の状態を確認
39        // この時点では、<greeting>要素は3つのテキストノードを子として持っています。
40        echo "--- Before normalize() ---\n";
41        echo "Number of child nodes: " . $root->childNodes->length . "\n";
42        echo $dom->saveXML();
43        echo "\n";
44
45        // ドキュメント全体を正規化します。
46        // これにより、<greeting>要素内の隣接する3つのテキストノードが1つにマージされます。
47        $dom->normalizeDocument();
48
49        // normalize() 実行後の状態を確認
50        // 3つのテキストノードが1つに結合されたため、子ノードは1つになります。
51        echo "--- After normalize() ---\n";
52        echo "Number of child nodes: " . $root->childNodes->length . "\n";
53        echo $dom->saveXML();
54    }
55}
56
57// クラスのインスタンスを作成して実行
58(new DomNormalizeExample())->run();

このサンプルコードは、PHPのDOM拡張機能で使われるnormalizeメソッドの動作を説明するものです。DOMEntityクラスはDOMNodeクラスを継承しているため、このメソッドを使用できます。

このメソッドの主な役割は、XMLやHTMLの文書構造（DOMツリー）を整理し「正規化」することです。具体的には、隣接して存在する複数のテキストノードを1つのテキストノードに結合したり、中身が空のテキストノードを削除したりします。

サンプルコードでは、まず<greeting>という要素の中に、「Hello, 」「World」「!」という3つの別々のテキストノードを意図的に作成しています。メソッド実行前の時点では、<greeting>要素はこれら3つの子ノードを持っています。その後、文書全体を正規化するnormalizeDocument()を呼び出すと、3つに分かれていたテキストノードが「Hello, World!」という1つのテキストノードに結合されます。その結果、<greeting>要素が持つ子ノードの数は1つに変わります。

このnormalizeメソッドには引数はなく、戻り値もありません。メソッドを呼び出すと、対象となるノードの内部状態が直接変更されます。