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

Copy
1<?php
2
3// CDATAセクション内で指定されたノードが含まれているかを確認するサンプル
4// PHP 8以降で使用可能
5
6// ドキュメントとCDATAセクションを作成
7$dom = new DOMDocument();
8$cdata = $dom->createCDATASection("This is a CDATA section.");
9$dom->appendChild($cdata);
10
11// 確認するノードを作成
12$textNode = $dom->createTextNode("is");
13
14// CDATAセクションにノードが含まれているか確認
15// contains() メソッドは、指定されたノードがCDATAセクションに含まれているかどうかを判断します。
16// PHP 8.0 以降、Dom\CDATASection クラスには contains() メソッドが追加されました。
17$containsNode = $cdata->contains($textNode);
18
19// 結果を出力
20if ($containsNode) {
21    echo "CDATAセクションはノードを含んでいます。\n";
22} else {
23    echo "CDATAセクションはノードを含んでいません。\n";
24}
25
26// 別のノードを作成してテスト（含まれていない場合）
27$anotherTextNode = $dom->createTextNode("not_contained");
28$notContainsNode = $cdata->contains($anotherTextNode);
29
30if ($notContainsNode) {
31    echo "CDATAセクションはノードを含んでいます。\n";
32} else {
33    echo "CDATAセクションはノードを含んでいません。\n";
34}
35?>

このサンプルコードは、PHP 8以降で使用可能なDom\CDATASectionクラスのcontainsメソッドの使い方を示しています。containsメソッドは、CDATAセクションが指定されたノードを含んでいるかどうかを判定します。

まず、DOMDocumentオブジェクトを作成し、その中にテキスト "This is a CDATA section." を持つCDATASectionオブジェクトを作成します。次に、createTextNodeメソッドを使用して確認するノード（ここでは "is" というテキストノード）を作成します。

$cdata->contains($textNode)のようにcontainsメソッドを呼び出すことで、CDATASectionオブジェクトが$textNodeを含んでいるかどうかを調べることができます。containsメソッドは引数にDom\Nodeオブジェクトを受け取り、戻り値はありません（厳密にはvoidを返します）。内部的には、指定されたノードがCDATAセクションに含まれているかどうかを評価し、結果に応じて後続の処理を分岐させます。サンプルコードでは、含まれている場合は「CDATAセクションはノードを含んでいます。」、含まれていない場合は「CDATAセクションはノードを含んでいません。」というメッセージを表示します。

さらに、別のノード（"not_contained"）を作成し、containsメソッドが正しく動作するかどうかをテストしています。これにより、ノードが含まれていない場合の動作も確認できます。このサンプルを通じて、Dom\CDATASectionクラスのcontainsメソッドの基本的な使い方を理解できます。

Copy
1<?php
2
3// CDATA セクションにノードが含まれているかどうかを確認する例
4
5// DOMDocument を作成
6$dom = new DOMDocument();
7
8// CDATA セクションを作成
9$cdata = $dom->createCDATASection("This is a CDATA section.");
10
11// テキストノードを作成
12$text = $dom->createTextNode("Some text");
13
14// CDATA セクションにテキストノードを追加 (DOMNode::appendChild() を使用)
15$cdata->appendChild($text);
16
17// contains() メソッドは、引数として指定されたノードが CDATASection ノードに含まれているかどうかを確認します。
18// このメソッドは PHP 8.3 以降で使用可能です。
19
20if (method_exists($cdata, 'contains')) {
21    // テキストノードが CDATA セクションに含まれているか確認
22    if ($cdata->contains($text)) {
23        echo "The text node is contained in the CDATA section.\n";
24    } else {
25        echo "The text node is not contained in the CDATA section.\n";
26    }
27
28    // 存在しないノードで確認
29    $anotherText = $dom->createTextNode("Another text");
30    if ($cdata->contains($anotherText)) {
31        echo "The anotherText node is contained in the CDATA section.\n";
32    } else {
33        echo "The anotherText node is not contained in the CDATA section.\n";
34    }
35} else {
36    echo "Dom\CDATASection::contains() is only available in PHP 8.3 or later.\n";
37}

このサンプルコードは、PHP 8.3以降で使用可能な Dom\CDATASection クラスの contains メソッドの使い方を示しています。contains メソッドは、CDATAセクションに指定されたノードが含まれているかどうかを確認するために使用します。引数には、Dom\Node オブジェクトまたは null を指定します。

まず、DOMDocument オブジェクトを作成し、createCDATASection メソッドで CDATA セクションを作成します。次に、テキストノードを作成し、appendChild メソッドを使用して CDATA セクションに追加します。

contains メソッドは、引数として渡されたノードが CDATA セクション内に存在する場合に true を返します。存在しない場合は false を返します。サンプルコードでは、まず CDATA セクションに追加したテキストノードが含まれているかを確認し、次に別のテキストノード（CDATAセクションに追加していないノード）が含まれているかを確認しています。

なお、contains メソッドが利用可能かどうかを method_exists 関数で確認することで、PHP 8.3 より前のバージョンでコードを実行した場合のエラーを回避しています。PHP 8.3未満の環境で実行した場合は、containsメソッドが利用できない旨のメッセージが表示されます。このメソッドを使用することで、DOMツリー内のノードの存在確認を効率的に行うことができます。