【PHP8.x】Dom\CharacterData::previousSiblingプロパティの使い方
previousSiblingプロパティの使い方について、初心者にもわかりやすく解説します。
基本的な使い方
previousSiblingプロパティは、DOM (Document Object Model) において、現在のノードの直前の兄弟ノードを表す読み取り専用のプロパティです。Dom\CharacterData クラスに属し、CharacterData オブジェクト（例えば、テキストノード）の直前の兄弟ノードを取得するために使用されます。
このプロパティは、現在のノードの兄弟ノードが存在しない場合、または現在のノードが最初の兄弟ノードである場合には null を返します。兄弟ノードとは、同じ親ノードを持つノードのことです。
previousSibling プロパティを使用することで、DOMツリー内を移動し、特定ノードの前にあるノードを効率的に取得することができます。これは、例えば、テキストノードの直前にある要素ノードの属性を調べたり、コンテンツの構造を解析したりする場合に役立ちます。
このプロパティは読み取り専用であるため、値を変更することはできません。ノードの順序を変更するには、DOM操作（例えば、insertBefore メソッドや appendChild メソッド）を使用する必要があります。previousSiblingプロパティは、DOMツリーの構造をプログラム的に解析し、操作するための重要な手段となります。システムエンジニアがDOMを操作する際に、ノード間の関係性を把握し、適切な処理を行う上で、このプロパティの理解は不可欠です。
構文(syntax)
1<?php 2 3$html = '<p>First Text<b>Bold Text</b></p>'; 4$doc = new DOMDocument(); 5$doc->loadHTML($html, LIBXML_HTML_NOIMPLIED | LIBXML_HTML_NODEFDTD); 6 7// <b> 要素を取得 8$boldElement = $doc->getElementsByTagName('b')->item(0); 9 10// <b> 要素の直前の兄弟ノード (DOMCharacterData を継承した DOMText) を取得 11$previousNode = $boldElement->previousSibling; 12 13// 取得したノードが存在する場合、その内容を出力 14if ($previousNode !== null) { 15 // "First Text" と出力されます 16 echo $previousNode->nodeValue; 17} 18 19?>
引数(parameters)
引数なし
引数はありません
戻り値(return)
DOMNode|null
このプロパティは、現在のDOMCharacterDataノードの直前の兄弟ノードであるDOMNodeオブジェクト、または兄弟ノードが存在しない場合はnullを返します。
サンプルコード
PHP DOM: previousSiblingで前の兄弟ノードを取得する
1<?php 2 3/** 4 * Dom\CharacterData::previousSibling プロパティの使用例を示します。 5 * 6 * この関数は、DOMツリー内で特定のテキストノードを見つけ、 7 * その直前の兄弟ノード (previousSibling) を取得し、その情報を表示します。 8 * previousSibling は DOMNode または null を返します。 9 * 10 * システムエンジニアを目指す初心者の方にも分かりやすいように、 11 * PHP 8 の機能と推奨コーディングスタイルに従っています。 12 */ 13function demonstrateDomCharacterDataPreviousSibling(): void 14{ 15 // DOMDocument オブジェクトを作成します。 16 $dom = new DOMDocument(); 17 // 整形された出力を行うように設定します。 18 $dom->formatOutput = true; 19 20 // テスト用のHTML文字列を読み込みます。 21 // loadHTML はHTMLとして解析するため、要素の後にテキストノードが配置されます。 22 // この例では、<p>要素の後にコメントノード、その後にテキストノードを配置します。 23 $htmlString = ' 24 <html> 25 <body> 26 <div> 27 <p>これは、対象ノードの前の要素です。</p> 28 <!-- これは、対象ノードの前のコメントです。 --> 29 これは対象となるテキストノードです。 30 </div> 31 </body> 32 </html>'; 33 // HTMLを読み込みます。HTMLエラーが出ても処理を継続できるように @ を付けています。 34 // (通常はエラーハンドリングを適切に行うべきですが、ここでは簡略化のため) 35 @$dom->loadHTML($htmlString); 36 37 // XPath を使用して、特定のテキストノードを検索します。 38 $xpath = new DOMXPath($dom); 39 // 「これは対象となるテキストノードです。」という文字列を含むテキストノードを見つけます。 40 $targetNodes = $xpath->query("//text()[contains(., 'これは対象となるテキストノードです。')]"); 41 42 if ($targetNodes->length > 0) { 43 /** 44 * 検索結果の最初のノードを対象とします。 45 * DOMText クラスは Dom\CharacterData クラスを継承しています。 46 * @var DOMText $targetNode 47 */ 48 $targetNode = $targetNodes->item(0); 49 50 echo "--- 現在の対象ノードの情報 ---\n"; 51 echo "ノードタイプ: ", getDomNodeTypeLabel($targetNode->nodeType), "\n"; 52 echo "ノードデータ: '", $targetNode->data, "'\n\n"; 53 54 // Dom\CharacterData::previousSibling プロパティにアクセスします。 55 // このプロパティは、現在のノードの直前の兄弟ノードを返します。 56 // 直前の兄弟ノードがない場合は null を返します。 57 $previousSiblingNode = $targetNode->previousSibling; 58 59 if ($previousSiblingNode instanceof DOMNode) { 60 echo "--- previousSibling (前の兄弟ノード) の情報 ---\n"; 61 echo "ノード名: ", $previousSiblingNode->nodeName, "\n"; 62 echo "ノードタイプ: ", getDomNodeTypeLabel($previousSiblingNode->nodeType), "\n"; 63 64 // ノードの具体的なタイプに応じて、追加情報を表示します。 65 if ($previousSiblingNode instanceof DOMElement) { 66 echo "タグ名: ", $previousSiblingNode->tagName, "\n"; 67 // 要素ノードのHTML表現の一部を表示 68 echo "HTML (抜粋): ", substr($dom->saveHTML($previousSiblingNode), 0, 80), "...\n"; 69 } elseif ($previousSiblingNode instanceof DOMCharacterData) { // DOMText, DOMComment, DOMCdataSection など 70 echo "ノードデータ: '", $previousSiblingNode->data, "'\n"; 71 } else { 72 // その他のノードタイプの場合、汎用的なノード値を表示 73 echo "ノード値: '", $previousSiblingNode->nodeValue, "'\n"; 74 } 75 } else { 76 echo "対象ノードには前の兄弟ノード (previousSibling) がありませんでした。\n"; 77 } 78 } else { 79 echo "指定されたテキストノードが見つかりませんでした。HTML構造を確認してください。\n"; 80 } 81} 82 83/** 84 * DOMノードタイプを表す整数値を、人間が読める文字列に変換するヘルパー関数です。 85 * @param int $nodeType DOMノードタイプを表すXML定数 (XML_ELEMENT_NODE など) 86 * @return string ノードタイプの説明文字列 87 */ 88function getDomNodeTypeLabel(int $nodeType): string 89{ 90 return match ($nodeType) { 91 XML_ELEMENT_NODE => '要素ノード', 92 XML_ATTRIBUTE_NODE => '属性ノード', 93 XML_TEXT_NODE => 'テキストノード', 94 XML_CDATA_SECTION_NODE => 'CDATAセクションノード', 95 XML_ENTITY_REF_NODE => '実体参照ノード', 96 XML_ENTITY_NODE => '実体ノード', 97 XML_PI_NODE => '処理命令ノード', 98 XML_COMMENT_NODE => 'コメントノード', 99 XML_DOCUMENT_NODE => '文書ノード', 100 XML_DOCUMENT_TYPE_NODE => '文書型ノード', 101 XML_DOCUMENT_FRAG_NODE => '文書フラグメントノード', 102 XML_NOTATION_NODE => '記法ノード', 103 XML_HTML_DOCUMENT_NODE => 'HTML文書ノード', 104 XML_DTD_NODE => 'DTDノード', 105 XML_ELEMENT_DECL_NODE => '要素宣言ノード', 106 XML_ATTRIBUTE_DECL_NODE => '属性宣言ノード', 107 XML_ENTITY_DECL_NODE => '実体宣言ノード', 108 XML_NAMESPACE_DECL_NODE => '名前空間宣言ノード', 109 default => '不明なノード', 110 }; 111} 112 113// サンプルコードを実行します。 114demonstrateDomCharacterDataPreviousSibling(); 115
PHP 8のDom\CharacterData::previousSiblingプロパティは、XMLやHTML文書の構造（DOMツリー）をプログラムで操作する際に、現在のノードの直前に位置する兄弟ノードを取得するために使用されます。Dom\CharacterDataクラスは、テキストノードやコメントノードのように文字データを保持するノードの基底クラスです。このプロパティは引数を取らず、直前の兄弟ノードが存在すればDOMNodeオブジェクトを、存在しない場合はnullを戻り値として返します。
提供されたサンプルコードでは、まずHTML文書を読み込み、XPathを使って「これは対象となるテキストノードです。」という特定のテキストノードを検索しています。このテキストノードはDOMTextクラスのインスタンスであり、Dom\CharacterDataを継承しています。次に、このテキストノードのpreviousSiblingプロパティにアクセスすることで、DOMツリー上でそのテキストノードのすぐ前にある兄弟ノードを取得しています。コードは取得した兄弟ノードの種類（この例ではコメントノード）や内容を表示し、DOMツリーにおけるノード間の隣接関係をプログラムで確認する方法を示しています。このプロパティは、文書構造を解析し、特定のノードに関連する情報を抽出する際に非常に役立ちます。
Dom\CharacterData::previousSiblingプロパティは、現在のノードの直前の兄弟ノードを返しますが、直前の兄弟ノードが存在しない場合はnullを返します。そのため、取得した結果がnullでないかを常にif ($node instanceof DOMNode)などで確認し、存在しないプロパティへのアクセスを防ぐことが重要です。
HTMLを解析する際、タグ間の改行やインデントなども空白のテキストノードとしてDOMツリーに構築されることがあります。previousSiblingが、このような意図しない空白ノードを返す可能性も考慮し、取得したノードのnodeTypeやnodeValueをチェックして、必要なノードであるか判断するようにしてください。
サンプルコードではエラー抑制を使っていますが、実運用ではloadHTMLなどのDOM操作時に発生しうるエラーを適切に処理するエラーハンドリングの実装が不可欠です。また、PHPのDOM操作においてprevious()という直接の関数は提供されていませんので、兄弟ノードの取得にはpreviousSiblingプロパティを利用します。
PHP: Dom\CharacterData::previousSiblingで直前の兄弟ノードを取得する
1<?php 2 3/** 4 * Dom\CharacterData::previousSibling プロパティの使用例を示します。 5 * 6 * この関数は、DOMツリーを作成し、テキストノードとコメントノードの 7 * previousSibling (直前の兄弟ノード) を取得する方法を実演します。 8 * Dom\CharacterData は Dom\Text や Dom\Comment の基底クラスです。 9 */ 10function demonstratePreviousSibling(): void 11{ 12 // 新しいDOMドキュメントを作成し、HTMLとしてフォーマット設定 13 $dom = new DOMDocument(); 14 $dom->formatOutput = true; 15 16 // ルート要素 <div> を作成し、ドキュメントに追加 17 $divElement = $dom->createElement('div'); 18 $dom->appendChild($divElement); 19 20 // 1番目のテキストノードを作成 21 // このノードには直前の兄弟ノードは存在しないはず 22 $textNode1 = $dom->createTextNode('これは最初のテキストです。'); 23 $divElement->appendChild($textNode1); 24 25 // 要素ノード <br> を作成 26 $brElement = $dom->createElement('br'); 27 $divElement->appendChild($brElement); 28 29 // 2番目のテキストノードを作成 (Dom\Text は Dom\CharacterData のサブクラス) 30 // このノードの直前の兄弟は <br> 要素になります 31 $textNode2 = $dom->createTextNode('これは2番目のテキストです。'); 32 $divElement->appendChild($textNode2); 33 34 // コメントノードを作成 (Dom\Comment も Dom\CharacterData のサブクラス) 35 // このノードの直前の兄弟は上記の2番目のテキストノードになります 36 $commentNode = $dom->createComment('これはコメントです。'); 37 $divElement->appendChild($commentNode); 38 39 // 現在のDOM構造を表示 40 echo "--- 作成されたDOM構造 ---\n"; 41 echo $dom->saveHTML() . "\n\n"; 42 43 echo "--- previousSibling の確認 ---\n"; 44 45 // textNode2 (2番目のテキストノード) の直前の兄弟ノードを取得 46 // 期待される結果: <br> 要素 47 echo "「これは2番目のテキストです。」の直前の兄弟ノード:\n"; 48 $prevSiblingOfText2 = $textNode2->previousSibling; 49 if ($prevSiblingOfText2 instanceof DOMNode) { 50 echo " 見つかりました。ノード名: " . $prevSiblingOfText2->nodeName . ", ノード値: " . $prevSiblingOfText2->nodeValue . "\n"; 51 } else { 52 echo " 直前の兄弟ノードは見つかりませんでした。\n"; 53 } 54 echo "\n"; 55 56 // commentNode (コメントノード) の直前の兄弟ノードを取得 57 // 期待される結果: 2番目のテキストノード「これは2番目のテキストです。」 58 echo "「これはコメントです。」の直前の兄弟ノード:\n"; 59 $prevSiblingOfComment = $commentNode->previousSibling; 60 if ($prevSiblingOfComment instanceof DOMNode) { 61 echo " 見つかりました。ノード名: " . $prevSiblingOfComment->nodeName . ", ノード値: " . $prevSiblingOfComment->nodeValue . "\n"; 62 } else { 63 echo " 直前の兄弟ノードは見つかりませんでした。\n"; 64 } 65 echo "\n"; 66 67 // textNode1 (最初のテキストノード) の直前の兄弟ノードを取得 68 // 期待される結果: null (兄弟ノードが存在しないため) 69 echo "「これは最初のテキストです。」の直前の兄弟ノード:\n"; 70 $prevSiblingOfText1 = $textNode1->previousSibling; 71 if ($prevSiblingOfText1 instanceof DOMNode) { 72 echo " 見つかりました。ノード名: " . $prevSiblingOfText1->nodeName . ", ノード値: " . $prevSiblingOfText1->nodeValue . "\n"; 73 } else { 74 echo " 直前の兄弟ノードは見つかりませんでした。(これは最初のノードです)\n"; 75 } 76 echo "\n"; 77} 78 79// 関数を実行 80demonstratePreviousSibling();
PHP 8のDom\CharacterData::previousSiblingプロパティは、DOMツリーにおいて、現在のノードの直前にある兄弟ノードを取得するために使用されます。Dom\CharacterDataは、Dom\Text（テキストノード）やDom\Comment（コメントノード）などの基底クラスであり、これらのノードからこのプロパティにアクセスできます。このプロパティに引数はなく、直前の兄弟ノードが存在すればDOMNodeオブジェクトを返しますが、存在しない場合はnullを返します。
サンプルコードでは、DOMDocumentを使って簡単なHTMLのDOMツリーを構築しています。<div>要素の中に、複数のテキストノード、<br>要素、コメントノードを順番に追加することで、様々な種類のノードが兄弟関係を持つように設定しています。そして、特定のテキストノードやコメントノードに対してpreviousSiblingプロパティを使用し、その直前の兄弟ノードが何であるかを確認しています。例えば、「これは2番目のテキストです。」というテキストノードの直前には<br>要素が存在するため、そのDOMNodeが取得されます。また、コメントノードの直前には「これは2番目のテキストです。」というテキストノードが存在するため、それが取得される様子も示されています。一方で、「これは最初のテキストです。」というノードのように、直前に兄弟ノードが存在しない場合にはnullが返されることも実演されており、DOMツリー内でのノード間の関係を理解するのに役立ちます。
Dom\CharacterData::previousSiblingプロパティは、現在のノードの直前にある同じ親を持つ兄弟ノードを返します。直前の兄弟ノードが存在しない場合（例えば、親ノード内の最初のノードである場合）はnullを返すため、必ずinstanceof DOMNodeなどで戻り値が有効なオブジェクトであるかを確認してから利用してください。確認を怠ると予期せぬエラーの原因となります。取得される兄弟ノードは、テキストノードやコメントノードだけでなく、<div>や<br>のようなHTML要素ノードである可能性もあります。そのため、返されたノードの種類に応じて適切な処理を行うように心がけてください。