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

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構造を整理し、より扱いやすい形にすることができます。