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

containsメソッドは、PHPのDOM拡張機能において、DOMDocumentFragmentオブジェクトが特定のDOMNodeをその子孫として含んでいるかどうかを確認するメソッドです。DOMDocumentFragmentとは、Webページなどのドキュメント構造を表現するDOM（Document Object Model）を操作する際に使用される、複数のノードを一時的にまとめておくための軽量なコンテナです。このメソッドは、引数として検証したいDOMNodeオブジェクトを一つ受け取ります。そして、このDOMDocumentFragmentオブジェクトが、指定されたDOMNodeを自身の内部に、直接の子ノードとして、あるいはさらにその子孫ノードとして持っている場合にtrueを返します。もし含まれていない場合はfalseを返します。

この機能は、特に動的にHTML要素などを構築し、それを最終的なドキュメントツリーに追加する前に、特定の要素がその一時的な集合体の一部であるかを確認したい場合に非常に有用です。例えば、ユーザーの操作に応じて多数の要素をDOMDocumentFragment内で準備している際に、あるイベントが発生したDOMNodeが、現在処理中のフラグメント内に存在するかどうかを効率的に判定することができます。これにより、複雑なDOM操作におけるノードの所属関係を明確にし、プログラムの正確性を高めることに貢献します。このメソッドを使うことで、手動でノードを辿っていく必要がなくなり、コードを簡潔に保ちながらも、DOMツリー内でのノードの包含関係を確実に把握することが可能になります。

Copy
1<?php
2
3$fragment = new DOMDocumentFragment();
4$nodeToCheck = new DOMElement('p');
5$fragment->append($nodeToCheck);
6
7$isContained = $fragment->contains($nodeToCheck); // 指定されたノードが含まれているかチェック
8
9?>

引数なし

引数はありません

bool

指定されたノードがこのDOMDocumentFragmentに含まれているかどうかを示す真偽値を返します。trueであれば含まれており、falseであれば含まれていません。