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

Copy
1<?php
2
3/**
4 * DOMCharacterData::contains() の使用例
5 *
6 * 指定されたノードが、DOMCharacterDataノードに含まれているかどうかを確認します。
7 * この例では、テキストノード（DOMText）が、別のテキストノードに含まれているかをチェックしています。
8 * DOMCharacterData::contains() は、DOMText から継承されたメソッドです。
9 */
10
11$dom = new DOMDocument();
12$dom->loadXML('<root><text>Hello World</text></root>');
13
14$root = $dom->documentElement;
15$textNode = $root->firstChild; // DOMTextノードを取得
16
17// 別のテキストノードを作成
18$anotherTextNode = $dom->createTextNode('World');
19
20// $textNode が $anotherTextNode を含んでいるかチェック
21$contains = $textNode->contains($anotherTextNode);
22
23if ($contains) {
24    echo "The text node contains the other text node.\n";
25} else {
26    echo "The text node does not contain the other text node.\n"; // こちらが出力される
27}
28
29?>

PHP 8におけるDOMCharacterDataクラスのcontainsメソッドは、指定されたノードが現在のDOMCharacterDataノードに含まれているかどうかを判定します。DOMCharacterDataは、DOMTextやDOMCommentなどのクラスが継承している抽象クラスであり、これらのクラスのインスタンスに対してもcontainsメソッドを使用できます。

サンプルコードでは、まずXMLドキュメントをロードし、<text>要素のテキストノード（DOMTextオブジェクト）を取得しています。次に、createTextNodeメソッドを使用して、別のテキストノードを作成します。

containsメソッドは、DOMNode型の引数 $other を受け取ります。この引数には、包含関係を調べたいノードを指定します。

$textNode->contains($anotherTextNode) の部分で、最初のテキストノードが、後で作成した別のテキストノードを含んでいるかどうかをチェックしています。この例では、$anotherTextNodeは$textNodeの子ノードではないため、containsメソッドは false を返します。

containsメソッドの戻り値はboolean型で、包含関係がある場合はtrue、ない場合はfalseを返します。この結果に基づいて、条件分岐を行い、メッセージを出力します。サンプルコードを実行すると、「The text node does not contain the other text node.」というメッセージが表示されます。

Copy
1<?php
2
3// DOMCharacterData::contains() のサンプルコード
4
5// DOMDocumentの作成
6$dom = new DOMDocument();
7
8// テキストノードの作成
9$text = $dom->createTextNode("This is a sample text.");
10
11// 別のテキストノードの作成
12$searchText = $dom->createTextNode("sample");
13
14// DOMCharacterDataとしてテキストノードを扱う
15$characterData = $text;
16
17// contains() メソッドを使用して、searchText が characterData に含まれているか確認
18$contains = $characterData->contains($searchText);
19
20// 結果を出力
21if ($contains) {
22    echo "The text node contains the specified node.\n";
23} else {
24    echo "The text node does not contain the specified node.\n";
25}
26
27?>

このサンプルコードは、PHPのDOM拡張に含まれるDOMCharacterDataクラスのcontains()メソッドの使い方を示しています。contains()メソッドは、PHP 8 で導入された比較的新しいメソッドです。

DOMCharacterDataは、テキストノードやコメントノードなど、文字データを持つノードを扱うためのクラスです。このコードでは、まずDOMDocumentオブジェクトを作成し、createTextNode()メソッドを使ってテキストノードを2つ作成しています。一つは$text、もう一つは$searchTextに格納されます。

$textをDOMCharacterDataとして扱い、contains()メソッドを呼び出します。contains()メソッドは、引数にDOMNodeオブジェクトを受け取り、DOMCharacterDataオブジェクト（ここでは$text）が、引数として渡されたノード（ここでは$searchText）を含んでいるかどうかを調べます。

contains()メソッドは、bool型の値を返します。引数として渡されたノードがDOMCharacterDataオブジェクトに含まれている場合はtrue、そうでない場合はfalseを返します。

サンプルコードでは、contains()メソッドの実行結果に応じて、指定されたノードが含まれているかどうかをメッセージとして出力します。この例では $searchText が $text の一部であるため、「The text node contains the specified node.」と表示されます。