【PHP8.x】DOMComment::contains()メソッドの使い方

Copy
1<?php
2
3/**
4 * 指定されたDOMCommentノードが、DOMノードの配列中のいずれかのノードを含んでいるかをチェックします。
5 * DOMComment::contains()は、対象ノードが自身であるか、その子孫である場合にtrueを返します。
6 * DOMCommentノードは通常、他のノードを子孫として持たないため、比較対象が自身と同一のノードである場合にのみtrueを返します。
7 *
8 * @param DOMComment $commentNode 基準となるDOMCommentノード。
9 * @param array<DOMNode|DOMNameSpaceNode|null> $nodesToCheck 含まれているかを確認するDOMノードの配列。
10 * @return bool 配列中のいずれかのノードがcommentNodeに含まれていればtrue。
11 */
12function checkCommentContainsAnyOfArray(DOMComment $commentNode, array $nodesToCheck): bool
13{
14    foreach ($nodesToCheck as $otherNode) {
15        // containsメソッドはDOMNode|DOMNameSpaceNode|nullを引数に取る
16        // nullの場合、containsは常にfalseを返す
17        if (($otherNode instanceof DOMNode || $otherNode instanceof DOMNameSpaceNode) && $commentNode->contains($otherNode)) {
18            return true;
19        }
20    }
21    return false;
22}
23
24// サンプルコードの実行
25$document = new DOMDocument();
26$element = $document->createElement('root');
27$document->appendChild($element);
28
29// 基準となるDOMCommentノードを作成し、DOMツリーに追加
30$myComment = $document->createComment('This is my important comment.');
31$element->appendChild($myComment);
32
33// 確認対象のDOMノードの配列を作成
34$nodesArray = [
35    $document->createComment('Another comment.'), // 他のコメントノード
36    $document->createTextNode('Some text content.'), // テキストノード
37    $myComment, // 自身と同一のDOMCommentノード（contains()がtrueを返す一般的なケース）
38    $document->createElement('child'), // 無関係なDOMElementノード
39    null // null値も含む
40];
41
42// checkCommentContainsAnyOfArray 関数を使って、myCommentがnodesArray内のいずれかのノードを含んでいるかを確認
43$doesCommentContainAny = checkCommentContainsAnyOfArray($myComment, $nodesArray);
44
45echo "Does 'myComment' contain any of the nodes in the array?\n";
46echo "Result: " . ($doesCommentContainAny ? "Yes" : "No") . "\n";
47
48?>

PHPのDOMComment::contains()メソッドは、特定のDOMコメントノードが、引数として指定された別のDOMノードまたは名前空間ノードを含んでいるかどうかを真偽値で判定します。このメソッドは、DOMNode、DOMNameSpaceNode、あるいはnullを受け取り、含まれていればtrue、そうでなければfalseを返します。

しかし、DOMCommentノードはDOMツリーにおいて、テキストや要素のような子ノードを持つことは通常ありません。そのため、DOMComment::contains()メソッドがtrueを返すのは、引数として渡されたノードが、比較対象となるDOMCommentノード自身である場合のみに限られます。nullが引数として渡された場合は、常にfalseを返します。

提示されたサンプルコードは、このDOMComment::contains()メソッドの挙動を理解するための具体的な例です。checkCommentContainsAnyOfArray関数は、基準となるDOMCommentノードが、与えられたDOMノードの配列の中に含まれるいずれかのノードを含んでいるかを確認します。この関数では、配列内の各ノードに対してcontains()メソッドを適用し、一つでもtrueになった時点で結果を返します。これにより、コメントノードが自分自身と一致するノードを配列内に持っている場合にのみtrueが出力されることを示しています。

Copy
1<?php
2
3/**
4 * DOMComment::contains メソッドの動作を示すサンプルコードです。
5 *
6 * このメソッドは、現在のノードが引数で渡されたノードの祖先であるかどうかをチェックします。
7 * DOMComment ノードは通常子ノードを持たないため、他のノードを含むことはほとんどありません。
8 * 基本的に、自分自身が引数のノードである場合にのみ true を返します。
9 */
10function demonstrateDomCommentContains(): void
11{
12    // DOMDocument オブジェクトを作成
13    $dom = new DOMDocument('1.0', 'UTF-8');
14
15    // コメントノードを作成
16    $commentNode = $dom->createComment('これはテストコメントです');
17
18    echo "--- DOMComment::contains メソッドのデモンストレーション ---\n";
19
20    // ケース1: コメントノードが自分自身を含むかチェック
21    // 任意のノードは自分自身を含むため、true が返されます。
22    echo "コメントノードが自分自身を含むか: ";
23    var_dump($commentNode->contains($commentNode));
24
25    // ケース2: コメントノードが別の DOMElement ノードを含むかチェック
26    // コメントノードは子ノードを持つことができないため、他のノードを含むことはありません。
27    // この場合、常に false が返されます。
28    $elementNode = $dom->createElement('example');
29    echo "コメントノードが別のDOMElementを含むか: ";
30    var_dump($commentNode->contains($elementNode));
31
32    // ケース3: コメントノードが null を含むかチェック
33    // null はノードではないため、含まれることはありません。
34    echo "コメントノードが null を含むか: ";
35    var_dump($commentNode->contains(null));
36}
37
38// 関数を実行して結果を表示
39demonstrateDomCommentContains();

DOMComment::containsメソッドは、PHPのDOM拡張機能において、DOMCommentクラスに属するメソッドです。このメソッドは、現在のコメントノードが引数として渡されたノードの祖先であるかどうかを真偽値（bool）で判定します。

引数$otherには、チェックしたい対象のノードとしてDOMNode、DOMNameSpaceNode、またはnullを指定できます。メソッドがtrueを返すのは、現在のノードが引数で指定されたノードと同一であるか、その親ノードである場合です。

しかし、DOMCommentノードはHTMLやXML文書内でコメントを表す特殊なノードであり、他のノードを子として持つことができません。このため、DOMComment::containsメソッドは、基本的に現在のコメントノード自身が引数として渡された場合にのみtrueを返します。

サンプルコードでは、この挙動が具体的に示されています。コメントノードが自分自身を含むかをチェックした場合はtrueとなりますが、別のDOMElementノードやnullが引数として渡された場合は、コメントノードがそれらを含むことはないため、常にfalseが返されることを確認できます。このメソッドは、コメントノードの階層関係を判断する際に使用されますが、その特殊な性質を理解することが重要です。