【PHP8.x】containsメソッドの使い方
containsメソッドの使い方について、初心者にもわかりやすく解説します。
作成日: 更新日:
基本的な使い方
containsメソッドは、指定したノードがこのエンティティノードの子孫であるかどうかを判定するメソッドです。DOMツリーと呼ばれる、XMLやHTML文書の階層構造内において、あるノードが別のノードの内側に含まれているかという包含関係を調べるために使用されます。ここでいう「子孫」とは、直接の子ノードだけでなく、孫ノードやそれ以降のさらに深い階層に存在するすべてのノードを含みます。メソッドの引数に調査対象のノードオブジェクトを渡すと、そのノードがメソッドを呼び出したノードの子孫であればtrueを、そうでなければfalseを返します。なお、ノード自身を引数に渡した場合も、自分自身を含んでいるとみなされtrueが返ります。このメソッドを利用することで、文書内の特定の要素が期待通りの場所に配置されているかを確認したり、親子関係に基づいた処理を実装したりする際に役立ちます。
構文(syntax)
1public DOMNode::contains(?DOMNode $other): bool
引数(parameters)
DOMNode|null $other
- DOMNode|null $other: 検索対象となる別のDOMNodeオブジェクト、またはnull
戻り値(return)
戻り値なし
戻り値はありません