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

Copy
1<?php
2
3// DOMDocumentを生成
4$dom = new DOMDocument();
5
6// XMLをロード
7$dom->loadXML('<root><child>&#xA0;test</child></root>');
8
9// root要素を取得
10$root = $dom->documentElement;
11
12// root要素の子要素を取得
13$child = $root->firstChild;
14
15// normalize() メソッドをコールする前にテキストノードの内容を出力
16echo "normalize() メソッド呼び出し前: " . $child->textContent . "\n";
17
18// normalize() メソッドをコール
19$root->normalize();
20
21// normalize() メソッドをコールした後にテキストノードの内容を出力
22echo "normalize() メソッド呼び出し後: " . $child->textContent . "\n";
23
24// DOMDocumentを保存
25echo $dom->saveXML();
26
27?>

このPHPのサンプルコードは、DOMDocumentクラスを用いてXMLドキュメントを操作し、Dom\Nodeクラスのnormalize()メソッドの効果を説明するものです。

まず、DOMDocumentクラスのインスタンスを作成し、loadXML()メソッドでXML文字列をロードします。この例では、ルート要素<root>の中に子要素<child>があり、そのテキストノードに （ノーブレークスペース）を含むXMLを読み込んでいます。

次に、documentElementプロパティでルート要素を取得し、firstChildプロパティでその子要素（この場合は<child>要素）を取得します。normalize()メソッドを呼び出す前に、textContentプロパティでテキストノードの内容を出力することで、ノーブレークスペースが含まれていることを確認します。

normalize()メソッドは、ノード（この場合はルート要素）の子ノードを正規化します。具体的には、隣接するテキストノードを結合し、空のテキストノードを削除します。このサンプルコードでは、ノーブレークスペースを含むテキストノードが正規化されることで、XMLドキュメントの構造が最適化されます。

normalize()メソッド呼び出し後、再度textContentプロパティでテキストノードの内容を出力し、saveXML()メソッドでXMLドキュメント全体を出力します。normalize()メソッドによってテキストノードがどのように変化したかを確認できます。normalize()メソッドは引数を取らず、戻り値もありません。ノード自体を直接変更します。

Copy
1<?php
2
3/**
4 * Dom\Node::normalize() メソッドのサンプルコード
5 *
6 * このメソッドは、DOMツリー内の隣接するTextノードを結合し、空のTextノードを削除することで、
7 * ツリーを「正規化」します。これにより、DOMツリーがより簡潔になり、操作が容易になります。
8 *
9 * Dom\Node::normalize() は PHP の DOM 拡張機能の一部であり、通常は特別なインストールなしで利用できます。
10 * (「php normalizer インストール」というキーワードは、多くの場合、PHP Intl 拡張の Normalizer クラスを指しますが、
11 *  ここでは Dom\Node クラスの normalize メソッドに焦点を当てています。)
12 */
13
14// DOMDocument オブジェクトを作成し、XML宣言と出力を整形する設定を行います。
15$dom = new DOMDocument('1.0', 'UTF-8');
16$dom->formatOutput = true;
17
18// ルート要素 'root' を作成し、DOMドキュメントに追加します。
19$root = $dom->createElement('root');
20$dom->appendChild($root);
21
22// テスト用の段落要素 'p' を作成し、ルート要素に追加します。
23$paragraph = $dom->createElement('p');
24$root->appendChild($paragraph);
25
26// 意図的に隣接する複数の Text ノードを作成して、normalize の効果を示します。
27// これら複数の Text ノードは、通常一つの論理的なテキストコンテンツを構成します。
28$paragraph->appendChild($dom->createTextNode('これは'));
29$paragraph->appendChild($dom->createTextNode(' ')); // スペースも別々のTextノードとして扱われる
30$paragraph->appendChild($dom->createTextNode('複数のTextノードで'));
31$paragraph->appendChild($dom->createTextNode('構成されています。'));
32
33echo "--- normalize() メソッド呼び出し前 ---\n";
34echo "段落内の Text ノード数: " . countTextNodes($paragraph) . "\n";
35echo "XML構造:\n" . $dom->saveXML($paragraph) . "\n";
36
37// Dom\Node::normalize() メソッドを呼び出します。
38// これにより、隣接する Text ノードが1つに結合されます。
39$paragraph->normalize();
40
41echo "\n--- normalize() メソッド呼び出し後 ---\n";
42echo "段落内の Text ノード数: " . countTextNodes($paragraph) . "\n";
43echo "XML構造:\n" . $dom->saveXML($paragraph) . "\n";
44
45/**
46 * 指定された DOMNode の直下にある Text ノードの数を数えるヘルパー関数。
47 *
48 * @param DOMNode $node Textノードの数を数える対象のノード
49 * @return int 直下の子 Text ノードの数
50 */
51function countTextNodes(DOMNode $node): int
52{
53    $count = 0;
54    foreach ($node->childNodes as $child) {
55        if ($child->nodeType === XML_TEXT_NODE) {
56            $count++;
57        }
58    }
59    return $count;
60}

Dom\Node::normalize()メソッドは、PHPのDOM（Document Object Model）拡張機能の一部として、XMLやHTMLなどのDOMツリー内のテキストデータを整理する役割を担います。このメソッドは、隣接する複数のテキストノード（TextNode）を一つのテキストノードに結合し、内容が空のテキストノードを削除することで、DOMツリーの構造を「正規化」します。これにより、DOMツリーがより簡潔になり、プログラムからの操作が容易になります。

このメソッドは引数を必要とせず、呼び出し元のノードとその子孫の構造を直接変更します。処理が完了しても特に値を返さないため、戻り値はvoidです。

サンプルコードでは、まず複数の隣接するTextノードを持つ段落要素を意図的に作成しています。normalize()メソッドを呼び出す前には、これらのテキストが別々のノードとして存在していることが確認できます。メソッドを呼び出した後は、隣接するTextノードが一つに結合され、結果としてTextノードの数が減少している様子がXML構造とともに出力されます。

「php normalizer インストール」というキーワードは、しばしばPHPの国際化機能を提供するIntl拡張のNormalizerクラスを指すことがあります。しかし、ここで説明しているDom\Node::normalize()はDOM拡張機能の一部であり、通常PHPに標準で含まれているため、特別なインストールなしで利用可能です。

Copy
1<?php
2
3// DOMDocumentのインスタンスを作成します。
4// これはHTMLやXML文書を扱うための基本的なクラスです。
5$dom = new DOMDocument('1.0', 'UTF-8');
6$dom->formatOutput = true; // 出力を見やすく整形する設定
7
8// ルートとなる要素（例: <div>）を作成し、DOM文書に追加します。
9$root = $dom->createElement('div');
10$dom->appendChild($root);
11
12// 意図的に隣接する複数のテキストノードや空のテキストノードを追加します。
13// このような状態は、HTMLのパース結果や手動でのDOM操作で発生する可能性があります。
14$root->appendChild($dom->createTextNode('これは'));
15$root->appendChild($dom->createTextNode('結合される'));
16$root->appendChild($dom->createTextNode('テキストです。'));
17
18$root->appendChild($dom->createTextNode('')); // 内容が空のテキストノード
19
20$root->appendChild($dom->createTextNode('そして、'));
21$root->appendChild($dom->createTextNode('別のテキスト。'));
22
23echo "--- 正規化前のDOM構造 ---\n";
24// normalize()メソッド呼び出し前のDOM構造を表示します。
25// 隣接するテキストノードが個別のノードとして存在していることが確認できます。
26echo $dom->saveHTML($root);
27echo "\n\n";
28
29// Dom\Node::normalize() メソッドを呼び出します。
30// このメソッドは、親ノードの子孫であるテキストノードを正規化します。
31// 主な効果は以下の2点です。
32// 1. 隣接するテキストノードを結合し、単一のテキストノードにします。
33//    (例: "これは", "結合される", "テキストです。" が "これは結合されるテキストです。" と一つに結合されます)
34// 2. 内容が空のテキストノードをDOMツリーから削除します。
35$root->normalize();
36
37echo "--- 正規化後のDOM構造 ---\n";
38// normalize()メソッド呼び出し後のDOM構造を表示します。
39// テキストノードが結合され、空のノードが削除された状態が確認できます。
40echo $dom->saveHTML($root);
41echo "\n";
42
43?>

Dom\Node::normalize()メソッドは、PHPでHTMLやXMLなどのDOM（Document Object Model）を扱う際に、DOMツリー内のテキストノードを整理・最適化するための機能です。このメソッドは引数を持たず、戻り値もありません（void）。対象のノード自身ではなく、その子孫ノードにあるテキストノードの状態を正規化します。

サンプルコードでは、DOMDocumentを使用してHTMLのような構造を作成し、あえて「これは」「結合される」「テキストです。」といったように、隣接する複数のテキストノードや、内容が空のテキストノードを追加しています。正規化前の出力では、これらのテキストがそれぞれ独立したノードとして存在していることが確認できます。

$root->normalize();を呼び出すことで、DOMツリーに対して二つの主な変更が加えられます。一つ目は、隣接する複数のテキストノードが「これは結合されるテキストです。」のように単一のテキストノードに結合されることです。二つ目は、内容が空のテキストノードがDOMツリーから削除されることです。

正規化後の出力を見ると、テキストノードが結合され、空のノードがなくなったことで、DOM構造がより簡潔で扱いやすい状態になっていることがわかります。このメソッドは、特にHTMLやXMLをパースした結果を整頓したり、DOMをプログラムで操作した後に構造を最適化する際に非常に役立ちます。