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

Copy
1<?php
2
3/**
4 * Dom\DocumentFragment の isEqualNode メソッドを使用して、
5 * 2つの DocumentFragment が等しいノードであるかを確認するサンプルコードです。
6 * キーワード「php iserror」に関連付けて、比較結果が期待と異なる（等しくない）場合に
7 * その状態を「エラー」として扱います。
8 */
9
10/**
11 * 2つの Dom\DocumentFragment を比較し、結果を出力します。
12 * isEqualNode は、ノードの種類、名前、属性、内容、子ノードなどが全て同じ場合に true を返します。
13 *
14 * @param Dom\DocumentFragment $fragment1 比較対象の最初の DocumentFragment
15 * @param Dom\DocumentFragment $fragment2 比較対象の2番目の DocumentFragment
16 * @return void
17 */
18function compareDomFragments(Dom\DocumentFragment $fragment1, Dom\DocumentFragment $fragment2): void
19{
20    // Dom\DocumentFragment::isEqualNode メソッドを呼び出し、2つのノードが等しいか比較します。
21    if ($fragment1->isEqualNode($fragment2)) {
22        echo "✅ 2つのDocumentFragmentは等しいノードです。\n";
23    } else {
24        // キーワード「php iserror」に関連付け、等しくない場合を「期待する状態ではない」
25        // つまり、広義での「エラー状態」として扱います。
26        echo "❌ 2つのDocumentFragmentは異なるノードです。これは期待する状態ではない可能性があります。\n";
27    }
28}
29
30// Dom\Document インスタンスを作成します。
31// DocumentFragment はこの Dom\Document のコンテキストでノードを生成するために使用します。
32$dom = new Dom\Document();
33
34// --- 比較ケース1: 等しい DocumentFragment の作成と比較 ---
35echo "--- 比較ケース1: 等しい DocumentFragment --- \n";
36
37// 最初の DocumentFragment (fragmentA) を作成します。
38$fragmentA = $dom->createDocumentFragment();
39$elementA = $dom->createElement('p', 'Hello, World!');
40$fragmentA->appendChild($elementA);
41
42// 2番目の DocumentFragment (fragmentB) を作成します。
43// fragmentA と全く同じ内容のノードを追加します。
44$fragmentB = $dom->createDocumentFragment();
45$elementB = $dom->createElement('p', 'Hello, World!');
46$fragmentB->appendChild($elementB);
47
48// fragmentA と fragmentB を比較します。結果は true になるはずです。
49compareDomFragments($fragmentA, $fragmentB);
50
51// --- 比較ケース2: 異なる DocumentFragment の作成と比較 (内容が異なる) ---
52echo "\n--- 比較ケース2: 異なる DocumentFragment (内容が異なる) --- \n";
53
54// 3番目の DocumentFragment (fragmentC) を作成します。
55// fragmentA とは異なる内容のノードを追加します。
56$fragmentC = $dom->createDocumentFragment();
57$elementC = $dom->createElement('p', 'Goodbye, World!'); // 内容が異なる
58$fragmentC->appendChild($elementC);
59
60// fragmentA と fragmentC を比較します。結果は false になるはずです。
61compareDomFragments($fragmentA, $fragmentC);
62
63// --- 比較ケース3: 異なる DocumentFragment の作成と比較 (タグ名が異なる) ---
64echo "\n--- 比較ケース3: 異なる DocumentFragment (タグ名が異なる) --- \n";
65
66// 4番目の DocumentFragment (fragmentD) を作成します。
67// fragmentA とは異なるタグ名のノードを追加します。
68$fragmentD = $dom->createDocumentFragment();
69$elementD = $dom->createElement('span', 'Hello, World!'); // タグ名が異なる
70$fragmentD->appendChild($elementD);
71
72// fragmentA と fragmentD を比較します。結果は false になるはずです。
73compareDomFragments($fragmentA, $fragmentD);
74
75?>

PHPのDom\DocumentFragment::isEqualNodeメソッドは、二つのDOMノードが構造的および内容的に全く同じであるかを確認するために使用されます。このメソッドは、Dom\DocumentFragmentクラスに属していますが、比較対象としてDom\Node型の任意のノードを引数$otherNodeとして受け取ります。メソッドを呼び出す元のノードと引数に指定されたノードが、ノードの種類、名前、属性、内容、そして子ノードに至るまで完全に一致する場合にtrueを返し、一つでも異なる点があればfalseを返します。戻り値がbool型であるため、比較結果に応じてプログラムの処理を分岐させることが容易です。

提供されたサンプルコードでは、Dom\Documentインスタンスを基盤として複数のDom\DocumentFragmentを作成し、isEqualNodeメソッドを用いてそれらを比較しています。具体的には、全く同じ内容を持つDocumentFragmentが等しいと判断されるケース、内容が異なるDocumentFragmentが等しくないと判断されるケース、そしてタグ名が異なる子ノードを持つDocumentFragmentが等しくないと判断されるケースが示されています。

特に「php iserror」というキーワードに関連付け、比較結果がfalse（等しくない）であった場合を「期待する状態ではない」、すなわち広義での「エラー状態」として扱っています。これは、アプリケーションが特定のDOM構造を期待している際に、その期待が満たされない状況を検出するための有用な方法です。このようにisEqualNodeメソッドを用いることで、DOM操作後の整合性チェックや、特定のHTML構造の一致確認など、様々な場面でノードの同一性を正確に検証することができます。

Copy
1<?php
2
3use Dom\Document;
4use Dom\DocumentFragment;
5use Dom\Node;
6
7/**
8 * Dom\DocumentFragment::isEqualNode() の使用例。
9 *
10 * 2つのHTML文字列からDom\DocumentFragmentを作成し、それらが構造的および内容的に
11 * 同一であるかを比較します。isset() を用いた基本的なチェックも含まれており、
12 * 初心者向けの堅牢なプログラミングの例として役立ちます。
13 *
14 * @param string $htmlFragment1 比較する最初のHTML文字列。
15 * @param string $htmlFragment2 比較する2番目のHTML文字列。
16 * @return bool フラグメントが等しい場合はtrue、そうでない場合はfalse。
17 */
18function compareHtmlFragmentsForEquality(string $htmlFragment1, string $htmlFragment2): bool
19{
20    // Dom\Document は Dom\DocumentFragment やその他のノードを作成するために必要です。
21    $dom = new Document();
22
23    // 最初のDOMフラグメントを作成します。
24    $fragmentA = $dom->createDocumentFragment();
25    // HTML文字列を解析するための一時的なDom\Documentを作成します。
26    $tempDocA = new Document();
27    // HTMLをロードします。LIBXML_HTML_NOIMPLIED と LIBXML_HTML_NODEFDTD は、
28    // ドキュメントタイプ宣言や<body>タグなどを自動で追加しないようにし、
29    // フラグメントの厳密な比較を可能にします。
30    // エラーは抑制します。
31    @$tempDocA->loadHTML($htmlFragment1, LIBXML_HTML_NOIMPLIED | LIBXML_HTML_NODEFDTD);
32
33    // 一時ドキュメントからフラグメントへノードをインポートします。
34    // $tempDocA->documentElement (通常は<html>タグ) が存在するかどうかを
35    // isset() で確認することは、特に空の文字列が渡された場合に重要です。
36    if (isset($tempDocA->documentElement)) {
37        foreach ($tempDocA->documentElement->childNodes as $node) {
38            $fragmentA->appendChild($dom->importNode($node, true));
39        }
40    }
41
42    // 2番目のDOMフラグメントを作成します。
43    $fragmentB = $dom->createDocumentFragment();
44    $tempDocB = new Document();
45    @$tempDocB->loadHTML($htmlFragment2, LIBXML_HTML_NOIMPLIED | LIBXML_HTML_NODEFDTD);
46
47    if (isset($tempDocB->documentElement)) {
48        foreach ($tempDocB->documentElement->childNodes as $node) {
49            $fragmentB->appendChild($dom->importNode($node, true));
50        }
51    }
52
53    // Dom\DocumentFragment::isEqualNode() メソッドを使用して2つのフラグメントを比較します。
54    // このメソッドは、ノードとそのすべての子孫ノードを、型、名前、属性、コンテンツなどに基づいて
55    // 詳細に比較し、完全に同一である場合にtrueを返します。
56    $areNodesEqual = $fragmentA->isEqualNode($fragmentB);
57
58    return $areNodesEqual;
59}
60
61// --- 動作確認のための呼び出し例 (このコードブロックは実行されますが、結果は出力されません) ---
62// PHPの単体で動作可能なコードとして、コメントアウトせずに含めます。
63
64// 同じ内容のフラグメントの比較
65$htmlContent1 = '<p>Hello <b>World</b>!</p>';
66$htmlContent2 = '<p>Hello <b>World</b>!</p>';
67$result1 = compareHtmlFragmentsForEquality($htmlContent1, $htmlContent2); // true を返す
68
69// 異なる内容のフラグメントの比較
70$htmlContent3 = '<p>Hello <i>PHP</i>!</p>';
71$result2 = compareHtmlFragmentsForEquality($htmlContent1, $htmlContent3); // false を返す
72
73// 空のフラグメントの比較
74$result3 = compareHtmlFragmentsForEquality('', ''); // true を返す
75
76// 片方が空のフラグメントの比較
77$result4 = compareHtmlFragmentsForEquality('<p>test</p>', ''); // false を返す
78
79// 構造が異なるフラグメントの比較 (大文字・小文字、属性の有無、順序なども含む)
80$htmlContent4 = '<P>Hello <b>World</b>!</P>'; // タグ名の大文字小文字が異なる
81$result5 = compareHtmlFragmentsForEquality($htmlContent1, $htmlContent4); // false を返す

PHPのDom\DocumentFragment::isEqualNodeメソッドは、二つのDOMノードが構造的および内容的に完全に同一であるかを厳密に比較する際に使用します。このメソッドは、比較対象となるDom\Node型の引数$otherNodeを一つ受け取り、両ノードが完全に等しい場合にtrueを、そうでない場合はfalseをブール値として返します。

サンプルコードでは、HTML文字列からDom\DocumentFragmentオブジェクトを生成し、それらを比較する一連の流れが示されています。まず、HTML文字列を解析するための一時的なDom\Documentを作成し、その内容を新しいDom\DocumentFragmentにインポートします。この際、isset($tempDocA->documentElement)のように、要素が存在するかどうかを事前に確認する処理は、特にHTML文字列が空の場合などにエラーを防ぎ、プログラムをより堅牢にするための重要な書き方です。

このようにして準備された二つのDom\DocumentFragmentインスタンスは、isEqualNodeメソッドによって比較されます。このメソッドは、ノードの種類、タグ名、属性、テキストコンテンツ、そしてすべての子孫ノードに至るまで、あらゆる側面から詳細に一致するかどうかを判定します。例えば、タグ名の大文字・小文字の違いや、わずかな属性の有無、子ノードの順序の違いなども厳密に区別されるため、見た目が似ていても構造的にわずかに異なるだけでfalseが返されます。このメソッドを理解し活用することで、PHPにおけるDOM操作において、ノードの比較処理を正確かつ効率的に行うことができます。