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

Copy
1<?php
2
3// Dom\Document クラスを使用して新しいDOMドキュメントを作成します。
4// これはHTMLやXMLのような構造化された文書をプログラムで操作するための基盤となります。
5$dom = new Dom\Document();
6
7// ドキュメントにHTMLのボディ要素を追加します。
8// まずは'body'という名前の要素を作成し、それをドキュメントのルートにappendChildで追加します。
9$body = $dom->createElement('body');
10$dom->appendChild($body);
11
12// ボディ要素内に段落要素（<p>）を作成し、追加します。
13$paragraph = $dom->createElement('p');
14$body->appendChild($paragraph);
15
16// 段落要素内にテキストノードを作成し、追加します。
17// 'Hello, PHP DOM!'という文字列がこのテキストノードの内容になります。
18// Dom\Text は Dom\CharacterData クラスを継承しており、textContent プロパティを持ちます。
19$textNode = $dom->createTextNode('Hello, PHP DOM!');
20$paragraph->appendChild($textNode);
21
22// Dom\CharacterData を継承するノード（この場合は $textNode）の textContent プロパティを読み取ります。
23// textContent はノードのテキスト内容を文字列として取得します。
24echo "初期のテキスト内容: " . $textNode->textContent . "\n";
25
26// Dom\CharacterData を継承するノードの textContent プロパティを更新します。
27// textContent に新しい文字列を代入することで、ノードのテキスト内容を変更できます。
28$textNode->textContent = 'Updated text by textContent property.';
29
30// 更新後のテキスト内容を確認します。
31echo "更新後のテキスト内容: " . $textNode->textContent . "\n";
32
33// 必要に応じて、ドキュメント全体のHTML出力を確認することもできます。
34// echo "\n生成されたHTML:\n";
35// echo $dom->saveHTML();
36
37?>

PHP 8におけるDom\CharacterDataクラスのtextContentプロパティは、HTMLやXMLドキュメント内でテキスト情報を扱う際に非常に便利な機能です。このプロパティは、ノードが持つテキスト内容を読み取ったり、新しいテキスト内容に更新したりするために使用されます。

サンプルコードでは、まずDom\Documentを作成し、その中にbody、p要素、そしてDom\Textクラスのインスタンスであるテキストノードを作成しています。Dom\TextはDom\CharacterDataクラスを継承しているため、textContentプロパティを利用できます。

初期のテキスト内容を取得する際には、$textNode->textContentのようにプロパティにアクセスするだけで、現在のテキスト内容を文字列として読み取ることができます。このプロパティは引数を取らず、常にノードのテキストデータを文字列型で返します。

また、ノードのテキスト内容を更新したい場合も同様に、$textNode->textContent = '新しいテキスト';のように文字列を代入するだけで簡単に変更が可能です。これにより、ドキュメント内のテキストコンテンツをプログラムから動的に操作できます。textContentはDOM要素が保持するテキストコンテンツへの直接的で簡潔なアクセス手段を提供し、システムエンジニアがWebページのコンテンツを生成・変更する際に頻繁に利用されます。

Copy
1<?php
2
3/**
4 * Demonstrates the difference between DOMNode::nodeValue and DOMNode::textContent.
5 *
6 * This function illustrates how textContent aggregates text from an element's
7 * descendants, while nodeValue has specific meanings depending on the node type
8 * (e.g., null for elements, actual text for text and comment nodes).
9 * It also shows the behavior of textContent for Dom\CharacterData descendants
10 * like Dom\Text and Dom\Comment nodes.
11 */
12function compareDomNodeValues(): void
13{
14    $dom = new DOMDocument('1.0', 'UTF-8');
15    $dom->formatOutput = true; // Enables pretty-printing for generated HTML
16
17    // Create an HTML structure with nested elements and text nodes
18    $root = $dom->createElement('div');
19    $root->setAttribute('id', 'exampleContainer');
20    $dom->appendChild($root);
21
22    $p = $dom->createElement('p');
23    $root->appendChild($p);
24
25    $p->appendChild($dom->createTextNode('This is '));
26    $span = $dom->createElement('span', 'some ');
27    $p->appendChild($span);
28    $strong = $dom->createElement('strong', 'important');
29    $span->appendChild($strong);
30    $p->appendChild($dom->createTextNode(' information.'));
31
32    // Create a comment node (a type of Dom\CharacterData)
33    $commentNode = $dom->createComment(' This is a hidden comment. ');
34    $root->appendChild($commentNode);
35
36    echo "--- Generated DOM Structure ---\n";
37    echo $dom->saveHTML() . "\n";
38    echo "-------------------------------\n\n";
39
40    // 1. Analyze an Element Node (e.g., <p>)
41    $paragraphElement = $dom->getElementsByTagName('p')->item(0);
42    if ($paragraphElement !== null) {
43        echo "Analyzing an Element Node (<p>):\n";
44        echo "  nodeName: " . $paragraphElement->nodeName . "\n";
45        // For element nodes, nodeValue is typically null
46        echo "  nodeValue: " . var_export($paragraphElement->nodeValue, true) . "\n";
47        // textContent aggregates text from all descendant text nodes
48        echo "  textContent: '" . $paragraphElement->textContent . "'\n\n";
49    }
50
51    // 2. Analyze a Text Node (which extends Dom\CharacterData)
52    // We'll get the first direct text node child of the paragraph ("This is ")
53    $textNode = null;
54    foreach ($paragraphElement->childNodes as $child) {
55        if ($child->nodeType === XML_TEXT_NODE) {
56            $textNode = $child;
57            break;
58        }
59    }
60
61    if ($textNode !== null) {
62        echo "Analyzing a Text Node ('" . $textNode->nodeValue . "'):\n";
63        echo "  nodeName: " . $textNode->nodeName . " (representing #text)\n";
64        // For text nodes, nodeValue holds the actual text content
65        echo "  nodeValue: '" . $textNode->nodeValue . "'\n";
66        // For text nodes (Dom\CharacterData), textContent is identical to nodeValue
67        echo "  textContent: '" . $textNode->textContent . "'\n\n";
68    }
69
70    // 3. Analyze a Comment Node (also extends Dom\CharacterData)
71    if ($commentNode !== null) {
72        echo "Analyzing a Comment Node ('" . $commentNode->nodeValue . "'):\n";
73        echo "  nodeName: " . $commentNode->nodeName . " (representing #comment)\n";
74        // For comment nodes, nodeValue holds the comment's text
75        echo "  nodeValue: '" . $commentNode->nodeValue . "'\n";
76        // For comment nodes (Dom\CharacterData), textContent is identical to nodeValue
77        echo "  textContent: '" . $commentNode->textContent . "'\n\n";
78    }
79}
80
81// Execute the demonstration function
82compareDomNodeValues();

PHP 8のDom\CharacterDataクラスに属するtextContentは、ノードのテキストコンテンツを文字列として取得するためのプロパティです。引数はなく、常に文字列を返します。

このプロパティの挙動は、同じくノードの値を取得するDOMNode::nodeValueと比較するとよく理解できます。

まず、HTML要素のような「要素ノード」の場合、textContentはその要素自身と、その子孫ノードに含まれるすべてのテキストコンテンツを連結して取得します。例えば、<p>This is <span>some</span> text.</p>のような要素に対してtextContentを使うと、「This is some text.」という文字列が得られます。一方、要素ノードのnodeValueは通常nullを返します。

次に、Dom\CharacterDataを継承する「テキストノード」や「コメントノード」の場合です。これらのノードは、それ自体がテキスト情報を持っているため、textContentとnodeValueはどちらもノードが保持する実際のテキスト内容を返します。例えば、<!-- This is a comment. -->というコメントノードであれば、textContentもnodeValueも「This is a comment.」という文字列を返します。同様に、単一のテキストノード「Hello」に対しては、両方とも「Hello」を返します。

このように、textContentは子孫ノードのテキストをまとめて取得したい場合に便利で、nodeValueはノードの種類によってその意味する値が異なるという違いがあります。