【PHP8.x】textContentプロパティの使い方
textContentプロパティの使い方について、初心者にもわかりやすく解説します。
基本的な使い方
textContentプロパティは、Dom\DocumentTypeクラスに属し、ノードとその子孫のテキストコンテンツを保持するプロパティです。PHPのDOM拡張機能において、Dom\DocumentTypeクラスは、HTMLやXMLドキュメントの冒頭に記述されるDOCTYPE宣言を表します。例えば、ウェブページでよく見かける「<!DOCTYPE html>」といった宣言がこれに該当します。このDOCTYPE宣言は、ドキュメントがどのような種類であるか、またはどのようなDTD（Document Type Definition）を使用するかを指定するために存在します。
しかし、このDOCTYPE宣言は、通常のHTML要素やXML要素のように、内部にテキストコンテンツを持つことを意図していません。DOCTYPE宣言はそれ自体が特別な宣言文であり、その中身がテキストとして取得されることはありません。そのため、Dom\DocumentTypeオブジェクトのtextContentプロパティにアクセスしても、結果として常に空の文字列が返されます。
この挙動は、W3C（World Wide Web Consortium）によって定められたDOM（Document Object Model）の標準仕様に基づいています。Dom\DocumentType::textContentプロパティは、DOCTYPEノードの具体的なテキスト内容を取得する用途では利用されません。DOCTYPE宣言に関する情報を取得したい場合は、代わりにname、publicId、systemIdといったDom\DocumentTypeクラスが提供する他のプロパティを使用してください。これらのプロパティは、DOCTYPE宣言が持つそれぞれの役割に応じた情報を提供します。
構文(syntax)
1<?php 2$dom = new DOM\Document(); 3$dom->loadXML('<!DOCTYPE html>'); 4$documentType = $dom->doctype; 5$textContent = $documentType->textContent;
引数(parameters)
引数なし
引数はありません
戻り値(return)
?string
Dom\DocumentType クラスの textContent プロパティは、このドキュメントタイプのテキストコンテンツを表す文字列、またはコンテンツがない場合は null を返します。
サンプルコード
PHP DOM DocumentType::textContent 取得
1<?php 2 3/** 4 * Dom\DocumentType::textContent プロパティの使用方法を示すサンプルコード。 5 * 6 * この関数は、HTMLドキュメントのDOCTYPE宣言を表現する 7 * Dom\DocumentType オブジェクトを作成し、その textContent プロパティの値を表示します。 8 * DOCTYPE宣言自体は通常テキスト内容を持たないため、textContent は 9 * 空文字列または null になることを示します。 10 */ 11function demonstrateDocumentTypeTextContent(): void 12{ 13 // 1. 新しいDOMドキュメントを作成します。 14 // これはHTMLやXMLドキュメントをプログラムで操作するための基盤となります。 15 $dom = new Dom\Document(); 16 17 // 2. HTML5のDOCTYPE宣言に相当する Dom\DocumentType オブジェクトを作成します。 18 // 例: <!DOCTYPE html> 19 // createDocumentType('name', 'publicId', 'systemId') の形式で指定します。 20 // HTML5のDOCTYPEには publicId も systemId もありません。 21 $html5DocType = $dom->implementation->createDocumentType('html', '', ''); 22 23 // 3. 作成したDOCTYPEノードをドキュメントに追加します。 24 // これはドキュメントの最初のノードとして配置されます。 25 $dom->appendChild($html5DocType); 26 27 // 4. ドキュメントから Dom\DocumentType オブジェクトを取得します。 28 // Dom\Document::$doctype プロパティを使用すると、簡単にDOCTYPEノードにアクセスできます。 29 $documentTypeNode = $dom->doctype; 30 31 // 5. DOCTYPEノードが正常に取得できたかを確認します。 32 if ($documentTypeNode instanceof Dom\DocumentType) { 33 echo "--- DOCTYPEノード情報 ---\n"; 34 35 // textContent プロパティは、ノードとその子孫のテキスト内容を返します。 36 // DOCTYPEノードは、要素のように内部にテキストを持たないため、 37 // textContent は通常、空文字列または null になります。 38 $textContent = $documentTypeNode->textContent; 39 40 echo " textContent: "; 41 if ($textContent === null) { 42 echo "(null)\n"; 43 } elseif ($textContent === '') { 44 echo "(空文字列)\n"; 45 } else { 46 echo "'" . $textContent . "'\n"; 47 } 48 49 // 参考情報として、DOCTYPEノードの他のプロパティも表示します。 50 // name: DOCTYPE宣言のルート要素名 (例: "html") 51 // publicId: 公開識別子 52 // systemId: システム識別子 53 echo " name: '" . $documentTypeNode->name . "'\n"; 54 echo " publicId: '" . ($documentTypeNode->publicId === '' ? '(空文字列)' : $documentTypeNode->publicId) . "'\n"; 55 echo " systemId: '" . ($documentTypeNode->systemId === '' ? '(空文字列)' : $documentTypeNode->systemId) . "'\n"; 56 57 echo "\n補足: Dom\\DocumentType の textContent は、" 58 . "DOCTYPE宣言自体がテキストコンテンツを持たないため、\n" 59 . "通常は空文字列または null となります。\n"; 60 61 } else { 62 echo "エラー: Dom\\DocumentType ノードが見つかりませんでした。\n"; 63 } 64} 65 66// 関数を実行します。 67demonstrateDocumentTypeTextContent(); 68 69?>
Dom\DocumentType::textContent プロパティは、PHPのDOM拡張機能において、特定のノードとその子孫ノードのテキスト内容を取得するために使用されます。このプロパティは引数を取らず、戻り値として文字列（string）または null を返します。
Dom\DocumentType クラスは、HTMLやXMLドキュメントのDOCTYPE宣言（例: <!DOCTYPE html>）を表すノードです。DOCTYPE宣言自体は、要素のように内部に具体的なテキストコンテンツを持つ構造ではないため、その textContent プロパティは特殊な挙動を示します。具体的には、このプロパティにアクセスしても、通常は空文字列 '' または null が返されます。これは、DOCTYPEノードが他のノードタイプ（例えばテキストノードや要素ノード）のようにテキストデータを持たないことに起因します。
提供されたサンプルコードでは、Dom\Document オブジェクトを作成し、HTML5のDOCTYPE宣言を表す Dom\DocumentType ノードを生成してドキュメントに追加しています。その後、この Dom\DocumentType ノードから textContent プロパティの値を取得し、それが通常は空文字列か null になることを確認・表示しています。このように、textContent プロパティは、ノードの種類によって期待される戻り値が異なるため、その特性を理解しておくことが重要です。
Dom\DocumentType::textContentは、DOCTYPE宣言自体がテキストコンテンツを持たない特性から、通常は空文字列またはnullを返します。そのため、このプロパティから具体的な文字列内容を期待すると、意図しない結果となる可能性がありますので注意が必要です。戻り値の型が?stringであるため、常にnullが返される可能性を考慮し、適切にハンドリングするコードを記述することが重要です。DOCTYPEノードの主な情報は、name、publicId、systemIdといった他のプロパティで取得するようにしてください。
PHP DOM: textContent と nodeValue 比較
1<?php 2 3declare(strict_types=1); 4 5/** 6 * DOMノードのtextContentとnodeValueプロパティの動作を比較し、 7 * システムエンジニアを目指す初心者向けにその違いを説明します。 8 * 9 * textContentは要素とその子孫すべてのテキスト内容を結合して返しますが、 10 * 要素タグやコメントなどは除外されます。 11 * nodeValueは特定のノードタイプ（テキスト、コメント、CDATAなど）の直接の値を返します。 12 * 要素ノードやドキュメントノードでは通常nullです。 13 */ 14function demonstrateNodePropertiesComparison(): void 15{ 16 // 1. Dom\Document オブジェクトを作成 17 $dom = new Dom\Document(); 18 19 // 2. サンプルHTMLをロード 20 // <!DOCTYPE html>を含め、様々なノードタイプを持つHTML構造を準備します。 21 $html = <<<HTML 22<!DOCTYPE html> 23<html> 24<head> 25 <title>DOMプロパティのデモンストレーション</title> 26</head> 27<body> 28 <div id="container"> 29 <!-- これはコメントノードです --> 30 <p>これは <b>重要な</b> テキストです。</p> 31 <span> 32 別のテキスト 33 <![CDATA[<script>alert("Hello!");</script>]]> 34 </span> 35 </div> 36</body> 37</html> 38HTML; 39 40 // loadHTMLにLIBXML_HTML_NOIMPLIEDとLIBXML_HTML_NODEFDTDを渡し、 41 // HTMLパーサーが自動的に<body>や<head>を追加したり、デフォルトのDTDを設定したりするのを防ぎます。 42 // これにより、元のDOCTYPE宣言がより忠実に保持されます。 43 @$dom->loadHTML($html, LIBXML_HTML_NOIMPLIED | LIBXML_HTML_NODEFDTD); 44 45 echo "--- textContent と nodeValue の比較 ---\n\n"; 46 47 // 3. Dom\DocumentType の検証 48 // Dom\DocumentType::textContent はPHP 8のリファレンスで定義されていますが、 49 // 通常はnullまたは空文字列になります。nodeValueも同様です。 50 $documentType = $dom->doctype; 51 if ($documentType instanceof Dom\DocumentType) { 52 echo "### 1. ドキュメントタイプノード (Dom\\DocumentType) ###\n"; 53 echo " nodeName: " . $documentType->nodeName . "\n"; // 例: 'DOCTYPE' 54 echo " nodeValue: " . var_export($documentType->nodeValue, true) . "\n"; // 通常はnull 55 echo " textContent: " . var_export($documentType->textContent, true) . "\n\n"; // 通常はnull 56 } 57 58 // 4. Dom\Element (要素ノード) の検証 59 // 要素ノードのnodeValueは常にnullです。textContentは子孫ノードすべてのテキストを結合して返します。 60 $containerElement = $dom->getElementById('container'); 61 if ($containerElement instanceof Dom\Element) { 62 echo "### 2. 要素ノード (Dom\\Element - id='container') ###\n"; 63 echo " nodeName: " . $containerElement->nodeName . "\n"; // 例: 'div' 64 echo " nodeValue: " . var_export($containerElement->nodeValue, true) . "\n"; // 要素ノードなのでnull 65 echo " textContent:\n\"" . trim($containerElement->textContent) . "\"\n\n"; // 子孫ノードの結合されたテキスト 66 } 67 68 // 5. Dom\Text (テキストノード) の検証 69 // テキストノードのtextContentとnodeValueは同じ値（ノードのテキスト内容）です。 70 // <p>要素内の最初のテキストノードを取得します ('これは ')。 71 $paragraph = $dom->getElementsByTagName('p')->item(0); 72 if ($paragraph instanceof Dom\Element) { 73 foreach ($paragraph->childNodes as $childNode) { 74 if ($childNode instanceof Dom\Text) { 75 echo "### 3. テキストノード (Dom\\Text - 例: 'これは ') ###\n"; 76 echo " nodeName: " . $childNode->nodeName . "\n"; // #text 77 echo " nodeValue: \"" . $childNode->nodeValue . "\"\n"; 78 echo " textContent: \"" . $childNode->textContent . "\"\n\n"; 79 break; // 最初のテキストノードで十分 80 } 81 } 82 } 83 84 // 6. Dom\Comment (コメントノード) の検証 85 // コメントノードのnodeValueはコメントの内容です。textContentはnullです。 86 $xpath = new Dom\XPath($dom); 87 $commentNode = $xpath->query('//comment()')->item(0); // ドキュメント内の最初のコメントノードを取得 88 if ($commentNode instanceof Dom\Comment) { 89 echo "### 4. コメントノード (Dom\\Comment) ###\n"; 90 echo " nodeName: " . $commentNode->nodeName . "\n"; // #comment 91 echo " nodeValue: \"" . $commentNode->nodeValue . "\"\n"; // コメントの内容 92 echo " textContent: " . var_export($commentNode->textContent, true) . "\n\n"; // コメントはtextContentを持たないためnull 93 } 94 95 // 7. Dom\CdataSection (CDATAセクションノード) の検証 96 // CDATAセクションノードのtextContentとnodeValueは同じ値（CDATAの内容）です。 97 $cdataNode = null; 98 $spanElement = $dom->getElementsByTagName('span')->item(0); 99 if ($spanElement instanceof Dom\Element) { 100 foreach ($spanElement->childNodes as $childNode) { 101 if ($childNode instanceof Dom\CdataSection) { 102 $cdataNode = $childNode; 103 break; 104 } 105 } 106 } 107 if ($cdataNode instanceof Dom\CdataSection) { 108 echo "### 5. CDATAセクションノード (Dom\\CdataSection) ###\n"; 109 echo " nodeName: " . $cdataNode->nodeName . "\n"; // #cdata-section 110 echo " nodeValue: \"" . $cdataNode->nodeValue . "\"\n"; // CDATAの内容 111 echo " textContent: \"" . $cdataNode->textContent . "\"\n\n"; // CDATAの内容 112 } 113 114 echo "--- まとめ ---\n"; 115 echo "textContent:\n"; 116 echo " - 要素とその子孫すべてのテキスト内容を結合して返します。\n"; 117 echo " - 要素タグ、コメント、処理命令は無視されます。\n"; 118 echo " - Dom\\DocumentType の場合は通常 null または空文字列です。\n"; 119 echo "nodeValue:\n"; 120 echo " - 特定のノードタイプ（テキスト、コメント、CDATA）の直接の値を返します。\n"; 121 echo " - 要素ノードやドキュメントノード、Dom\\DocumentType では通常 null です。\n"; 122} 123 124// 関数を実行してデモンストレーションを開始します 125demonstrateNodePropertiesComparison();
PHP 8のDom\DocumentTypeクラスが持つtextContentプロパティは、DOMノードのテキスト内容を取得するために使用されます。このプロパティは引数を取らず、戻り値としてnullまたは文字列を返します。
Dom\DocumentTypeノードにtextContentを適用すると、通常はnullまたは空文字列が返されます。これは、DocumentType自体が要素やその子孫のように具体的なテキストコンテンツを持たないためです。
似たプロパティにnodeValueがありますが、Dom\DocumentTypeノードの場合、こちらも通常はnullを返します。一般的にtextContentは、要素ノードとそのすべての子孫ノードのテキスト内容を結合して取得する際に用いられ、タグやコメントなどは無視されます。一方、nodeValueはテキストノード、コメントノード、CDATAセクションノードなど、特定のノードタイプが持つ直接的な値を返します。要素ノードやDom\DocumentTypeノードでは通常nullとなります。したがって、Dom\DocumentTypeにおいてはtextContentもnodeValueも、ノードの種類から想定されるように、同様にnullまたは空文字列を返すことが多いと理解してください。
Dom\DocumentTypeを含むDOMノードのtextContentとnodeValueプロパティは、ノードの種類によってその振る舞いが大きく異なります。初心者はこの違いを混同しやすいため注意が必要です。例えば、Dom\DocumentTypeや要素ノードではnodeValueは通常nullを返し、textContentもDom\DocumentTypeではnullまたは空文字列となることが多いです。要素とその子孫全てのテキスト内容を取得したい場合はtextContentを、特定のノード（テキスト、コメント、CDATA）の直接の値を厳密に取得したい場合はnodeValueを使用してください。また、HTMLをロードする際にloadHTML関数のオプションを適切に指定しないと、意図しないDOM構造になることがあります。戻り値の型が?stringと定義されていてもnullが返される可能性があるため、常にnullチェックを行うなど、結果の型を意識した安全なコード記述を心がけましょう。