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

isEqualNodeメソッドは、現在のDom\Nodeオブジェクトが別の指定されたDom\Nodeオブジェクトと「等しい」かどうかを比較し、その結果を真偽値で返すメソッドです。このメソッドは、PHPでHTMLやXMLのような構造化されたドキュメントを扱う際に利用されます。

ここで言う「等しい」とは、比較対象の2つのノードが同じ種類の情報を持っていることを意味します。具体的には、ノードのタイプ（要素ノード、テキストノードなど）、ノードの名前、ノードの値、ノードが持つすべての属性の名前と値、そしてそれらの子ノードの内容と順序がすべて同じである場合に「等しい」と判断されます。

重要な点として、このメソッドは2つのノードがメモリ上でまったく同じオブジェクト（同一のインスタンス）であるかどうかをチェックするものではありません。あくまで、ノードが表現するデータの内容と構造が同じであるかどうかを判断します。そのため、ドキュメント内の異なる場所にあるノードでも、内容と構造が同一であれば「等しい」と判定されます。

この機能は、DOMツリーを走査して特定の構造や内容を持つノードを探したり、既存のノードが期待通りの状態であるかを確認したりする際に非常に便利です。特に、HTMLやXMLデータの整合性を検証したり、特定のテンプレートが正しく適用されているかを比較したりする場面で役立ちます。

Copy
1<?php
2
3$dom = new Dom\Document();
4$nodeA = $dom->createElement('div');
5$nodeB = $dom->createElement('div');
6
7$areEqual = $nodeA->isEqualNode($nodeB);
8
9?>

?Dom\Node $otherNode

• ?Dom\Node $otherNode: 比較対象となる別の Dom\Node オブジェクト。null の場合もあります。

bool

このメソッドは、現在のノードと指定されたノードが完全に等しい場合に true を返します。それ以外の場合は false を返します。