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

Copy
1<?php
2
3// PHP 8で推奨される新しいDOM拡張のクラスを使用します。
4// これらは従来の DOMDocument, DOMText と同等の機能を提供しますが、
5// より一貫性のある名前空間とオブジェクト指向の設計を持っています。
6use Dom\Document;
7use Dom\Text;
8
9/**
10 * Dom\CharacterData::normalize() メソッドの動作を示すサンプルコードです。
11 *
12 * Dom\CharacterData は抽象クラスであり、Dom\Text クラスなどがこれを継承します。
13 * normalize() メソッドは Dom\Node クラスから継承されており、
14 * 隣接するテキストノードを結合し、空のテキストノードを削除することで、
15 * DOMツリー構造を「正規化」します。
16 *
17 * このサンプルでは、複数の隣接するテキストノードと空のテキストノードを含む
18 * 簡単なDOMツリーを作成し、normalize() メソッド適用前後の変化を示します。
19 */
20function demonstrateDomCharacterDataNormalize(): void
21{
22    // 新しい Dom\Document オブジェクトを作成します。
23    $document = new Document();
24    // HTMLとして整形された出力を得るために、フォーマットを有効にします。
25    $document->formatOutput = true;
26
27    // ルート要素 'root' を作成し、ドキュメントに追加します。
28    $rootElement = $document->createElement('root');
29    $document->appendChild($rootElement);
30
31    // 複数のテキストノードを作成し、ルート要素に追加します。
32    // Dom\Text は Dom\CharacterData を継承する具体的なクラスです。
33    $textNode1 = $document->createTextNode('Hello');
34    $textNode2 = $document->createTextNode(' '); // スペースもテキストノードです
35    $textNode3 = $document->createTextNode('World');
36    $textNode4 = $document->createTextNode(''); // 空のテキストノード
37    $textNode5 = $document->createTextNode('!');
38
39    $rootElement->appendChild($textNode1);
40    $rootElement->appendChild($textNode2);
41    $rootElement->appendChild($textNode3);
42    $rootElement->appendChild($textNode4); // 空のノードも追加
43    $rootElement->appendChild($textNode5);
44
45    echo "--- 正規化前のノード構造 ---\n";
46    // ルート要素の子ノードを列挙して、それぞれの種類と値を確認します。
47    echo "子ノード数: " . $rootElement->childNodes->length . "\n";
48    foreach ($rootElement->childNodes as $index => $child) {
49        // Dom\Text ノードの場合、その値（テキスト内容）を表示します。
50        if ($child instanceof Text) {
51            echo "  [" . $index . "] Text Node (Value: '" . $child->nodeValue . "')\n";
52        } else {
53            // その他のノードタイプの場合、ノード名を表示します。
54            echo "  [" . $index . "] Node Name: " . $child->nodeName . "\n";
55        }
56    }
57    echo "\n";
58
59    // Dom\Text クラスのインスタンス ($textNode1) に対して normalize() を呼び出します。
60    // このメソッドは、DOM仕様に従い、呼び出されたノードの親ノード ($rootElement) 内の
61    // 隣接するテキストノードを結合し、空のテキストノードを削除する効果があります。
62    echo "Dom\\Text::normalize() を実行中...\n\n";
63    $textNode1->normalize();
64    // 注意: どの Dom\Text ノードに対して normalize() を呼び出しても、
65    // そのノードの親要素配下のテキストノード群に影響を与えます。
66
67    echo "--- 正規化後のノード構造 ---\n";
68    // 正規化後のルート要素の子ノードを再度列挙して変化を確認します。
69    // 複数のテキストノードが結合され、空のテキストノードが削除されているはずです。
70    echo "子ノード数: " . $rootElement->childNodes->length . "\n";
71    foreach ($rootElement->childNodes as $index => $child) {
72        if ($child instanceof Text) {
73            echo "  [" . $index . "] Text Node (Value: '" . $child->nodeValue . "')\n";
74        } else {
75            echo "  [" . $index . "] Node Name: " . $child->nodeName . "\n";
76        }
77    }
78    echo "\n";
79
80    echo "--- 正規化後のDOMツリーのHTML出力 ---\n";
81    // 整形されたHTML形式で出力し、視覚的に変更を確認します。
82    // 全ての隣接するテキストが1つのテキストノードに結合されていることがわかります。
83    echo $document->saveHTML($rootElement) . "\n";
84}
85
86// サンプル関数を実行します。
87demonstrateDomCharacterDataNormalize();

Dom\CharacterData::normalize()メソッドは、PHP 8で提供されるDOM（Document Object Model）操作のための重要な機能です。このメソッドは引数を受け取らず、戻り値もありません（void）。その役割は、DOMツリー内のテキストノードを「正規化」することです。具体的には、隣接する複数のテキストノードを一つのテキストノードに結合し、内容が空のテキストノードを削除します。これにより、DOMツリーの構造が整理され、より簡潔で扱いやすくなります。例えば、「Hello」「 」「World」という別々のテキストノードがあった場合、これらを「Hello World」という一つのテキストノードにまとめます。また、空のテキストノードが存在すれば、それは自動的に削除されます。このサンプルコードでは、意図的に複数の隣接するテキストノードと空のテキストノードを持つDOMツリーを作成しています。normalize()メソッドを適用する前と後で、子ノードの数やテキスト内容がどのように変化するかを示すことで、正規化の動作を具体的に確認できます。HTMLやXMLのようなドキュメント構造をプログラムで扱う際に、ツリー構造をクリーンアップし、効率的な処理を行うために非常に役立つメソッドです。