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

Copy
1<?php
2
3/**
4 * Dom\Notation::normalize() の動作を示すサンプルコードです。
5 *
6 * このコードは、DTD(文書型定義)を持つXML文書を生成し、
7 * そこから特定の記法(Notation)ノードを取得します。
8 * そして、取得したNotationノードに対して normalize() メソッドを実行します。
9 *
10 * normalize() は、主に隣接するテキストノードを結合し、空のテキストノードを
11 * 削除するために使われます。しかし、Notationノード自体は子ノードを
12 * 持つことができないため、このメソッドを呼び出しても、
13 * ドキュメントに目に見える変化は起こりません。
14 * このサンプルは、その挙動を確認することを目的としています。
15 */
16function demonstrateDomNotationNormalize(): void
17{
18    // DTD内で 'jpeg' という名前のNotationを定義したXML文字列
19    $xmlString = <<<XML
20    <?xml version="1.0" encoding="UTF-8"?>
21    <!DOCTYPE root [
22      <!NOTATION jpeg PUBLIC "image/jpeg">
23    ]>
24    <root></root>
25    XML;
26
27    // DOMDocumentオブジェクトを作成
28    $document = new \DOMDocument();
29
30    // DTDを解釈するオプションを有効にしてXMLを読み込む
31    $document->loadXML($xmlString, LIBXML_DTDLOAD);
32
33    // DocumentTypeノード (<!DOCTYPE ...>) を取得
34    $doctype = $document->doctype;
35
36    // notationsプロパティから 'jpeg' という名前のNotationノードを取得
37    // PHP 8のNullsafe operator (?->) を使用
38    /** @var \Dom\Notation|null $notation */
39    $notation = $doctype?->notations?->getNamedItem('jpeg');
40
41    if ($notation instanceof \Dom\Notation) {
42        echo "取得したNotationノード:\n";
43        printf(" - Node Name: %s\n", $notation->nodeName);
44        printf(" - Public ID: %s\n", $notation->publicId);
45        echo "\n";
46
47        echo "--- normalize() 呼び出し前のXML ---\n";
48        echo $document->saveXML();
49        echo "\n";
50
51        // Dom\Notation オブジェクトに対して normalize() を呼び出す
52        // このノードは子を持たないため、この操作による文書の変化はありません
53        $notation->normalize();
54
55        echo "--- normalize() 呼び出し後のXML (変化なし) ---\n";
56        echo $document->saveXML();
57    } else {
58        echo "Notation 'jpeg' が見つかりませんでした。\n";
59    }
60}
61
62// 作成した関数を実行します
63demonstrateDomNotationNormalize();
64

このPHPサンプルコードは、XMLの記法（Notation）を表すDom\Notationオブジェクトに対し、normalize()メソッドを実行する例です。最初に、DTD（文書型定義）でjpegという記法を定義したXML文書を読み込み、該当するDom\Notationオブジェクトを取得します。

normalize()メソッドは、呼び出されたノードとそのすべての子孫を「正規化」する機能を持っています。正規化とは、主に隣接するテキストノードを一つに結合したり、空のテキストノードを削除したりして、DOM構造を整理する処理のことです。このメソッドは引数を持たず、処理結果を返しません（戻り値はvoidです）。

しかし、XMLの仕様上、Dom\Notationノードは子ノードを持つことができません。したがって、正規化の対象となる子ノードが存在しないため、normalize()メソッドを呼び出してもドキュメントの構造に何の変化も起こりません。このコードは、メソッドの実行前後でXMLデータが全く変わらないことを示すことで、この特性を具体的に確認できます。

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * Dom\Node::normalize() メソッドの使用例を示します。
7 *
8 * このメソッドは、指定されたノードのすべての子孫を「正規化」された形式にします。
9 * 具体的には、隣接するテキストノードを1つに結合し、空のテキストノードを削除します。
10 * Dom\Notation クラスも Dom\Node を継承しているため、このメソッドを持ちます。
11 *
12 * 注意: この normalize はXML/HTMLのノード構造を対象とします。
13 * Unicode文字列を正規化する intl 拡張の Normalizer クラスとは異なります。
14 * 「php normalizer インストール」というキーワードは、多くの場合 intl 拡張を指しますが、
15 * DOM 拡張は通常PHPに標準で組み込まれているため、別途インストールは不要です。
16 */
17function demonstrateDomNodeNormalization(): void
18{
19    // DOMDocumentオブジェクトを生成
20    $dom = new DOMDocument('1.0', 'UTF-8');
21
22    // 親要素を作成
23    $parentElement = $dom->createElement('message');
24    $dom->appendChild($parentElement);
25
26    // 正規化の対象となる、複数の隣接したテキストノードと空のテキストノードを作成
27    $textNode1 = $dom->createTextNode('隣接するテキストと、');
28    $textNode2 = $dom->createTextNode('空のテキストノード');
29    $emptyTextNode = $dom->createTextNode(''); // 空のテキストノード
30    $textNode3 = $dom->createTextNode('です。');
31
32    // 作成したノードを親要素に追加
33    $parentElement->appendChild($textNode1);
34    $parentElement->appendChild($textNode2);
35    $parentElement->appendChild($emptyTextNode);
36    $parentElement->appendChild($textNode3);
37
38    // normalize() を実行する前の状態を出力
39    // 4つの子ノードが存在することを確認
40    echo "Before normalize():\n";
41    echo 'Child node count: ' . $parentElement->childNodes->length . "\n";
42    echo $dom->saveXML($parentElement) . "\n\n";
43
44    // 親要素に対して normalize() を実行
45    $parentElement->normalize();
46
47    // normalize() を実行した後の状態を出力
48    // 隣接するテキストノードが結合され、空のノードが削除された結果、
49    // 子ノードが1つになったことを確認
50    echo "After normalize():\n";
51    echo 'Child node count: ' . $parentElement->childNodes->length . "\n";
52    echo $dom->saveXML($parentElement) . "\n";
53}
54
55// 関数を実行
56demonstrateDomNodeNormalization();

Dom\Node::normalize()メソッドは、XMLやHTMLドキュメントのノード構造を整理し、きれいな形式（正規化）にするための機能です。Dom\Notationクラスも親クラスであるDom\Nodeからこの機能を継承しているため利用可能です。

このメソッドを呼び出すと、対象となるノードとその配下にあるすべての子孫ノードを走査します。その過程で、隣り合って存在する複数のテキストノードを一つのテキストノードに結合し、中身が空のテキストノードを削除します。この処理により、ドキュメントの構造が簡潔になり、意図しない空白などによる問題を減らすことができます。

サンプルコードでは、message要素の中に複数のテキストノードと空のテキストノードを追加しています。normalize()を実行する前は4つあった子ノードが、実行後には隣接するテキストが結合され、空ノードが削除された結果、1つの子ノードにまとめられていることがわかります。

このメソッドは引数を必要とせず、戻り値もありません（void）。これは、メソッドが何か新しい値を返すのではなく、呼び出されたノードオブジェクト自体の構造を直接変更するためです。DOM拡張はPHPに標準で組み込まれているため、通常「php normalizer インストール」といった作業は不要です。