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

Copy
1<?php
2
3// DOMCharacterData::normalize() のサンプルコード
4
5// ドキュメントを作成
6$dom = new DOMDocument();
7
8// テキストノードを作成
9$text1 = $dom->createTextNode("Hello, ");
10$text2 = $dom->createTextNode("World!");
11
12// 親ノードを作成し、テキストノードを追加
13$parent = $dom->createElement("div");
14$parent->appendChild($text1);
15$parent->appendChild($text2);
16
17// ドキュメントに親ノードを追加
18$dom->appendChild($parent);
19
20// normalize() メソッドを呼び出す前に、テキストノードが分かれていることを確認
21echo "Before normalize(): " . $parent->childNodes->length . " nodes\n"; // 出力: 2 nodes
22
23// normalize() メソッドを呼び出し、隣接するテキストノードを結合する
24$parent->normalize();
25
26// normalize() メソッドを呼び出した後に、テキストノードが結合されていることを確認
27echo "After normalize(): " . $parent->childNodes->length . " nodes\n"; // 出力: 1 nodes
28
29// 結果を表示
30echo "Result: " . $parent->textContent . "\n"; // 出力: Result: Hello, World!
31
32?>

このサンプルコードは、PHPのDOM拡張に含まれる DOMCharacterData クラスの normalize() メソッドの使い方を示しています。normalize() メソッドは、ノードの子ノードを正規化する役割を持ちます。具体的には、隣接するテキストノードを結合して、単一のテキストノードにまとめます。

サンプルコードでは、まず DOMDocument オブジェクトを作成し、2つのテキストノード（"Hello, " と "World!"）を生成しています。次に、これらのテキストノードを div 要素の子ノードとして追加しています。normalize() メソッドを呼び出す前には、div 要素は2つの子ノード（それぞれのテキストノード）を持っていることを確認できます。

$parent->normalize() を実行すると、div 要素の子ノードが正規化され、隣接するテキストノードが結合されます。その結果、div 要素の子ノードの数は1になります。これは、"Hello, " と "World!" が結合されて、単一の "Hello, World!" というテキストノードになったためです。

最後に、textContent プロパティを使って、結合されたテキストノードの内容を表示しています。この例を通して、normalize() メソッドが隣接するテキストノードを結合し、DOMツリーを整理するのに役立つことがわかります。引数はなく、戻り値もありません。

Copy
1<?php
2
3/**
4 * DOMCharacterData::normalize() メソッドの動作を示すサンプル関数。
5 *
6 * PHPのDOM拡張は通常PHPに標準で含まれており、XMLやHTMLドキュメントの操作を可能にします。
7 * DOMCharacterData::normalize() メソッドは、隣接するDOMTextノードを結合して正規化します。
8 * このメソッドは、実質的に親ノードの DOMNode::normalize() を呼び出すことで、
9 * その子である隣接するテキストノードを1つのテキストノードに結合します。
10 * 環境によっては 'php-xml' などのOSパッケージのインストールが必要な場合があります。
11 */
12function demonstrateDomCharacterDataNormalize(): void
13{
14    // 1. DOMDocument の作成と設定
15    $dom = new DOMDocument('1.0', 'UTF-8');
16    $dom->formatOutput = true; // 出力を整形
17
18    // 2. ルート要素 'root' を作成し、DOMに追加
19    $root = $dom->createElement('root');
20    $dom->appendChild($root);
21
22    // 3. 複数の隣接するテキストノードを持つ要素 'p' を作成し、追加
23    $paragraph = $dom->createElement('p');
24    $root->appendChild($paragraph);
25
26    // 意図的に複数のDOMTextノードに分割して追加
27    $textNode1 = $dom->createTextNode('Hello');
28    $textNode2 = $dom->createTextNode(' World');
29    $textNode3 = $dom->createTextNode(' from PHP DOM.');
30
31    $paragraph->appendChild($textNode1);
32    $paragraph->appendChild($textNode2);
33    $paragraph->appendChild($textNode3);
34
35    echo "--- 正規化前のDOMツリー ---\n";
36    echo $dom->saveXML();
37    echo "親要素 'p' の子ノード数 (正規化前): " . $paragraph->childNodes->length . "\n\n";
38
39    // 4. いずれかのDOMTextノードに対して normalize() を呼び出す
40    // この呼び出しは、実質的に親ノード ($paragraph) の DOMNode::normalize() をトリガーし、
41    // 親ノード内の隣接するテキストノードが結合されます。
42    $textNode1->normalize();
43
44    echo "--- 正規化後のDOMツリー ---\n";
45    echo $dom->saveXML();
46    echo "親要素 'p' の子ノード数 (正規化後): " . $paragraph->childNodes->length . "\n\n";
47
48    echo "結果: 3つの隣接するテキストノードが1つのテキストノードに結合されました。\n";
49}
50
51// 関数の実行
52demonstrateDomCharacterDataNormalize();

PHP 8のDOMCharacterData::normalize()メソッドは、XMLやHTMLドキュメントを操作するためのDOM拡張に属する機能です。このメソッドは、隣接する複数のテキストノードを1つのテキストノードに結合し、DOMツリーを「正規化」することを目的としています。

このメソッドには引数がなく、戻り値もありません。DOMCharacterData::normalize()を呼び出すと、自身が属する親ノードに対して実質的にDOMNode::normalize()メソッドをトリガーします。その結果、親ノードの子である隣接するテキストノードがすべて結合され、単一のテキストノードとして整理されます。これにより、DOMツリーが簡潔になり、テキストデータの操作や検索がしやすくなります。

例えば、サンプルコードのように「Hello」「 World」「 from PHP DOM.」といった複数のテキストノードが意図的に隣接して追加された場合でも、normalize()の実行後にはこれらが「Hello World from PHP DOM.」という1つのテキストノードに統合されます。

PHPのDOM拡張は通常標準で含まれていますが、環境によってはphp-xmlのようなOSパッケージを追加でインストールする必要がある場合がありますのでご注意ください。この正規化処理は、DOMツリーの整合性を保ち、効率的なデータ処理を行う上で役立つ機能です。

Copy
1<?php
2
3/**
4 * PHP DOMCharacterData::normalize() メソッドのサンプルコード。
5 *
6 * このメソッドはDOMツリー内の隣接するTextノードを結合し、
7 * 空のTextノードを削除してツリーを「正規化」します。
8 * これは一般的な文字列のUnicode正規化とは異なる点に注意してください。
9 * DOMNode::normalize() と同じ動作をします。
10 */
11
12// DOMDocumentを作成し、XML宣言とルート要素を追加します。
13$dom = new DOMDocument('1.0', 'UTF-8');
14$root = $dom->createElement('root');
15$dom->appendChild($root);
16
17// 意図的に隣接する複数のTextノードを追加します。
18// これらはDOMツリー上では別々のノードとして扱われます。
19$root->appendChild($dom->createTextNode('Hello'));
20$root->appendChild($dom->createTextNode(' World'));
21$root->appendChild($dom->createTextNode(' from '));
22$root->appendChild($dom->createTextNode('PHP DOM!'));
23
24// 空のTextノードも追加します。これも正規化で削除されます。
25$root->appendChild($dom->createTextNode(''));
26
27echo "--- normalize() 呼び出し前 ---\n";
28echo "ルート要素の子ノード数: " . $root->childNodes->length . "\n";
29$nodeIndex = 0;
30foreach ($root->childNodes as $node) {
31    echo "  [" . ($nodeIndex++) . "] タイプ: " . $node->nodeName . ", 内容: '" . $node->nodeValue . "'\n";
32}
33echo "\n";
34
35// DOMCharacterData::normalize() を呼び出します。
36// 親要素に対して呼び出すことで、その子孫Textノードが処理されます。
37$root->normalize();
38
39echo "--- normalize() 呼び出し後 ---\n";
40echo "ルート要素の子ノード数: " . $root->childNodes->length . "\n";
41$nodeIndex = 0;
42foreach ($root->childNodes as $node) {
43    echo "  [" . ($nodeIndex++) . "] タイプ: " . $node->nodeName . ", 内容: '" . $node->nodeValue . "'\n";
44}
45echo "\n";
46
47// 最終的なDOMツリーのXML表現を表示します。
48echo "--- 最終的なDOMツリー (XML表現) ---\n";
49echo $dom->saveXML();
50

PHPのDOMCharacterData::normalize()メソッドは、XMLやHTMLのDOMツリー構造を整理するための機能を提供します。このメソッドは引数を受け取らず、戻り値もありませんが、呼び出すことでDOMツリー内のテキストノードの状態を「正規化」します。具体的には、隣接する複数のテキストノードがある場合、それらを一つに結合し、内容が空のテキストノードを削除します。これにより、ツリー構造がよりシンプルで一貫した状態になります。

ただし、この「正規化」は、一般的な文字列のUnicode正規化（文字表現の標準化）とは異なる点にご留意ください。あくまでDOMツリー内のノードの配置や数を最適化することが目的です。

サンプルコードでは、最初に「Hello」「 World」「 from 」「PHP DOM!」という隣接する複数のテキストノードと、一つの空のテキストノードを持つDOMツリーを作成しています。normalize()メソッドの呼び出し前には、これらのノードがそれぞれ個別に存在していることが確認できます。しかし、メソッドを呼び出した後には、すべての隣接テキストノードが「Hello World from PHP DOM!」という単一のテキストノードに結合され、空のノードも削除されていることが出力からわかります。このように、normalize()はDOMツリーを効率的に管理するために役立ちます。