【PHP8.x】Dom\Text::previousElementSiblingプロパティの使い方
previousElementSiblingプロパティの使い方について、初心者にもわかりやすく解説します。
基本的な使い方
Dom\TextクラスのpreviousElementSiblingプロパティは、現在のテキストノードの直前の兄弟要素ノードを返します。具体的には、DOMツリー上で現在のテキストノードのすぐ前に位置する要素ノードを取得するために使用されます。もし直前の兄弟ノードが存在しない場合、あるいは要素ノードではない場合は、nullを返します。
このプロパティは読み取り専用であり、値を設定することはできません。テキストノードの構造をプログラムから変更するのではなく、現在の構造を解析するために利用されます。
システム開発においては、XMLやHTMLドキュメントをPHPで処理する際に、特定のテキストノードの周辺にある要素ノードを特定する必要がある場合に役立ちます。例えば、特定のテキストコンテンツを持つ要素のスタイリングを変更したり、テキストノードの前にある要素の属性に基づいて処理を分岐させたりする際に利用できます。
previousElementSiblingプロパティを使用することで、DOMツリーを効率的にナビゲートし、必要な情報を取得することが可能になります。特に複雑なドキュメント構造を持つXMLやHTMLを扱う場合に、XPathなどの他の方法と比較して、より直接的でシンプルなコードで目的の要素にアクセスできる場合があります。
このプロパティは、DOMDocument、DOMElementなどの他のDOM関連クラスと連携して使用されることが一般的です。これらのクラスと組み合わせることで、XMLやHTMLドキュメントの解析、操作、生成といった様々な処理をPHPで行うことができます。
構文(syntax)
1readonly public ?Dom\Element $previousElementSibling;
引数(parameters)
引数なし
引数はありません
戻り値(return)
DOMElement|null
Dom\TextクラスのpreviousElementSiblingプロパティは、現在のテキストノードの直前の兄弟要素を返します。直前の兄弟要素が存在しない場合はnullを返します。
サンプルコード
PHP DOM Text::previousElementSiblingで直前の要素を取得する
1<?php 2 3/** 4 * Dom\Text::previousElementSibling プロパティの使用例を示します。 5 * このプロパティは、現在のテキストノードの直前の兄弟要素ノードを返します。 6 * 直前の兄弟が要素ノードでない場合（例えば、別のテキストノードの場合） 7 * または存在しない場合は null を返します。 8 */ 9function demonstratePreviousElementSiblingProperty(): void 10{ 11 // サンプルとなるHTML構造を定義します。 12 // 各テキストノードについて、直前の兄弟要素がどうなるかを検証します。 13 $htmlContent = <<<HTML 14 <div> 15 <p>最初の要素ノード (Paragraph)</p> 16 <!-- このテキストノード「これはテキストノード1です。」の直前の兄弟要素は <p> です --> 17 これはテキストノード1です。 18 <span>二番目の要素ノード (Span)</span> 19 <!-- このテキストノード「これはテキストノード2です。」の直前の兄弟要素は <span> です --> 20 これはテキストノード2です。 21 <!-- このテキストノード「テキストノード3。」の直前の兄弟は別のテキストノードであり、 22 要素ノードではないため、previousElementSiblingはnullを返します。 --> 23 テキストノード3。 24 </div> 25 HTML; 26 27 // DOMドキュメントを作成し、HTMLをロードします。 28 // LIBXML_HTML_NOIMPLIED と LIBXML_HTML_NODEFDTD は、 29 // 余分な<html>, <body>, <!DOCTYPE>タグが自動追加されるのを防ぎます。 30 $dom = new Dom\Document(); 31 $dom->loadHTML($htmlContent, LIBXML_HTML_NOIMPLIED | LIBXML_HTML_NODEFDTD); 32 33 // XPathを使って特定のテキストノードを検索するためのオブジェクトを作成します。 34 $xpath = new Dom\XPath($dom); 35 36 // --- 例1: 直前の兄弟要素が <p> のテキストノード --- 37 // 「これはテキストノード1です。」を含むテキストノードを探します。 38 $nodes1 = $xpath->query("//text()[contains(., 'これはテキストノード1です。')]"); 39 if ($nodes1->length > 0) { 40 /** @var Dom\Text $textNode1 */ 41 $textNode1 = $nodes1->item(0); 42 echo "--- テキストノード: '{$textNode1->wholeText}' の検証 ---\n"; 43 echo "現在のノードタイプ: " . $textNode1->nodeName . "\n"; 44 45 $previousElement1 = $textNode1->previousElementSibling; 46 47 if ($previousElement1 instanceof Dom\Element) { 48 echo "結果: 直前の兄弟要素ノードが見つかりました。\n"; 49 echo " ノード名: {$previousElement1->nodeName}\n"; 50 echo " 内容: '{$previousElement1->textContent}'\n"; 51 } else { 52 echo "結果: 直前の兄弟要素ノードは見つかりませんでした。\n"; 53 } 54 echo "\n"; 55 } 56 57 // --- 例2: 直前の兄弟要素が <span> のテキストノード --- 58 // 「これはテキストノード2です。」を含むテキストノードを探します。 59 $nodes2 = $xpath->query("//text()[contains(., 'これはテキストノード2です。')]"); 60 if ($nodes2->length > 0) { 61 /** @var Dom\Text $textNode2 */ 62 $textNode2 = $nodes2->item(0); 63 echo "--- テキストノード: '{$textNode2->wholeText}' の検証 ---\n"; 64 echo "現在のノードタイプ: " . $textNode2->nodeName . "\n"; 65 66 $previousElement2 = $textNode2->previousElementSibling; 67 68 if ($previousElement2 instanceof Dom\Element) { 69 echo "結果: 直前の兄弟要素ノードが見つかりました。\n"; 70 echo " ノード名: {$previousElement2->nodeName}\n"; 71 echo " 内容: '{$previousElement2->textContent}'\n"; 72 } else { 73 echo "結果: 直前の兄弟要素ノードは見つかりませんでした。\n"; 74 } 75 echo "\n"; 76 } 77 78 // --- 例3: 直前の兄弟ノードがテキストノードであり、要素ではない場合 --- 79 // 「テキストノード3。」を含むテキストノードを探します。 80 // このノードの直前の兄弟ノードは「これはテキストノード2です。」というテキストノードなので、 81 // previousElementSibling は null を返します。 82 $nodes3 = $xpath->query("//text()[contains(., 'テキストノード3。')]"); 83 if ($nodes3->length > 0) { 84 /** @var Dom\Text $textNode3 */ 85 $textNode3 = $nodes3->item(0); 86 echo "--- テキストノード: '{$textNode3->wholeText}' の検証 ---\n"; 87 echo "現在のノードタイプ: " . $textNode3->nodeName . "\n"; 88 89 $previousElement3 = $textNode3->previousElementSibling; 90 91 if ($previousElement3 instanceof Dom\Element) { 92 echo "結果: 直前の兄弟要素ノードが見つかりました。\n"; 93 echo " ノード名: {$previousElement3->nodeName}\n"; 94 echo " 内容: '{$previousElement3->textContent}'\n"; 95 } else { 96 echo "結果: 直前の兄弟要素ノードは見つかりませんでした。(直前は別のテキストノード)\n"; 97 } 98 echo "\n"; 99 } 100} 101 102// サンプルコードの実行 103demonstratePreviousElementSiblingProperty();
PHP 8のDom\Textクラスに属するpreviousElementSiblingプロパティは、HTMLやXML文書内のテキストノードを操作する際に使用されます。このプロパティは、現在のテキストノードの直前にある「兄弟要素ノード」を取得するために利用します。引数は必要ありません。
戻り値はDOMElementオブジェクト、または条件に合わない場合はnullとなります。具体的には、直前の兄弟ノードが存在し、それがHTMLタグで囲まれた要素（例えば<p>や<span>など）である場合にのみ、その要素をDOMElementとして返します。直前の兄弟ノードが別のテキストノードだったり、コメントノードだったり、あるいは直前に兄弟ノード自体が存在しない場合には、nullを返します。
サンプルコードでは、この挙動を具体的に確認できます。まず「これはテキストノード1です。」の直前にある<p>要素や、「これはテキストノード2です。」の直前にある<span>要素を、previousElementSiblingが正確に取得している様子を示しています。一方、「テキストノード3。」の直前の兄弟ノードは、別のテキストノードであるため、previousElementSiblingはnullを返すことが示されており、要素ノードに限定される挙動が理解できます。これにより、特定のテキスト内容に隣接する要素を効率的に見つけることが可能です。
Dom\Text::previousElementSiblingは、現在のテキストノードの直前の兄弟要素ノードのみを返します。直前の兄弟が別のテキストノードやコメントノード、または存在しない場合はnullを返しますので、この点を特に注意してください。戻り値はDOMElement型かnullなので、必ずif ($variable instanceof Dom\Element)のように型チェックを行ってから、プロパティにアクセスしてください。HTMLをDom\Documentで読み込む際、要素間の空白や改行もテキストノードとしてDOMツリーに含まれることがあります。この挙動を理解しておくことで、期待と異なる結果になった場合の混乱を避けられます。
PHP DOM\Text::previousElementSibling で直前要素を取得する
1<?php 2 3// Dom\Text::previousElementSibling の使用例を示す関数です。 4// このプロパティは、対象のテキストノードの直前にある要素ノードを返します。 5// その間にコメントノードや空白のみのテキストノードがあってもスキップされます。 6function demonstrateDomTextPreviousElementSibling(): void 7{ 8 // Dom\Textノードの直前に要素ノードが存在するHTML構造を定義します。 9 // <p>タグの後にコメントノードを挟んでテキストノードを配置しています。 10 $html = <<<HTML 11 <div id="container"> 12 <p>これは直前の要素ノードです。</p> 13 <!-- コメントノード --> 14 このテキストノードの直前の要素を取得します。 15 </div> 16 HTML; 17 18 // DOMDocumentオブジェクトを作成し、HTMLをロードします。 19 $dom = new DOMDocument(); 20 // HTMLパース時のエラーを抑制し、標準的なHTML5の挙動に近い形でロードします。 21 @$dom->loadHTML($html, LIBXML_HTML_NOIMPLIED | LIBXML_HTML_NODEFDTD); 22 23 $targetTextNode = null; 24 $container = $dom->getElementById('container'); 25 26 if ($container !== null) { 27 // コンテナ内の子ノードを走査し、目的のテキストノードを見つけます。 28 foreach ($container->childNodes as $node) { 29 // ノードがDom\Textインスタンスであり、かつ空白文字のみでない場合に処理します。 30 if ($node instanceof Dom\Text && trim($node->nodeValue) !== '') { 31 // 特定の文字列を含むテキストノードを目的のノードとして設定します。 32 if (str_contains($node->nodeValue, 'このテキストノードの直前の要素を取得します。')) { 33 $targetTextNode = $node; 34 break; 35 } 36 } 37 } 38 } 39 40 if ($targetTextNode !== null) { 41 echo "対象のDom\\Textノードの内容: '" . trim($targetTextNode->nodeValue) . "'\n\n"; 42 43 // Dom\Text::previousElementSibling を使用して直前の要素ノードを取得します。 44 // コメントノードや空白テキストノードは無視されます。 45 $previousElement = $targetTextNode->previousElementSibling; 46 47 if ($previousElement !== null) { 48 echo "直前の要素ノードが見つかりました。\n"; 49 echo " タグ名: " . $previousElement->tagName . "\n"; 50 echo " textContent: " . $previousElement->textContent . "\n"; 51 } else { 52 echo "直前の要素ノードは見つかりませんでした。\n"; 53 } 54 } else { 55 echo "目的のDom\\Textノードが見つかりませんでした。HTML構造を確認してください。\n"; 56 } 57} 58 59// 関数を実行します。 60demonstrateDomTextPreviousElementSibling(); 61
PHP 8のDom\Text::previousElementSiblingは、Dom\Textクラスのインスタンスが持つプロパティです。このプロパティは、対象となるテキストノードの直前に位置する要素ノードを取得するために使用されます。引数は必要ありません。
このプロパティの大きな特徴は、直前のノードが要素ノードではない場合、例えばコメントノードや改行・スペースのみの空白テキストノードであっても、それらを自動的にスキップし、その直前にある最も近い要素ノードを返します。もし直前に要素ノードが存在しない場合は、nullを返します。戻り値はDOMElementオブジェクト、または見つからない場合はnullです。
サンプルコードでは、「<p>要素」の直後に「<!--コメントノード-->」を挟んで「このテキストノード...」というテキストノードが配置されています。このテキストノードに対してpreviousElementSiblingを使用すると、間のコメントノードを無視し、直前の<p>要素を正確に取得できることを示しています。このように、HTMLドキュメント内で特定のテキストノードに関連する要素ノードを効率的に特定したい場合に非常に役立ちます。この挙動はJavaScriptの同名のプロパティと似ています。
このコードは、PHPのDom\Text::previousElementSiblingプロパティを使って、テキストノードの直前にある要素ノードを取得する方法を示しています。特に注意すべき点は、このプロパティが直前の要素ノードのみを返すことです。コメントノードや空白のみのテキストノードはスキップされるため、直前のあらゆるノードを対象とするpreviousSiblingプロパティと混同しないようご注意ください。この挙動はJavaScriptのpreviousElementSiblingプロパティと似ています。また、直前の要素ノードが存在しない場合はnullが返されるため、必ずnullチェックを行ってから、tagNameなどのプロパティにアクセスするようにしてください。これにより、未定義のプロパティへのアクセスによるエラーを防ぎ、安全にコードを利用できます。HTMLの構造によっては期待通りの要素が見つからない場合がある点も留意してください。