【PHP8.x】DOMComment::textContentプロパティの使い方

Copy
1<?php
2
3// DOMComment オブジェクトの textContent プロパティの利用例
4
5// DOMDocument オブジェクトを生成
6$dom = new DOMDocument();
7
8// コメントノードを生成
9$comment = $dom->createComment("This is a comment.");
10
11// textContent プロパティを使用してコメントの内容を取得
12$commentText = $comment->textContent;
13
14// 結果を出力
15echo $commentText . PHP_EOL; // Output: This is a comment.
16
17// コメントの内容を変更
18$comment->textContent = "This is a modified comment.";
19
20// textContent プロパティを使用して変更後のコメントの内容を取得
21$modifiedCommentText = $comment->textContent;
22
23// 変更後の結果を出力
24echo $modifiedCommentText . PHP_EOL; // Output: This is a modified comment.
25
26?>

PHPのDOMCommentクラスにおけるtextContentプロパティについて解説します。このプロパティは、コメントノードの内容を文字列として取得・設定するために使用します。

サンプルコードでは、まずDOMDocumentオブジェクトを生成し、次にcreateComment()メソッドでコメントノードを作成しています。DOMCommentオブジェクトのtextContentプロパティにアクセスすることで、コメントの内容を取得できます。取得した内容は文字列として変数に格納され、echo文で出力されます。

textContentプロパティは読み書き可能です。つまり、コメントの内容を後から変更することもできます。サンプルコードでは、textContentプロパティに新しい文字列を代入することで、コメントの内容を書き換えています。そして、再度textContentプロパティにアクセスすることで、変更後のコメント内容を取得し、出力しています。

textContentプロパティは引数を持ちません。また、戻り値は文字列型（string）で、コメントノードの内容を表します。コメントの内容を取得するだけでなく、内容を更新する際にも使用できる便利なプロパティです。 このプロパティを使用することで、DOMDocumentで扱うコメントノードのテキスト情報を簡単に操作できます。

Copy
1<?php
2
3/**
4 * このスクリプトは、DOMノードにおける `nodeValue` と `textContent` プロパティの違い、
5 * 特に `DOMComment` クラスにおける挙動をシステムエンジニアを目指す初心者向けに示します。
6 *
7 * - `nodeValue`: ノード自身の値を返します。DOMTextやDOMCommentノードではその内容を、
8 *                DOMElementノードでは通常nullを返します。
9 * - `textContent`: ノードとその全ての子孫ノードのテキストコンテンツを連結して返します。
10 *                  DOMTextやDOMCommentノードではその内容を、DOMElementノードでは
11 *                  内部の全てのテキストを結合して返します。
12 */
13function demonstrateNodeValueVsTextContent(): void
14{
15    // DOMDocumentオブジェクトを作成します
16    $dom = new DOMDocument('1.0', 'UTF-8');
17    $dom->formatOutput = true; // 出力を整形するために設定
18
19    // ルート要素を作成し、DOMに追加します
20    $root = $dom->createElement('root');
21    $dom->appendChild($root);
22
23    // 1. DOMText ノードを作成します
24    $textNode = $dom->createTextNode('This is some plain text directly inside root.');
25    $root->appendChild($textNode);
26
27    // 2. DOMComment ノードを作成します (リファレンス情報に指定されたクラス)
28    $commentNode = $dom->createComment('This is a comment example for DOMComment.');
29    $root->appendChild($commentNode);
30
31    // 3. 複数の子ノード（テキスト、別の要素、テキスト）を持つDOMElement ノードを作成します
32    $containerElement = $dom->createElement('container');
33    $containerElement->appendChild($dom->createTextNode('First part, '));
34    $spanElement = $dom->createElement('span', 'text inside span');
35    $containerElement->appendChild($spanElement);
36    $containerElement->appendChild($dom->createTextNode(', last part.'));
37    $root->appendChild($containerElement);
38
39    echo "--- 1. DOMComment ノードの検証 ---\n";
40    echo "  - DOMComment の nodeValue : \"" . $commentNode->nodeValue . "\"\n";
41    echo "  - DOMComment の textContent: \"" . $commentNode->textContent . "\"\n";
42    echo "  コメントノードの場合、nodeValue と textContent は同じ内容を返します。\n\n";
43
44    echo "--- 2. DOMText ノードの検証 ---\n";
45    echo "  - DOMText の nodeValue : \"" . $textNode->nodeValue . "\"\n";
46    echo "  - DOMText の textContent: \"" . $textNode->textContent . "\"\n";
47    echo "  テキストノードの場合も、nodeValue と textContent は同じ内容を返します。\n\n";
48
49    echo "--- 3. DOMElement (container) ノードの検証 ---\n";
50    echo "  - container の nodeValue : " . var_export($containerElement->nodeValue, true) . "\n";
51    echo "  - container の textContent: \"" . $containerElement->textContent . "\"\n";
52    echo "  要素ノードの場合、nodeValue は通常 null です。\n";
53    echo "  textContent は、その要素と全ての子孫ノードのテキストコンテンツを結合して返します。\n\n";
54
55    echo "--- 4. DOMElement (root) ノードの検証 ---\n";
56    echo "  - root の nodeValue : " . var_export($root->nodeValue, true) . "\n";
57    echo "  - root の textContent: \"" . $root->textContent . "\"\n";
58    echo "  ルート要素の場合も同様に、textContent が全ての子孫テキストを結合します。\n\n";
59
60    echo "【まとめ】\n";
61    echo " - DOMText や DOMComment のような葉ノードでは、`nodeValue` と `textContent` は同じ結果を返します。\n";
62    echo " - DOMElement のようなコンテナノードでは、`nodeValue` は `null` を返しますが、\n";
63    echo "   `textContent` は要素内部にある全てのテキストコンテンツを連結した文字列を返します。\n";
64}
65
66// 関数を実行してデモンストレーションを開始します
67demonstrateNodeValueVsTextContent();

DOMCommentクラスのtextContentプロパティは、コメントノードの内容を文字列として取得するために使用します。引数はなく、戻り値はコメントの内容を表す文字列です。このサンプルコードでは、DOMCommentノードを作成し、nodeValueプロパティとtextContentプロパティを比較しています。DOMCommentノードの場合、nodeValueとtextContentは同じ値を返します。これは、コメントノードのnodeValueがコメントの内容そのものを表すためです。一方、DOMElementノードでは、nodeValueは通常nullを返しますが、textContentはその要素の子孫ノードに含まれるすべてのテキストを連結した文字列を返します。textContentは、ノードの内容全体を取得したい場合に便利です。例えば、要素内に複数のテキストノードや他の要素が含まれている場合でも、それらすべてのテキストをまとめて取得できます。システムエンジニアを目指す初心者の方は、nodeValueとtextContentの違いを理解することで、DOM操作においてより柔軟なテキスト処理が可能になります。