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

containsメソッドは、指定されたノードが、このDocumentFragmentオブジェクト自身、またはその子孫ノードとして含まれているかどうかを判定するメソッドです。PHPのDom\DocumentFragmentクラスは、複数のDOMノードを一時的にまとめて保持する特別なコンテナとして機能します。これは、Webページの構造を構成するHTML要素やテキストなどのノードを、実際の文書ツリーに一度に追加する前に効率的に操作したり、構築したりする際に利用されます。

このcontainsメソッドは、そうしたDocumentFragmentが保持しているノードの集合の中に、引数として渡された特定のノードが存在するかどうかを確認する目的で使用されます。例えば、動的に生成した複数のHTML要素をDocumentFragmentに格納し、その中に特定の属性を持つ要素や、特定の種類の要素が意図通りに含まれているかをプログラムで確認したい場合に役立ちます。

メソッドは、引数に指定されたノードがDocumentFragment内、またはその内部の子孫ノードとして見つかった場合はtrueを返します。逆に、そのノードが見つからなかった場合はfalseを返します。これにより、開発者はDocumentFragmentの内部構造を効率的に検証し、ノードの存在や配置をプログラム上で正確に制御することが可能になります。

Copy
1<?php
2
3$document = new Dom\Document();
4$fragment = $document->createDocumentFragment();
5$node = $document->createElement('example');
6
7$fragment->appendChild($node);
8
9$result = $fragment->contains($node);
10
11?>

?Dom\Node $other

• ?Dom\Node $other: 検索対象のノードを指定します。nullを指定することも可能です。

bool

指定されたノードがこのDom\DocumentFragment内に存在するかどうかを真偽値で返します。trueであれば存在し、falseであれば存在しません。