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

normalizeメソッドの使い方について、初心者にもわかりやすく解説します。

作成日: 2025年09月11日更新日: 2025年10月29日

基本的な使い方

normalizeメソッドは、XMLやHTMLドキュメントの構造を表現するDOMツリーを標準化する処理を実行するメソッドです。このメソッドは、Dom\Nodeクラスのインスタンス、つまりDOMツリー内のあらゆるノードに対して呼び出すことができます。

DOMツリーを構築する際や、プログラムによってノードを追加・編集する際に、テキストデータが複数の隣接するテキストノードに分割されたり、内容が空のテキストノードが生成されたりすることがあります。例えば、<div>HelloWorld</div>のようなHTMLコードを解析すると、HelloとWorldがそれぞれ別のテキストノードとして扱われることがあります。また、不必要な改行やスペースが空のテキストノードとして残る場合もあります。

normalizeメソッドを実行すると、これらの状況を解消し、DOMツリーをクリーンな状態に整えます。具体的には、隣接するすべてのテキストノードを結合して一つのテキストノードにし、内容が空のテキストノードはツリーから削除します。

この処理により、DOMツリーの構造が簡潔になり、プログラムでツリーを走査したり、テキストコンテンツを取得したりする際の複雑さを軽減できます。特に、ノードの子要素を処理するループなどで、余分なテキストノードを意識することなく、より予測可能な方法でコンテンツにアクセスできるようになるため、データ処理のロジックをシンプルに保つ上で非常に役立ちます。

構文(syntax)


1<?php
2$node = new DOMDocument();
3$node->normalize();
4?>

引数(parameters)

引数なし

引数はありません

戻り値(return)

void

このメソッドは、DOMツリーの構造を正規化します。具体的には、隣接するテキストノードを結合し、空のテキストノードを削除します。戻り値はありません。

サンプルコード

PHP Dom\Node::normalize() メソッドでテキストノードを正規化する


1<?php
2
3// DOMDocumentを生成
4$dom = new DOMDocument();
5
6// XMLをロード
7$dom->loadXML('<root><child>&#xA0;test</child></root>');
8
9// root要素を取得
10$root = $dom->documentElement;
11
12// root要素の子要素を取得
13$child = $root->firstChild;
14
15// normalize() メソッドをコールする前にテキストノードの内容を出力
16echo "normalize() メソッド呼び出し前: " . $child->textContent . "\n";
17
18// normalize() メソッドをコール
19$root->normalize();
20
21// normalize() メソッドをコールした後にテキストノードの内容を出力
22echo "normalize() メソッド呼び出し後: " . $child->textContent . "\n";
23
24// DOMDocumentを保存
25echo $dom->saveXML();
26
27?>

このPHPのサンプルコードは、DOMDocumentクラスを用いてXMLドキュメントを操作し、Dom\Nodeクラスのnormalize()メソッドの効果を説明するものです。

まず、DOMDocumentクラスのインスタンスを作成し、loadXML()メソッドでXML文字列をロードします。この例では、ルート要素<root>の中に子要素<child>があり、そのテキストノードに （ノーブレークスペース）を含むXMLを読み込んでいます。

次に、documentElementプロパティでルート要素を取得し、firstChildプロパティでその子要素（この場合は<child>要素）を取得します。normalize()メソッドを呼び出す前に、textContentプロパティでテキストノードの内容を出力することで、ノーブレークスペースが含まれていることを確認します。

normalize()メソッドは、ノード（この場合はルート要素）の子ノードを正規化します。具体的には、隣接するテキストノードを結合し、空のテキストノードを削除します。このサンプルコードでは、ノーブレークスペースを含むテキストノードが正規化されることで、XMLドキュメントの構造が最適化されます。

normalize()メソッド呼び出し後、再度textContentプロパティでテキストノードの内容を出力し、saveXML()メソッドでXMLドキュメント全体を出力します。normalize()メソッドによってテキストノードがどのように変化したかを確認できます。normalize()メソッドは引数を取らず、戻り値もありません。ノード自体を直接変更します。

DOMNode::normalize()メソッドは、ノードの子ノードを正規化する際に使用します。テキストノードが隣接している場合、これらを結合して一つのテキストノードにします。サンプルコードでは、 （ノーブレークスペース）とtestが別のノードとして存在する場合、normalize()によって結合されます。loadXML()の直後では、textContentはそれぞれのノードの値を連結して表示しますが、normalize()後は結合されたテキストノードの内容が表示されます。このメソッドはノードの構造を変化させるため、実行前後のノードの状態をよく理解しておく必要があります。XMLドキュメントの構造が期待通りになっているか、saveXML()の結果を確認することをおすすめします。