【PHP8.x】normalizeメソッドの使い方

Copy
1<?php
2
3/**
4 * DOMNode::normalize() の動作を確認するサンプル関数です。
5 *
6 * このメソッドは、DOMツリー内のノードを「正規化」します。
7 * 具体的には、隣接するテキストノードを1つに結合し、
8 * 空のテキストノードを削除します。これにより、DOM構造が整理されます。
9 */
10function demonstrateDomNodeNormalize(): void
11{
12    // 1. DOMDocumentオブジェクトを生成します。
13    $dom = new DOMDocument('1.0', 'UTF-8');
14    // 出力されるXMLを見やすくフォーマットします。
15    $dom->formatOutput = true;
16
17    // 2. <message>要素を作成し、意図的にテキストノードを複数に分割して追加します。
18    $messageElement = $dom->createElement('message');
19    $messageElement->appendChild($dom->createTextNode('Hello'));
20    $messageElement->appendChild($dom->createTextNode(', ')); // 2つ目のテキストノード
21    $messageElement->appendChild($dom->createTextNode('World!')); // 3つ目のテキストノード
22    $dom->appendChild($messageElement);
23
24    // 3. normalize() を呼び出す前の状態を確認します。
25    //    この時点では、3つのテキストノードが存在します。
26    echo "--- 正規化前 ---" . PHP_EOL;
27    echo "子ノードの数: " . $messageElement->childNodes->length . PHP_EOL;
28    echo $dom->saveXML();
29    echo PHP_EOL;
30
31    // 4. message要素に対して normalize() を実行します。
32    //    これにより、隣接する3つのテキストノードが1つに結合されます。
33    $messageElement->normalize();
34
35    // 5. normalize() を呼び出した後の状態を確認します。
36    //    テキストノードが1つにマージされていることがわかります。
37    echo "--- 正規化後 ---" . PHP_EOL;
38    echo "子ノードの数: " . $messageElement->childNodes->length . PHP_EOL;
39    echo $dom->saveXML();
40}
41
42// 関数を実行して結果を表示します。
43demonstrateDomNodeNormalize();

PHP 8のDOMNode::normalize()メソッドは、DOMツリー内のノードを整理（正規化）するために使用されます。このメソッドは引数を取らず、戻り値もありません。主な機能は二つあり、一つは隣接するテキストノードを一つのテキストノードに結合すること、もう一つは内容が空のテキストノードを削除することです。これにより、DOMツリーの構造が一貫した状態に保たれ、処理がしやすくなります。

サンプルコードでは、まずDOMDocumentオブジェクトを作成し、<message>要素に対して「Hello」、「, 」、「World!」という三つのテキストノードを意図的に追加しています。normalize()メソッドを呼び出す前は、これらのテキストノードが個別に存在しているため、<message>要素の子ノードの数は三つです。しかし、$messageElement->normalize();を実行すると、これらの隣接するテキストノードが一つに結合されます。その結果、normalize()呼び出し後には子ノードの数が一つに減り、XML出力を見てもテキストが連続した一つのノードとして表現されていることが確認できます。この正規化によって、DOM操作の安定性と予測可能性が向上します。

Copy
1<?php
2
3// DOMNode::normalize() は、ノードの正規化を行います。
4// 正規化とは、隣接するテキストノードを結合したり、空のテキストノードを削除したりする処理のことです。
5
6// 新しい DOMDocument オブジェクトを作成します。
7$dom = new DOMDocument();
8
9// ルート要素を作成します。
10$root = $dom->createElement("root");
11$dom->appendChild($root);
12
13// テキストノードを複数作成し、ルート要素に追加します。
14$text1 = $dom->createTextNode("Hello, ");
15$root->appendChild($text1);
16
17$text2 = $dom->createTextNode("World!");
18$root->appendChild($text2);
19
20// 正規化前の状態を出力します。
21echo "正規化前:\n";
22foreach ($root->childNodes as $node) {
23    echo $node->nodeValue . "\n";
24}
25
26// ルート要素を正規化します。
27$root->normalize();
28
29// 正規化後の状態を出力します。
30echo "\n正規化後:\n";
31foreach ($root->childNodes as $node) {
32    echo $node->nodeValue . "\n";
33}
34
35?>

このサンプルコードは、PHPのDOMNodeクラスのnormalize()メソッドの使い方を示しています。normalize()メソッドは、DOM（Document Object Model）ツリー内のノードを正規化するために使用されます。具体的には、隣接するテキストノードを結合したり、空のテキストノードを削除したりする処理を行います。

サンプルコードでは、まずDOMDocumentオブジェクトを作成し、ルート要素として<root>要素を追加しています。次に、"Hello, "と"World!"という2つのテキストノードをそれぞれ作成し、ルート要素の子ノードとして追加します。この時点では、ルート要素の子ノードは2つの別々のテキストノードとして存在します。

正規化前の状態で子ノードの値を順番に出力すると、"Hello, "と"World!"が別々に出力されます。その後、$root->normalize()を呼び出すことで、ルート要素の子ノードが正規化されます。この結果、隣接するテキストノードが結合され、一つのテキストノードになります。

正規化後の状態で再度子ノードの値を出力すると、"Hello, World!"という一つのテキストノードが出力されます。このように、normalize()メソッドを使用することで、DOMツリー内のテキストノードを効率的に管理できます。このメソッドは引数を取りませんが、ノードの状態を直接変更します。戻り値はありません。