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

Copy
1<?php
2
3/**
4 * Dom\Document::normalize() メソッドの動作を示すサンプルコードです。
5 *
6 * このメソッドは、DOMツリーを「正規化」します。
7 * 具体的には、以下の処理を行います。
8 * 1. 空のテキストノードを削除します。
9 * 2. 連続するテキストノード（同じ親を持つ兄弟ノードで、間に要素ノードなどがない場合）を1つのテキストノードに結合します。
10 * これにより、DOMツリーがより簡潔な形になり、処理がしやすくなります。
11 */
12function demonstrateDomDocumentNormalize(): void
13{
14    // 1. Dom\Document インスタンスを作成します。
15    // HTMLやXMLを扱うための基盤となるオブジェクトです。
16    $dom = new \Dom\Document();
17
18    // 出力されるXMLを見やすくするために、formatOutputをtrueに設定します。
19    // これはnormalize()の動作には直接関係ありませんが、結果の可読性を高めます。
20    $dom->formatOutput = true;
21
22    // 2. 意図的に複数のテキストノードが連続するようにDOM要素を構築します。
23    // まず、ルートとなる要素 'example' を作成し、ドキュメントに追加します。
24    $root = $dom->createElement('example');
25    $dom->appendChild($root);
26
27    // 複数のテキストノードを連続して追加します。
28    // これらは後でnormalize()によって結合されることを期待します。
29    $root->appendChild($dom->createTextNode('これは'));
30    $root->appendChild($dom->createTextNode('結合される'));
31    $root->appendChild($dom->createTextNode('テキストです。'));
32
33    // さらに、空のテキストノードも追加してみます。
34    // これはnormalize()によって削除されるはずです。
35    $root->appendChild($dom->createTextNode(''));
36
37    // 別の要素を間に挟むことで、連続しないテキストノードの例も示します。
38    // このテキストは、間に<span>要素があるため、前後のテキストとは結合されません。
39    $span = $dom->createElement('span');
40    $span->textContent = ' この部分は独立しています。 ';
41    $root->appendChild($span);
42
43    // 再び連続するテキストノードを追加します。
44    $root->appendChild($dom->createTextNode(' そして、'));
45    $root->appendChild($dom->createTextNode('さらに結合されるテキストです。'));
46
47    // --- 正規化前のDOM構造を確認 ---
48    echo "--- 正規化前のDOM構造 ---\n";
49    // ルート要素内のテキストノードの数をカウントし、比較のために表示します。
50    $textNodeCountBefore = 0;
51    foreach ($root->childNodes as $node) {
52        if ($node->nodeType === XML_TEXT_NODE) {
53            $textNodeCountBefore++;
54        }
55    }
56    echo "  'example' 要素内のテキストノード数: " . $textNodeCountBefore . "\n";
57    // 現在のDOMツリーをXML形式で出力し、目で確認できるようにします。
58    echo $dom->saveXML() . "\n\n";
59
60    // 3. Dom\Document::normalize() メソッドを呼び出します。
61    // これにより、DOMツリーが正規化されます。
62    // このメソッドは戻り値がない (void) ため、変数に代入する必要はありません。
63    $dom->normalize();
64
65    // --- 正規化後のDOM構造を確認 ---
66    echo "--- 正規化後のDOM構造 ---\n";
67    // 正規化後のテキストノードの数を再度カウントし、変化を確認します。
68    $textNodeCountAfter = 0;
69    foreach ($root->childNodes as $node) {
70        if ($node->nodeType === XML_TEXT_NODE) {
71            $textNodeCountAfter++;
72        }
73    }
74    echo "  'example' 要素内のテキストノード数: " . $textNodeCountAfter . "\n";
75    // 正規化後のDOMツリーをXML形式で出力します。
76    echo $dom->saveXML() . "\n";
77
78    echo "\n// --- 解説 --- \n";
79    echo "// 正規化前は複数の短いテキストノードや空のテキストノードが存在していましたが、\n";
80    echo "// normalize() の呼び出しにより、それらが簡潔な形に整理されました。\n";
81    echo "// 具体的には：\n";
82    echo "// 1. 'これは', '結合される', 'テキストです。' という3つの連続したテキストノードは、\n";
83    echo "//    'これは結合されるテキストです。' という1つのテキストノードに結合されました。\n";
84    echo "// 2. 空のテキストノード ('') は削除されました。\n";
85    echo "// 3. ' そして、', 'さらに結合されるテキストです。' という2つの連続したテキストノードも、\n";
86    echo "//    ' そして、さらに結合されるテキストです。' という1つのテキストノードに結合されました。\n";
87    echo "// 4. <span>要素に挟まれたテキストは、その前後とは結合されず、独立したままです。\n";
88    echo "// 結果として、'example' 要素内のテキストノードの総数が " . $textNodeCountBefore . " から " . $textNodeCountAfter . " に減少していることがわかります。\n";
89    echo "// この処理は、DOMツリーを簡潔に保ち、より効率的な処理や比較を可能にするために役立ちます。\n";
90}
91
92// 定義した関数を実行し、サンプルコードの動作を開始します。
93demonstrateDomDocumentNormalize();

Dom\Document::normalize() メソッドは、XMLやHTMLのDOM（Document Object Model）ツリーを「正規化」するための機能です。このメソッドは、ツリー内のテキストノードを整理し、DOM構造をより簡潔で扱いやすい形に整えます。

具体的には、二つの主要な処理を行います。まず、内容が空のテキストノードをDOMツリーから削除します。これにより、不要なノードが取り除かれ、ツリーがすっきりします。次に、同じ親要素を持つテキストノードが複数連続している場合、それらを一つの大きなテキストノードに結合します。例えば、「あ」「い」「う」という三つのテキストノードが連続していれば、「あいう」という一つのテキストノードにまとめられます。ただし、テキストノードの間に要素ノードなどが挟まっている場合は結合されません。

このメソッドには引数がなく、実行後に特別な値を返すことはありません（戻り値は void です）。メソッドを呼び出すと、対象の Dom\Document オブジェクトの内部状態が直接変更されます。

サンプルコードでは、意図的に複数のテキストノードや空のテキストノードを含むDOMツリーを作成し、normalize() メソッドを呼び出す前後の変化を確認しています。正規化前には複数の短いテキストノードや空ノードが存在しますが、メソッドの実行後は、連続するテキストノードが一つに結合され、空のノードは削除されていることが分かります。これにより、DOMツリーの複雑さが軽減され、後の処理や比較が容易になるというメリットがあります。

Copy
1<?php
2
3/**
4 * Dom\Document::normalize() メソッドの使用例。
5 *
6 * この関数は、Dom\Documentオブジェクトに複数の隣接するTextノードや空のTextノードを
7 * 手動で追加し、Dom\Document::normalize() メソッドの適用前と後でDOMツリーの
8 * Textノードの状態を比較します。
9 * normalize() メソッドは、DOMツリー内の隣接するTextノードを結合し、
10 * 空のTextノードを削除することで、ツリーを「正規化」します。
11 *
12 * PHPのDOM拡張機能は通常、PHPに標準でバンドルされているため、特別な「インストール」は
13 * ほとんどの場合不要です。もしDOM機能が利用できない場合は、PHPのビルド設定を確認してください
14 * (例: `--disable-dom` オプションが使われていないか)。
15 *
16 * キーワードにある「normalizer」という言葉が、Unicode正規化（例: 全角・半角の統一）を
17 * 目的とする場合は、`intl`拡張機能の `Normalizer` クラスを使用しますが、
18 * ここでは指定されたリファレンス情報 `Dom\Document::normalize` に従ってDOMの正規化を示します。
19 */
20function demonstrateDomNormalization(): void
21{
22    // 新しいDOMドキュメントを作成 (XML宣言を含む)
23    $dom = new Dom\Document('1.0', 'UTF-8');
24
25    // ルート要素を作成し、ドキュメントに追加
26    $rootElement = $dom->createElement('root');
27    $dom->appendChild($rootElement);
28
29    // テスト用の要素を作成し、ルート要素に追加
30    $paragraph = $dom->createElement('paragraph');
31    $rootElement->appendChild($paragraph);
32
33    // 意図的に複数の隣接するTextノードと空のTextノードを追加
34    // これらは normalize() によって結合または削除される
35    $paragraph->appendChild($dom->createTextNode('Part 1'));
36    $paragraph->appendChild($dom->createTextNode(' ')); // 空白のみのTextノード
37    $paragraph->appendChild($dom->createTextNode('Part 2'));
38    $paragraph->appendChild($dom->createTextNode(''));   // 空のTextノード
39    $paragraph->appendChild($dom->createTextNode('Part 3'));
40    $paragraph->appendChild($dom->createTextNode("\nAnother\nLine")); // 複数行のTextノード
41
42    echo "--- 正規化前のDOMツリー情報 ---" . PHP_EOL;
43    displayNodeInfo($paragraph, 0);
44
45    // Dom\Document::normalize() メソッドを呼び出し
46    // これにより、paragraph要素の子ノードである隣接するTextノードが結合され、
47    // 空のTextノードが削除されます。
48    $dom->normalize();
49
50    echo PHP_EOL . "--- 正規化後のDOMツリー情報 ---" . PHP_EOL;
51    displayNodeInfo($paragraph, 0);
52
53    echo PHP_EOL . "--- 正規化後のXML出力 ---" . PHP_EOL;
54    // normalize()後の結果をXMLとして出力（DOMDocument::saveXMLはDOMツリーを元に出力）
55    // Textノードが結合された状態で出力されることを確認できます。
56    echo $dom->saveXML($rootElement);
57}
58
59/**
60 * 指定されたDOMノードの子ノード情報を再帰的に表示する補助関数。
61 * normalize() メソッドの効果を視覚的に確認しやすくするために使用します。
62 *
63 * @param Dom\Node $node 現在のノード
64 * @param int $level 現在の階層レベル（インデント用）
65 */
66function displayNodeInfo(Dom\Node $node, int $level): void
67{
68    $indent = str_repeat('  ', $level);
69    foreach ($node->childNodes as $child) {
70        if ($child instanceof Dom\Text) {
71            $value = $child->nodeValue;
72            // 改行やタブを可視化して表示
73            $displayValue = str_replace(["\n", "\r", "\t"], ['\n', '\r', '\t'], $value);
74            if (trim($value) === '') {
75                 // 空白または空のTextノード
76                 echo $indent . "- Textノード (空白または空, 長さ: " . strlen($value) . ", 値: '" . $displayValue . "')" . PHP_EOL;
77            } else {
78                 // 内容のあるTextノード
79                 echo $indent . "- Textノード (長さ: " . strlen($value) . ", 値: '" . $displayValue . "')" . PHP_EOL;
80            }
81        } elseif ($child instanceof Dom\Element) {
82            echo $indent . "- Elementノード (タグ: <" . $child->tagName . ">)" . PHP_EOL;
83            displayNodeInfo($child, $level + 1); // 子要素を再帰的に表示
84        } elseif ($child instanceof Dom\Comment) {
85            echo $indent . "- Commentノード (値: '" . substr($child->nodeValue, 0, 30) . (strlen($child->nodeValue) > 30 ? '...' : '') . "')" . PHP_EOL;
86        } else {
87            echo $indent . "- その他のノード (" . $child->nodeName . ")" . PHP_EOL;
88        }
89    }
90}
91
92// 関数の実行
93demonstrateDomNormalization();

PHP 8のDom\Document::normalize()メソッドは、XMLやHTMLのDOM（Document Object Model）ツリーを整理し、「正規化」するための機能です。このメソッドは引数を取らず、戻り値もありませんが、呼び出すと現在のDOMドキュメントの内容が変更されます。具体的には、DOMツリー内で隣接している複数のTextノード（テキストの内容を持つ部分）を一つに結合し、また内容が完全に空であるTextノードを削除します。

サンプルコードでは、まず意図的に複数の隣接するTextノードや空のTextノードを持つDOMツリーを作成しています。normalize()メソッドを呼び出す前と後で、これらのTextノードがどのように変化したかを出力で確認できます。例えば、「Part 1」と「Part 2」の間の空白だけのTextノードや、内容が空のTextノードは削除され、隣接するテキスト内容は結合されて一つのTextノードになります。これにより、DOMツリーが簡潔になり、データ処理や操作がしやすくなります。

PHPのDOM拡張機能は通常、PHP本体に標準で含まれているため、別途「インストール」は不要です。もし利用できない場合は、PHPのビルド設定で無効化されていないか確認してください。なお、キーワードにある「normalizer」という言葉が、文字の全角・半角統一といったUnicode正規化を指す場合、それはintl拡張機能のNormalizerクラスの役割であり、このDom\Document::normalize()とは目的が異なりますのでご注意ください。