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

Copy
1<?php
2
3// Dom\Documentを新規作成し、出力フォーマットを設定します。
4// PHP 8では、新しいDom拡張のクラス名がDom\Document, Dom\Element, Dom\Text などに変更されています。
5$dom = new Dom\Document('1.0', 'UTF-8');
6$dom->formatOutput = true; // XMLの出力を整形し、読みやすくします
7
8// ルート要素を作成し、ドキュメントに追加します。
9$root = $dom->createElement('root');
10$dom->appendChild($root);
11
12// 複数のDom\Textノードを意図的に連続して追加し、正規化前の状態を作成します。
13// Dom\TextクラスはDom\Nodeを継承しており、normalizeメソッドを持ちます。
14// このメソッドはDOMツリー内の隣接するテキストノードを結合し、空のテキストノードを削除する目的で使用されます。
15// 通常、この正規化はテキストノードの親要素（Dom\Elementなど）に対して呼び出されることで効果を発揮します。
16$textPart1 = new Dom\Text('Hello');
17$root->appendChild($textPart1);
18
19// 空白文字も独立したテキストノードとして追加します。
20$textPart2 = new Dom\Text(' ');
21$root->appendChild($textPart2);
22
23$textPart3 = new Dom\Text('World');
24$root->appendChild($textPart3);
25
26// 空のテキストノードも追加します。これは正規化によって削除されます。
27$emptyText = new Dom\Text('');
28$root->appendChild($emptyText);
29
30$textPart4 = new Dom\Text('!');
31$root->appendChild($textPart4);
32
33echo "--- 正規化前のDOMツリー ---\n";
34echo $dom->saveXML(); // 現在のDOMツリーを出力
35echo "\n";
36
37// 親要素である$rootに対してnormalize()メソッドを呼び出します。
38// Dom\Node::normalize() の動作により、その子孫であるDom\Textノードが結合され、
39// 空のDom\Textノードが削除されます。
40// この操作によって、$textPart1, $textPart2, $textPart3, $textPart4 などは一つのテキストノードに統合されます。
41$root->normalize();
42
43echo "--- 正規化後のDOMツリー ---\n";
44echo $dom->saveXML(); // 正規化後のDOMツリーを出力
45echo "\n";
46
47// 結果として、連続していた複数のテキストノードが一つに結合され、
48// 空のテキストノードが削除されていることを確認できます。
49// 例: <root>Hello World!</root> のように表示されます。

PHP 8では、XMLやHTMLをプログラムで操作するためのDom拡張が刷新され、Dom\Textなどの新しいクラス名で提供されています。Dom\Textは、DOMツリー内でテキストデータを表すノードです。ここで紹介するnormalizeメソッドは、DOMツリー内のテキストノードを整理し、構造を簡潔にするために使われます。

このサンプルコードでは、まずDom\Documentを作成し、Dom\Elementであるルート要素に複数のDom\Textノードを意図的に連続して追加しています。「Hello」「 」「World」「」「!」のように、テキストや空白、さらには空のテキストノードをそれぞれ別々のDom\Textノードとして配置し、正規化前のDOMツリーの状態を確認します。

その後、親要素である$rootに対してnormalize()メソッドを呼び出します。このメソッドは引数を取らず、void（何も返さない）です。normalize()が実行されると、その要素の子孫にある連続したDom\Textノードが自動的に結合され、内容が空のDom\Textノードは削除されます。結果として、元の複数のテキストノードや空ノードが「Hello World!」という一つのDom\Textノードに整理された、より簡潔なDOMツリーが生成されることを確認できます。

このようにnormalizeメソッドは、DOMツリーをより扱いやすい状態に保つために利用され、特に外部から読み込んだDOMの構造を標準化したい場合に役立ちます。

Copy
1<?php
2
3// Dom\Text::normalize メソッドの動作を示すサンプルコードです。
4// PHP 8 の Dom 拡張を使用しています。
5//
6// Dom\Text クラスは Dom\Node クラスから normalize() メソッドを継承しています。
7// このメソッドは、呼び出されたノードの子ノードを正規化することを意図しています。
8// しかし、Dom\Text インスタンス自体には子ノードがないため、
9// Dom\Text インスタンスに対して normalize() を直接呼び出しても、
10// 隣接する Text ノードの結合や空の Text ノードの削除といったDOM構造の変更は発生しません。
11// これらの正規化の動作は、通常、親要素 (Dom\Element など) に対して normalize() を呼び出すことで行われます。
12
13/**
14 * Dom\Text::normalize メソッドの動作を実演する関数です。
15 * 主に親要素の normalize() が Text ノードの結合を行うことを示します。
16 */
17function demonstrateDomTextNormalization(): void
18{
19    // 1. 新しい Dom\Document を作成します。
20    $document = new Dom\Document();
21
22    // 2. ルート要素となる <p> タグを作成し、ドキュメントに追加します。
23    $parentElement = $document->createElement('p');
24    $document->appendChild($parentElement);
25
26    // 3. 親要素の子として、意図的に隣接する複数の Dom\Text ノードを追加します。
27    //    これにより、正規化されるべき状態を作り出します。
28    $textNode1 = new Dom\Text('Hello');
29    $textNode2 = new Dom\Text(' World');
30    $textNode3 = new Dom\Text('!');
31
32    $parentElement->appendChild($textNode1);
33    $parentElement->appendChild($textNode2);
34    $parentElement->appendChild($textNode3);
35
36    echo "--- 正規化前の状態 ---\n";
37    echo "親要素の子ノード数: " . $parentElement->childNodes->count() . "\n";
38    echo "現在のHTML構造: " . $document->saveHTML() . "\n\n";
39
40    // 4. Dom\Text インスタンス ($textNode1) に対して normalize() メソッドを呼び出します。
41    //    Text ノード自体に子ノードがないため、この呼び出しではDOM構造に変化はありません。
42    echo "--- Dom\\Text インスタンス ($textNode1) の normalize() を呼び出し ---\n";
43    $textNode1->normalize();
44    echo "親要素の子ノード数（Dom\\Text::normalize() 呼び出し後）: " . $parentElement->childNodes->count() . "\n";
45    echo "現在のHTML構造: " . $document->saveHTML() . "\n\n";
46
47    // 5. 親要素 (Dom\Element) の normalize() メソッドを呼び出します。
48    //    この呼び出しにより、隣接する Dom\Text ノードが結合され、子ノード数が減少します。
49    echo "--- 親要素 (Dom\\Element) の normalize() を呼び出し ---\n";
50    $parentElement->normalize();
51    echo "親要素の子ノード数（Dom\\Element::normalize() 呼び出し後）: " . $parentElement->childNodes->count() . "\n";
52    
53    // 結合されたTextノードの内容を確認
54    if ($parentElement->firstChild instanceof Dom\Text) {
55        echo "結合されたTextノードの内容: '" . $parentElement->firstChild->nodeValue . "'\n";
56    }
57    echo "現在のHTML構造: " . $document->saveHTML() . "\n";
58}
59
60// 関数を実行します。
61demonstrateDomTextNormalization();

PHP 8のDom\Text::normalizeメソッドは、DOM (Document Object Model) 内のテキストノードの正規化に関連する機能です。このメソッドは引数を取らず、処理が完了しても何も値を返しません (void)。Dom\Textクラスのインスタンスはそれ自体がテキスト内容を持つ終端ノードであり、子ノードを持たないため、Dom\Textインスタンスに対してnormalize()を直接呼び出しても、DOM構造に具体的な変更は発生しません。

テキストノードの正規化、例えば隣接する複数のテキストノードを結合したり、空のテキストノードを削除したりといった処理は、通常、そのテキストノードを子に持つ親要素、例えばDom\Elementインスタンスに対してnormalize()を呼び出した際に実行されます。サンプルコードでは、意図的に分割されたテキストノードを持つ親要素を作成し、親要素のnormalize()を呼び出すことで、これらのテキストノードが一つに結合され、親要素の子ノード数が減少する様子を示しています。これにより、DOM構造を整理し、より扱いやすい形にすることができます。

Copy
1<?php
2
3/**
4 * Dom\Text::normalize メソッドの動作をシステムエンジニアの初心者向けにデモンストレーションします。
5 *
6 * この関数は、DOMツリー内のテキストノードがどのように正規化されるかを示します。
7 * PHPのDOM拡張は通常PHPに標準でバンドルされているため、特別なインストールは不要です。
8 * リファレンスにある `Dom\Text::normalize` は、隣接するDOMTextノードを結合し、
9 * 空のDOMTextノードを削除する機能を提供します。
10 * この機能は通常、DOMDocument や DOMElement などの親ノードの `normalize()` メソッドを呼び出すことで、
11 * ツリー全体または特定の部分に適用されます。
12 */
13function demonstrateDomTextNormalize(): void
14{
15    // DOMDocument オブジェクトを作成し、XMLバージョンとエンコーディングを指定します。
16    $dom = new DOMDocument('1.0', 'UTF-8');
17    // 出力を整形して読みやすくします。
18    $dom->formatOutput = true;
19
20    // ルート要素を作成し、DOMドキュメントに追加します。
21    $root = $dom->createElement('root');
22    $dom->appendChild($root);
23
24    // テスト用の要素を作成し、ルート要素に追加します。
25    $paragraph = $dom->createElement('paragraph');
26    $root->appendChild($paragraph);
27
28    // わざと連続する複数のテキストノードと空のテキストノードを作成し、<paragraph> 要素に追加します。
29    // これらは後で normalize() メソッドによって結合または削除されます。
30    $paragraph->appendChild($dom->createTextNode('こんにちは'));
31    $paragraph->appendChild($dom->createTextNode(' ')); // スペースを含むテキストノード
32    $paragraph->appendChild($dom->createTextNode('世界'));
33    $paragraph->appendChild($dom->createTextNode('')); // 空のテキストノード
34    $paragraph->appendChild($dom->createTextNode('!'));
35
36    echo "--- 正規化前のDOMツリーの状態 ---\n";
37    echo "要素 '<paragraph>' の子ノード数: " . $paragraph->childNodes->length . "\n";
38    echo "各子ノードの詳細:\n";
39    // 正規化前の各子ノードの型と内容を表示します。
40    foreach ($paragraph->childNodes as $index => $node) {
41        if ($node instanceof DOMText) {
42            echo "  [" . $index . "] DOMText ノード: '" . $node->nodeValue . "' (長さ: " . mb_strlen($node->nodeValue) . ")\n";
43        } else {
44            echo "  [" . $index . "] その他のノード: " . get_class($node) . " (" . $node->nodeName . ")\n";
45        }
46    }
47    echo "XML出力（この時点では、DOMの内部構造がXML出力では見えにくいことがあります）:\n";
48    echo $dom->saveXML($paragraph); // 特定の要素のXMLスニペットを表示
49    echo "\n";
50
51    echo "--- ドキュメント全体の正規化を実行中 ---\n";
52    // ドキュメント全体を正規化します。
53    // これにより、<paragraph> 要素内の連続するDOMTextノードが1つに結合され、
54    // 空のDOMTextノードが削除されます。
55    // Dom\Text::normalize の機能がここで内部的に利用されます。
56    $dom->normalize();
57    echo "正規化が完了しました。\n\n";
58
59    echo "--- 正規化後のDOMツリーの状態 ---\n";
60    echo "要素 '<paragraph>' の子ノード数: " . $paragraph->childNodes->length . "\n";
61    echo "各子ノードの詳細:\n";
62    // 正規化後の各子ノードの型と内容を表示します。
63    // 子ノードの数が減り、テキストノードが結合されていることを確認できます。
64    foreach ($paragraph->childNodes as $index => $node) {
65        if ($node instanceof DOMText) {
66            echo "  [" . $index . "] DOMText ノード: '" . $node->nodeValue . "' (長さ: " . mb_strlen($node->nodeValue) . ")\n";
67        } else {
68            echo "  [" . $index . "] その他のノード: " . get_class($node) . " (" . $node->nodeName . ")\n";
69        }
70    }
71    echo "XML出力:\n";
72    echo $dom->saveXML($paragraph); // 特定の要素のXMLスニペットを表示
73}
74
75// 関数を実行してデモンストレーションを開始します。
76demonstrateDomTextNormalize();

PHPのDom\Text::normalizeメソッドは、DOM（Document Object Model）ツリー内のテキストノードを整理（正規化）するために使われる機能です。このメソッドは、隣接する複数のテキストノードを一つに結合し、内容が空のテキストノードを削除することで、DOMツリーをよりシンプルで効率的な状態に保ちます。

このメソッド自体はDom\Textクラスに所属しますが、通常はDOMDocumentクラスやDOMElementクラスのnormalize()メソッドを呼び出すことで、ドキュメント全体または特定の要素とその子孫に対して適用されます。Dom\Text::normalizeメソッドは引数を取らず、戻り値もありません（void）。これは、メソッドが直接DOMツリーの状態を変更するためです。

サンプルコードでは、まずDOMDocumentを作成し、意図的に複数のテキストノード（「こんにちは」「 」「世界」「」「!」など）が連続するような要素を構築しています。正規化前の状態では、これらが個別のテキストノードとして存在しますが、$dom->normalize()を呼び出すことで、内部的にDom\Text::normalizeの機能が働き、連続するテキストノードが一つに結合され、途中にあった空のテキストノードも削除されます。これにより、DOMツリーがクリーンな状態に保たれることを示しています。PHPのDOM拡張は通常標準で提供されているため、特別なインストール作業は不要で利用できます。