【PHP8.x】containsメソッドの使い方
containsメソッドの使い方について、初心者にもわかりやすく解説します。
作成日: 更新日:
基本的な使い方
containsメソッドは、DOM要素が指定されたノード（要素）を包含しているかどうかを確認するメソッドです。Dom\HTMLElementクラスに属しており、PHPのDOM拡張モジュールで使用されます。具体的には、このメソッドは、対象となるDOM要素が、引数として渡されたノードの親、祖先にあたるかどうかを判定します。
メソッドは、引数としてDOMNodeオブジェクトを受け取ります。このDOMNodeオブジェクトは、包含関係を確認したいノードを表します。
containsメソッドの戻り値はboolean型です。対象となるDOM要素が指定されたノードを包含している場合はtrueを、そうでない場合はfalseを返します。
このメソッドは、DOMツリー構造における要素間の関係性をプログラム的に判断するために非常に役立ちます。例えば、特定の要素の子要素、あるいはそれより深い階層にある要素であるかを判定する際に利用できます。ウェブページの特定の部分が、特定の要素内に存在するかどうかを検証するような場合に便利です。
containsメソッドを使用することで、複雑なDOM構造を効率的に操作し、特定の条件を満たす要素を特定する処理などを実装できます。
構文(syntax)
1public Dom\HTMLElement::contains(Dom\HTMLElement $other): bool
引数(parameters)
?Dom\Node $other
- ?Dom\Node $other: 比較対象となるDOMノード。指定されたノードが現在のノードのツリー内に存在するかどうかを確認します。NULLを指定した場合、FALSEを返します。
戻り値(return)
bool
指定された要素がこの要素の子孫に含まれているかどうかを真偽値（true または false）で返します。