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

Copy
1<?php
2
3// DOMDocument を作成し、XML 文字列をロードします。
4$dom = new DOMDocument();
5$dom->loadXML('<root><child attr="value">Text with  multiple   spaces</child></root>');
6
7// root 要素を取得します。
8$root = $dom->documentElement;
9
10// root 要素の子要素を取得します。
11$child = $root->firstChild;
12
13// normalize() メソッドを呼び出して、テキストノードを正規化します。
14$child->normalize();
15
16// 正規化された XML を出力します。
17echo $dom->saveXML();
18
19?>

このPHPのサンプルコードは、DOMElementクラスのnormalize()メソッドの使い方を示しています。normalize()メソッドは、DOM（Document Object Model）ツリー内のテキストノードを正規化するために使用されます。具体的には、隣接するテキストノードを結合したり、空のテキストノードを削除したりすることで、DOMツリーの構造を整理します。

サンプルコードでは、まずDOMDocumentオブジェクトを作成し、XML文字列をロードしています。次に、ルート要素とその子要素であるchild要素を取得しています。child要素には、複数のスペースが含まれるテキストノードが含まれています。

$child->normalize()を呼び出すことで、child要素内のテキストノードが正規化されます。この例では、連続する複数のスペースが単一のスペースに置き換えられます。また、もし隣接するテキストノードが存在すれば、それらが結合されます。このメソッドは引数を必要とせず、戻り値もありません。DOMElementオブジェクト自体が変更されます。

最後に、$dom->saveXML()を用いて、正規化されたXMLを出力しています。これにより、normalize()メソッドの効果を確認することができます。このメソッドを使うことで、DOMツリー内のテキストノードを効率的に整理し、XMLデータの処理を容易にすることができます。

Copy
1<?php
2
3/**
4 * DOMElement::normalize メソッドの使用例を示します。
5 * このメソッドは、要素内の連続するテキストノードを結合し、空のテキストノードを削除することで、
6 * 要素のテキスト表現を正規化します。
7 *
8 * PHPのDOM拡張は標準機能の一部であり、通常は追加のインストールなしで利用できます。
9 * 「normalizer」というキーワードは、文脈によってはUnicode Normalizer (Intl拡張) を指すことがありますが、
10 * ここではDOMElementクラスのnormalizeメソッドに焦点を当てています。
11 */
12function demonstrateDomElementNormalize(): void
13{
14    // 1. DOMDocument オブジェクトを作成します。
15    $dom = new DOMDocument('1.0', 'UTF-8');
16    // 出力を見やすくするために、整形を有効にします。
17    $dom->formatOutput = true;
18
19    // 2. ルート要素を作成し、ドキュメントに追加します。
20    $rootElement = $dom->createElement('root');
21    $dom->appendChild($rootElement);
22
23    // 3. テキストノードが複数に分割された子要素を作成します。
24    // normalize メソッドの効果を分かりやすくするため、意図的に複数のDOMTextノードを追加します。
25    $pElement = $dom->createElement('p');
26
27    // 複数のテキストノードと空のテキストノードを追加
28    $pElement->appendChild(new DOMText('Hello '));
29    $pElement->appendChild(new DOMText('World'));
30    $pElement->appendChild(new DOMText('!'));
31    $pElement->appendChild(new DOMText('')); // 空のテキストノード
32    $pElement->appendChild(new DOMText(' This is an example.'));
33
34    $rootElement->appendChild($pElement);
35
36    echo "--- normalize() 呼び出し前のDOM構造 ---\n";
37    // 現在のDOM構造をXML形式で出力し、テキストノードが分割されていることを確認します。
38    echo $dom->saveXML();
39
40    // p要素内のDOMTextノードの数を数えます。
41    $preNormalizeTextNodes = 0;
42    foreach ($pElement->childNodes as $node) {
43        if ($node->nodeType === XML_TEXT_NODE) {
44            $preNormalizeTextNodes++;
45        }
46    }
47    echo "\nnormalize() 呼び出し前の 'p' 要素内のテキストノード数: " . $preNormalizeTextNodes . "\n";
48
49
50    // 4. DOMElement::normalize() メソッドを呼び出します。
51    // 引数はありません。戻り値もありません（void）。
52    // このメソッドは、$pElement の子ノードとして存在する連続するテキストノードを結合し、
53    // 空のテキストノードを削除します。
54    $pElement->normalize();
55
56    echo "\n--- normalize() 呼び出し後のDOM構造 ---\n";
57    // normalize() 後のDOM構造をXML形式で出力し、変化を確認します。
58    // テキストノードが結合され、1つのテキストノードになっているはずです。
59    echo $dom->saveXML();
60
61    // normalize() 後のp要素内のDOMTextノードの数を数えます。
62    $postNormalizeTextNodes = 0;
63    foreach ($pElement->childNodes as $node) {
64        if ($node->nodeType === XML_TEXT_NODE) {
65            $postNormalizeTextNodes++;
66        }
67    }
68    echo "\nnormalize() 呼び出し後の 'p' 要素内のテキストノード数: " . $postNormalizeTextNodes . "\n";
69    echo "期待されるテキストノード数: 1 (すべての連続するテキストが結合されたため)\n";
70}
71
72// 関数を実行して、DOMElement::normalize の動作を確認します。
73demonstrateDomElementNormalize();
74
75?>

PHPのDOMElement::normalizeメソッドは、XMLやHTMLドキュメントの要素内にあるテキスト表現を整理し、一貫性のある状態にするための機能です。このメソッドを呼び出すと、対象の要素に含まれる連続する複数のテキストノードが一つに結合されます。また、内容が空のテキストノードは削除されます。これにより、DOMツリーがよりシンプルになり、後続の処理がしやすくなります。

このメソッドは引数を必要とせず、処理結果を戻り値として返しません（void型）。呼び出されたDOMElementオブジェクト自体が変更されます。

サンプルコードでは、まずDOMDocumentを作成し、<p>要素に「Hello 」「World」「!」「」（空）「 This is an example.」という複数のテキストノードを意図的に追加しています。normalize()メソッドを呼び出す前は、これらのテキストが個別のノードとして存在していることが確認できます。メソッド実行後には、これらのテキストノードが「Hello World! This is an example.」という単一のテキストノードに結合され、空のノードは削除されているのが分かります。

PHPのDOM拡張は、PHPの標準機能として提供されているため、通常は特別なインストール作業なしで利用できます。「normalizer」という言葉は、文脈によってはUnicodeの正規化を行うIntl拡張を指すこともありますが、DOMElement::normalizeメソッドはDOMツリーの構造に特化した正規化を行います。

Copy
1<?php
2
3/**
4 * DOMElement::normalize() メソッドを用いて、複数のテキストノードに分割された
5 * 電話番号文字列のDOM表現を正規化するサンプルコードです。
6 *
7 * DOMElement::normalize() は、要素内の隣接するテキストノードを結合し、
8 * 空のテキストノードを削除する役割を持ちます。これにより、
9 * 分散したテキストデータを一貫した一つの文字列として扱いやすくなります。
10 *
11 * @param string $initialPhoneNumber テスト用の元の電話番号文字列 (例: "090-1234-5678")
12 * @return string DOM正規化後に取得された結合済みの電話番号文字列
13 */
14function normalizePhoneNumberDomExample(string $initialPhoneNumber): string
15{
16    // 1. DOMDocumentとDOMElementの準備
17    $dom = new DOMDocument('1.0', 'UTF-8');
18    // 電話番号を格納する親要素を作成
19    $phoneElement = $dom->createElement('phone');
20    $dom->appendChild($phoneElement);
21
22    // 2. 電話番号を意図的に複数のテキストノードに分割して追加
23    // これは、DOMElement::normalize() メソッドの効果を示すための準備です。
24    // 例えば "090-1234-5678" を複数の隣接するテキストノードとして追加します。
25    // PHPのDOM実装は通常、CDATAセクションやコメントがない限りは
26    // 隣接するテキストは自動的に結合しますが、ここでは明示的に分割して追加します。
27    $parts = explode('-', $initialPhoneNumber);
28    $phoneElement->appendChild($dom->createTextNode($parts[0] . '-')); // "090-"
29    $phoneElement->appendChild($dom->createTextNode($parts[1] . '-')); // "1234-"
30    $phoneElement->appendChild($dom->createTextNode($parts[2]));       // "5678"
31
32    echo "--- DOMElement::normalize() 実行前 ---\n";
33    echo "子ノードの数: " . $phoneElement->childNodes->length . "\n";
34    foreach ($phoneElement->childNodes as $node) {
35        if ($node->nodeType === XML_TEXT_NODE) {
36            echo "  - テキストノード値: '" . $node->nodeValue . "'\n";
37        }
38    }
39
40    // 3. DOMElement::normalize() を呼び出す
41    // このメソッドは、要素内の隣接するテキストノードを結合します。
42    // 上記の例の場合、"090-", "1234-", "5678" が結合され、
43    // "090-1234-5678" という一つのテキストノードになることが期待されます。
44    // このメソッドには戻り値がなく、DOMツリーの状態を直接変更します。
45    $phoneElement->normalize();
46
47    echo "\n--- DOMElement::normalize() 実行後 ---\n";
48    echo "子ノードの数: " . $phoneElement->childNodes->length . "\n";
49    $normalizedString = '';
50    foreach ($phoneElement->childNodes as $node) {
51        if ($node->nodeType === XML_TEXT_NODE) {
52            echo "  - テキストノード値: '" . $node->nodeValue . "'\n";
53            $normalizedString .= $node->nodeValue; // 結合されたテキストノードから文字列を取得
54        }
55    }
56
57    // DOMから結合された電話番号文字列を返す
58    // この文字列は、必要に応じてその後の書式正規化（ハイフン除去など）の入力として利用できます。
59    return $normalizedString;
60}
61
62// サンプルコードの実行
63$testPhoneNumber = "090-1234-5678";
64$resultPhoneNumber = normalizePhoneNumberDomExample($testPhoneNumber);
65
66echo "\n--- 最終結果 ---\n";
67echo "元の電話番号: " . $testPhoneNumber . "\n";
68echo "DOM正規化後、結合された電話番号: " . $resultPhoneNumber . "\n";

PHP 8のDOMElement::normalize()メソッドは、XMLやHTMLなどのDOMツリーを扱う際に、要素内の隣接するテキストノードを結合し、空のテキストノードを削除する役割を持ちます。これにより、文書構造を整理し、分散したテキストデータを一貫した一つの文字列として扱いやすくします。

サンプルコードでは、電話番号を「090-」「1234-」「5678」のように意図的に複数のテキストノードに分割してDOM要素に追加しています。normalize()メソッドを呼び出す前は、これらの部分はそれぞれ独立したテキストノードとして存在し、要素の子ノード数も複数になります。メソッドの実行後には、これらの隣接するテキストノードが「090-1234-5678」という一つのテキストノードに結合され、要素の子ノード数も減少していることが確認できます。

このメソッドは引数を取らず、戻り値もありませんが、呼び出されたDOM要素の子ノード構造を直接変更します。結果として、複数のテキストノードに散らばっていたデータが、単一のテキストノードとして取得できるようになり、例えば電話番号のような情報を効率的に処理できるようになります。これにより、DOMツリーから文字列データを取得する際の複雑さを軽減し、データの一貫性を保つことに貢献します。