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

Copy
1<?php
2
3/**
4 * DOMCdataSection::normalize メソッドの利用例と、DOMツリー正規化の効果を示します。
5 *
6 * DOMCdataSection::normalize はDOMNodeから継承されたメソッドです。
7 * CDATAセクション自体は子ノードを持たないため、このメソッドを直接呼び出しても、
8 * そのノードやDOMツリー構造に目に見える変化は生じません。
9 * ツリー内で隣接するテキストノード（CDATAセクションを含む）を結合する効果は、
10 * その親ノード（例: DOMElement）に対して normalize() を呼び出すことで確認できます。
11 */
12function demonstrateCdataNormalization(): void
13{
14    $dom = new DOMDocument('1.0', 'UTF-8');
15    $dom->formatOutput = true; // XML出力を整形
16
17    $root = $dom->createElement('root');
18    $dom->appendChild($root);
19
20    // 意図的に隣接するCDATAセクションとテキストノードを作成
21    // これらはDOMツリーの正規化によって結合される対象となります
22    $root->appendChild($dom->createCDATASection('最初のCDATA'));
23    $root->appendChild($dom->createTextNode(' と一部のテキスト。'));
24    $root->appendChild($dom->createCDATASection('2番目のCDATA'));
25    $root->appendChild($dom->createTextNode(' と残りのテキスト。'));
26
27    echo "--- 正規化前 ---\n";
28    echo $dom->saveXML() . "\n";
29
30    // DOMCdataSectionインスタンスに対して normalize() を呼び出す
31    // CDATAセクションは子ノードを持たないため、この呼び出しではツリー構造に変化はありません。
32    $cdataNode = $root->firstChild; // 最初のCDATAセクションノードを取得
33    if ($cdataNode instanceof DOMCdataSection) {
34        $cdataNode->normalize(); // DOMCdataSection::normalize の呼び出し
35    }
36
37    echo "--- DOMCdataSection::normalize 呼び出し後 (変化なし) ---\n";
38    echo $dom->saveXML() . "\n";
39
40    // DOMツリー全体を正規化するため、親ノード（root要素）に対して normalize() を呼び出す
41    // これにより、隣接するテキストノード（DOMTextとDOMCdataSection）が結合されます。
42    $root->normalize();
43
44    echo "--- 親ノードの normalize() 呼び出し後 (隣接ノードが結合) ---\n";
45    echo $dom->saveXML() . "\n";
46
47    // 正規化後のノード構造を確認
48    echo "\n--- 正規化後のノード内容 ---\n";
49    foreach ($root->childNodes as $node) {
50        if ($node instanceof DOMCdataSection) {
51            echo "CDATA Section: '" . $node->data . "'\n";
52        } elseif ($node instanceof DOMText) {
53            echo "Text Node: '" . $node->data . "'\n";
54        } else {
55            echo "Other Node: " . $node->nodeName . "\n";
56        }
57    }
58}
59
60// 関数を実行
61demonstrateCdataNormalization();
62

PHP 8のDOMCdataSection::normalizeメソッドは、DOM（Document Object Model）ツリーの構造を「正規化」するためのメソッドです。このメソッドは引数を取らず、特定の値を返しません。通常、normalizeメソッドは、DOMツリー内で隣接するテキストノード（DOMTextやDOMCdataSectionなど）を一つのノードに結合し、ツリー構造を簡潔にする役割があります。しかし、DOMCdataSection自体は内部に子ノードを持たない特殊なノードであるため、DOMCdataSectionのインスタンスに対して直接normalize()を呼び出しても、そのノードやDOMツリーに目に見える構造的な変化は生じません。

サンプルコードでは、意図的に隣接するCDATAセクションとテキストノードを作成し、正規化前後のXML構造の変化を示しています。DOMCdataSectionインスタンスにnormalize()を呼び出しても変化がないことを確認した後、それらのノードの親である要素ノード（DOMElement）に対してnormalize()メソッドを呼び出しています。この親ノードへの呼び出しによって、隣接するCDATAセクションとテキストノードが結合され、よりシンプルなDOMツリーが構築されることがわかります。この挙動を理解することで、DOM操作において予期せぬノードの結合や分割を防ぎ、意図した通りのXML構造を効率的に扱えるようになります。