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

isEqualNodeメソッドは、現在のDom\DocumentFragmentインスタンスが別のDOMノードと構造的に等しいかどうかを比較するメソッドです。このメソッドは、比較対象のノードと自身のノードについて、まずノードタイプ、ノード名、ノード値が一致するかを確認します。さらに、要素ノードの場合は持っている属性の数、名前、値が全て一致するかを調べます。そして最も重要な点として、両方のノードの子ノードが同じ数だけ存在し、それらの子ノードもすべて再帰的に構造と内容が等しいかどうかを詳細に比較します。

この比較は、二つのノードがメモリ上で全く同じオブジェクト（つまり参照が同じ）であるかどうかを判断するものではありません。あくまでノードの階層構造と内容が論理的に同一であるかを判断します。例えば、DOMツリー内の異なる位置にあっても、その構造とテキストコンテンツ、属性が完全に一致していれば、このメソッドはtrueを返します。一つでも異なる点があればfalseを返します。

この機能は、ウェブページなどのDOM構造を扱う際に、特定の要素やコンテンツブロックが既に存在するかどうかを確認したり、外部から取得したDOMノードが既存のものと全く同じ内容を持っているかを検証したりする場合に非常に役立ちます。Dom\DocumentFragmentは、一時的なDOMコンテンツのコンテナとして頻繁に利用されるため、このisEqualNodeメソッドは、フラグメント内の複雑なノード構造を他のノードと比較する際に重宝されます。

Copy
1<?php
2
3$dom = new DOM\Document();
4$fragment1 = $dom->createDocumentFragment();
5$fragment1->appendChild($dom->createElement('span', 'Node Content A'));
6
7$fragment2 = $dom->createDocumentFragment();
8$fragment2->appendChild($dom->createElement('span', 'Node Content B'));
9
10$isEqual = $fragment1->isEqualNode($fragment2);
11
12?>

Dom\Node $otherNode

• Dom\Node $otherNode: 比較対象のDOMノードを指定します。

bool

このメソッドは、現在のDom\DocumentFragmentノードと、引数で指定された別のDom\DocumentFragmentノードが、構造、属性、およびテキストコンテンツにおいて同一である場合にtrueを返します。それ以外の場合はfalseを返します。