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

containsメソッドの使い方について、初心者にもわかりやすく解説します。

作成日: 2025年09月11日更新日: 2025年11月28日

基本的な使い方

containsメソッドは、Dom\Comment クラスのメソッドで、指定された文字列がコメントノードのテキストコンテンツ内に存在するかどうかを判定します。このメソッドは、PHP 8 で導入され、コメントノードの内容を効率的に検索するために利用できます。

具体的には、引数として検索する文字列を受け取り、コメントノードのテキストコンテンツにその文字列が含まれている場合は true を、含まれていない場合は false を返します。大文字と小文字は区別されます。

システムエンジニアを目指す初心者の方にとって、このメソッドは、HTMLやXMLドキュメントを解析し、特定のキーワードやフレーズを含むコメントを抽出したり、特定の条件を満たすコメントが存在するかどうかを検証したりする際に役立ちます。例えば、特定のバージョンの情報をコメントとして埋め込み、contains メソッドを用いて該当バージョンのコメントが存在するかを確認することで、システムのバージョン管理や設定の確認を自動化できます。

containsメソッドを使用することで、文字列検索処理を簡潔に記述でき、コードの可読性と保守性を向上させることができます。また、複雑な正規表現を使用せずに、単純な文字列検索を行えるため、パフォーマンスの面でも優れています。Dom拡張関数は、XMLやHTMLを扱う上で非常に強力なツールとなりますので、この機会にcontainsメソッドの使い方をマスターし、日々の開発業務に役立ててください。

構文(syntax)


1Dom\Comment::contains(string $needle, int $offset = 0): bool

引数(parameters)

Dom\Node|string $data

Dom\Node|string $data: 検索対象のデータ。Dom\Nodeオブジェクトまたは文字列を指定します。

戻り値(return)

bool

このメソッドは、指定した文字列がコメントノードのコンテンツに含まれているかどうかを示す真偽値（trueまたはfalse）を返します。

サンプルコード

PHP 配列 contains 値チェックする


1<?php
2
3declare(strict_types=1);
4
5/**
6 * 指定された配列に特定の値が含まれているかを確認し、結果を表示します。
7 *
8 * PHPで配列に特定の値が含まれているかを確認するには、
9 * in_array() 関数を使用するのが最も一般的です。
10 *
11 * @param array<int, string> $haystack 検索対象の配列
12 * @param string $needle 検索する値
13 * @return void
14 */
15function checkValueInArray(array $haystack, string $needle): void
16{
17    // in_array() を使って配列内に値が存在するかをチェックします。
18    // 第1引数: 探す値
19    // 第2引数: 検索対象の配列
20    // 第3引数(オプション): true にすると、型も厳密に比較します (=== と同じ)。
21    $isFound = in_array($needle, $haystack, true);
22
23    if ($isFound) {
24        echo "配列に '{$needle}' は含まれています。" . PHP_EOL;
25    } else {
26        echo "配列に '{$needle}' は含まれていません。" . PHP_EOL;
27    }
28}
29
30// 検索対象となるプログラミング言語の配列
31$languages = ['PHP', 'JavaScript', 'Python', 'Go'];
32
33// 配列に含まれている値を確認する
34checkValueInArray($languages, 'PHP');
35
36// 配列に含まれていない値を確認する
37checkValueInArray($languages, 'Ruby');
38
39?>

PHPのin_array()関数は、配列の中に特定の値が含まれているかどうかを確認する際に非常に役立つ機能です。システムエンジニアがデータ処理を行う際によく利用されます。

このサンプルコードでは、checkValueInArrayという関数を通じてin_array()の基本的な使い方を解説しています。in_array()関数は主に二つの引数を取ります。最初の引数である$needleは「検索したい値」を指定し、二番目の引数である$haystackは「検索対象となる配列」を指定します。オプションで三番目の引数にtrueを設定すると、値だけでなくデータの型も厳密に比較します。

in_array()は、指定された値が配列内に見つかればtrueを、見つからなければfalseを戻り値として返します。サンプルコードでは、このtrueまたはfalseという戻り値を利用して、値の有無に応じたメッセージを表示しています。

具体的には、$languagesという配列に'PHP'が含まれているか、また'Ruby'が含まれているかを順番にチェックし、それぞれの結果を出力しています。このようにin_array()関数を使うことで、配列の要素の有無を簡単に、かつ効率的に判定することができます。

提示されたリファレンスのDom\Comment::containsは、DOMのコメントノードが別のノードや文字列を含むかを判定するメソッドであり、今回のサンプルコードが示す「配列に特定の値が含まれるか」を確認するin_array()関数とは用途が異なります。サンプルコードはPHPで配列の要素を検索する際に最も一般的で正しいin_array()関数の使い方を示しています。特に第3引数にtrueを指定することで、値だけでなく型も厳密に比較されるため、意図しない型変換によるバグを防ぐために活用してください。containsというキーワードで機能を検索する際は、対象が「配列」なのか「文字列」なのか「DOMノード」なのかを明確にし、in_array()やstr_contains()、あるいはDom\Comment::containsなど、目的に合った関数を選ぶことが重要です。

PHP Dom\Comment contains()でコメント検索する


1<?php
2
3/**
4 * Dom\Comment::contains() メソッドの使用例
5 * PHP 8 の新しいDOM拡張におけるコメントノードの文字列検索方法を示します。
6 */
7
8// 1. DOMDocument のインスタンスを作成します。
9// これはHTMLやXMLドキュメントをプログラムで操作するための基盤となります。
10$dom = new DOMDocument();
11
12// 2. 処理するHTMLコンテンツを定義します。
13// ここには検索対象となるコメントが含まれています。
14$htmlContent = '
15<!DOCTYPE html>
16<html>
17<head>
18    <!-- これはPHPのDom\Comment::containsメソッドのテストコメントです -->
19    <title>PHP Dom Comment Test</title>
20</head>
21<body>
22    <h1>Hello, PHP DOM!</h1>
23    <p>このページはDOM操作のサンプルです。</p>
24    <!-- 別な情報に関するコメント -->
25</body>
26</html>
27';
28
29// 3. HTMLコンテンツをDOMDocumentにロードします。
30// LIBXML_HTML_NOIMPLIED と LIBXML_HTML_NODEFDTD は、
31// 不必要なHTML/DOCTYPE宣言が自動挿入されるのを防ぎ、より元のHTMLに近いDOMツリーを構築します。
32$dom->loadHTML($htmlContent, LIBXML_HTML_NOIMPLIED | LIBXML_HTML_NODEFDTD);
33
34// 4. DOMDocumentからDOMXPathオブジェクトを作成します。
35// XPathは、DOMツリー内の特定のノードを強力なクエリで検索するためのツールです。
36$xpath = new DOMXPath($dom);
37
38// 5. XPathクエリを使用して、ドキュメント内のすべてのコメントノードを検索します。
39// '//comment()' は、ドキュメントのどこにあるコメントノードでも見つけ出します。
40$commentNodes = $xpath->query('//comment()');
41
42// 検索したい文字列を定義します。
43$searchString1 = 'テストコメント';       // 存在する文字列
44$searchString2 = '存在しない文字列';    // 存在しない文字列
45
46// 6. 見つかったコメントノードを一つずつ処理します。
47foreach ($commentNodes as $node) {
48    // `$node` は PHP 8 以降では `Dom\Comment` のインスタンスとなります。
49    if ($node instanceof Dom\Comment) {
50        echo "--- コメントノードが見つかりました ---\n";
51        echo "コメント内容: \"{$node->nodeValue}\"\n"; // nodeValueでコメントのテキスト内容を取得
52
53        // 7. contains() メソッドを使用して、コメントが特定の文字列を含んでいるかチェックします。
54        // このメソッドは、指定された文字列が含まれていれば true、そうでなければ false を返します。
55        if ($node->contains($searchString1)) {
56            echo "結果: 「{$searchString1}」はコメントに含まれています。\n";
57        } else {
58            echo "結果: 「{$searchString1}」はコメントに含まれていません。\n";
59        }
60
61        if ($node->contains($searchString2)) {
62            echo "結果: 「{$searchString2}」はコメントに含まれています。\n";
63        } else {
64            echo "結果: 「{$searchString2}」はコメントに含まれていません。\n";
65        }
66        echo "\n";
67    }
68}
69
70// ドキュメント内にコメントノードが一つも見つからなかった場合のメッセージ
71if ($commentNodes->length === 0) {
72    echo "ドキュメント内にコメントノードが見つかりませんでした。\n";
73}
74
75?>

PHP 8で導入されたDom\Comment::contains()メソッドは、HTMLやXMLドキュメント内のコメントノードの内容に、特定の文字列や別のノードのテキストが含まれているかを判定するための機能です。このメソッドは、コメントノードオブジェクトが持つテキストに対して検索を行い、その結果を真偽値（bool）で返します。

引数$dataには、コメントノード内に存在するかを調べたい文字列、またはテキスト内容を持つDom\Nodeオブジェクトを指定します。メソッドは、コメントノードのテキストがこの引数の内容を含んでいる場合、trueを戻り値として返し、含まれていない場合はfalseを返します。

サンプルコードでは、まずHTMLコンテンツからDOMDocumentを作成し、XPathを使ってドキュメント内のすべてのコメントノードを抽出しています。抽出された各コメントノードがDom\Commentのインスタンスであることを確認した後、contains()メソッドを用いて、定義済みの文字列（例えば「テストコメント」や「存在しない文字列」）がコメントノードの内容に含まれているかを確認しています。これにより、コメントの内容を詳細に解析する手間なく、特定のキーワードが含まれるコメントを効率的に識別できるため、動的なコンテンツ操作や特定の情報抽出が必要な場面で非常に役立ちます。

このサンプルコードはPHP 8以降の新しいDOM拡張におけるDom\Comment::contains()メソッドの利用法を示しています。最も重要な注意点は、このメソッドがPHP 8で導入されたDom\Commentクラスの機能であり、以前のバージョンや古いDOM拡張では利用できない点です。実行環境のPHPバージョンを確認してください。

contains()メソッドは引数に指定された文字列が大文字・小文字を区別して含まれるかどうかを判定します。部分一致で検索するため、意図しない文字列も含まれる可能性がある場合は、より厳密な正規表現などでの検証も検討すると良いでしょう。また、引数には文字列だけでなくDom\Nodeも指定可能ですが、その場合の挙動は文字列検索とは異なるため、リファレンスで詳細を確認してください。DOMDocumentやXPathを使ったDOM操作の基礎を理解することが、このコードを正しく活用するための鍵となります。