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

containsメソッドは、XML文書全体を表すDom\XMLDocumentオブジェクトが、指定されたノードをその文書ツリー内に含んでいるかどうかを判定するメソッドです。このメソッドは、引数として渡されたノードが、呼び出し元のXMLDocumentオブジェクト自身であるか、またはその子孫ノードとして存在するかを確認します。

もし指定されたノードが文書ツリー内に存在し、かつXMLDocumentオブジェクトの直下またはさらに深い階層の子孫として位置する場合はtrueを返します。それ以外の場合、例えば指定されたノードが別の文書に属している場合や、全く関係のないノードである場合はfalseを返します。

これにより、システムエンジニアはXML文書の構造をプログラム的に検証し、特定の要素やノードが期待される場所に正しく配置されているかを確認できます。例えば、動的に生成・追加されたノードが正しく文書ツリーの一部となっているか、あるいは特定のイベントが発生したノードが、現在処理している文書の範囲内にあるかなどを効率的に判断する際に役立ちます。文書の整合性を保ち、正確なDOM操作を行う上で不可欠な機能と言えます。

Copy
1<?php
2$xmlDocumentInstance = new Dom\XMLDocument();
3$otherDomNode = new DOMElement('element');
4$result = $xmlDocumentInstance->contains($otherDomNode);
5?>

?Dom\Node $other

• ?Dom\Node $other: 比較対象となるDOMノード

戻り値なし

戻り値はありません