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

containsメソッドは、指定されたノードが現在のノードの子孫であるかどうかを確認するメソッドです。具体的には、Dom\Elementオブジェクト（XMLドキュメント内の要素）に対して呼び出され、引数として与えられたノードが、その要素の子孫（子、孫、曾孫など）である場合にtrueを、そうでない場合にfalseを返します。

このメソッドは、XMLドキュメントの構造を解析し、特定のノードが別のノードの内部に存在するかどうかを効率的に判断するために使用されます。例えば、特定の要素の中に特定のテキストノードが含まれているか、あるいはある要素の中に別の特定の要素が含まれているかなどを確認する際に役立ちます。

containsメソッドは、DOM（Document Object Model）ツリーにおける親子関係を調べる際に、手動でツリーを辿るよりも簡単かつ高速に判定できるため、XMLドキュメントの操作や検証を行うプログラムにおいて、重要な役割を果たします。

システムエンジニアを目指す初心者の方にとっては、XMLデータを取り扱う際に、特定の要素の内容や構造を検証する場面で活用できるでしょう。例えば、設定ファイルの解析や、Web APIから取得したXMLデータの構造確認などに利用できます。

Copy
1<?php
2
3$dom = new DOMDocument();
4$parentElement = $dom->createElement('div');
5$childElement = $dom->createElement('span');
6$parentElement->appendChild($childElement);
7
8$isContained = $parentElement->contains($childElement);
9
10?>

?Dom\Node $other

• ?Dom\Node $other: 比較対象となるDom\Nodeインスタンス。nullを指定することも可能です。

bool

指定された要素がこのDOM要素の子孫である場合に true を、そうでない場合に false を返します。