【PHP8.x】DOMText::previousElementSiblingプロパティの使い方
previousElementSiblingプロパティの使い方について、初心者にもわかりやすく解説します。
基本的な使い方
DOMTextクラスのpreviousElementSiblingプロパティは、現在のテキストノードの直前の兄弟要素ノードを返します。DOM（Document Object Model）において、ノードはXMLやHTMLドキュメントの構成要素であり、要素、属性、テキストなど様々な種類が存在します。このプロパティは、DOMTextノード（テキストノード）の兄弟関係にある要素ノードを取得するために使用されます。
具体的には、DOMTextノードがDOMツリー内に存在し、その直前に要素ノードが存在する場合、previousElementSiblingプロパティはその要素ノードを返します。もし直前の兄弟ノードが要素ノードでなければ（例えば、テキストノードやコメントノードの場合）、あるいは直前の兄弟ノードが存在しない場合は、nullを返します。
このプロパティは読み取り専用であり、値を設定することはできません。主に、DOMツリーをナビゲートし、特定のテキストノードに関連する要素ノードを効率的に取得するために利用されます。例えば、あるテキストノードの直前の要素ノードの属性値を調べたり、その要素ノードに対して何らかの処理を行いたい場合に役立ちます。DOM操作において、ノード間の関係性を把握し、特定のノードを基準に他のノードにアクセスする際に重要な役割を果たします。特に、動的に生成されたDOMツリーや、複雑な構造を持つドキュメントを扱う場合に、previousElementSiblingプロパティは有効な手段となります。
構文(syntax)
1DOMText::$previousElementSibling;
引数(parameters)
引数なし
引数はありません
戻り値(return)
DOMElement|null
previousElementSibling プロパティは、この DOMText ノードの直前の兄弟要素ノードを返します。直前の兄弟ノードが存在しない場合は null を返します。
サンプルコード
DOMText::previousElementSiblingで直前要素を取得する
1<?php 2 3/** 4 * DOMText::previousElementSibling プロパティの動作をデモンストレーションする関数です。 5 * このプロパティは、DOMTextノードの直前の兄弟要素 (DOMElement) を取得します。 6 * 直前の兄弟が要素でない場合や存在しない場合は null を返します。 7 * 8 * システムエンジニアを目指す初心者の方にも理解しやすいように、具体的なHTML構造と 9 * その結果をステップバイステップで説明しています。 10 */ 11function demonstratePreviousElementSibling(): void 12{ 13 // テスト用のHTML文字列を準備します。 14 // 複数の要素とテキストノードが混在しており、様々なケースを試せます。 15 $html = <<<HTML 16 <div id="example-container"> 17 <!-- テキストノードA: 直前の兄弟要素がありません --> 18 テキストノードA。 19 <span>最初の要素</span> 20 <!-- テキストノードB: 直前の兄弟要素は <span> です --> 21 テキストノードB。 22 <b>二番目の要素</b> 23 <!-- テキストノードC: 直前の兄弟要素は <b> です --> 24 テキストノードC。 25 <em>三番目の要素</em> 26 <!-- テキストノードD: 直前の兄弟要素は <em> です --> 27 テキストノードD。 28 </div> 29 HTML; 30 31 // DOMDocument オブジェクトを初期化します。 32 // これを使ってHTML文字列を解析し、DOMツリーを構築します。 33 $dom = new DOMDocument(); 34 // HTMLをロードします。@ をつけてパースエラーを抑制していますが、 35 // 実際のアプリケーションではエラーハンドリングを行うべきです。 36 @$dom->loadHTML($html); 37 38 // ID 'example-container' を持つコンテナ要素を取得します。 39 // この要素の子ノードを走査して、DOMTextノードを見つけます。 40 $container = $dom->getElementById('example-container'); 41 42 // コンテナ要素が正常に取得できたか確認します。 43 if ($container) { 44 echo "--- 各テキストノードとその直前の兄弟要素の検出結果 ---" . PHP_EOL . PHP_EOL; 45 46 // コンテナ要素のすべての子ノードをループ処理します。 47 foreach ($container->childNodes as $node) { 48 // 現在のノードが DOMText のインスタンスであるか確認します。 49 // DOMText はHTML内のプレーンテキストを表すノードです。 50 if ($node instanceof DOMText) { 51 // テキストノードの内容から、余分な空白や改行を削除して整形します。 52 // HTMLの整形によって生成される空のテキストノードを除外するためです。 53 $nodeContent = trim($node->textContent); 54 55 // 内容が空でないテキストノードのみを処理します。 56 if ($nodeContent === '') { 57 continue; // 空のテキストノードはスキップ 58 } 59 60 echo "現在のテキストノード: '" . $nodeContent . "'" . PHP_EOL; 61 62 // `previousElementSibling` プロパティを使用して、 63 // このテキストノードの直前に位置する兄弟要素を取得します。 64 // 戻り値は DOMElement オブジェクトか、条件に合致する要素がない場合は null です。 65 $previousElement = $node->previousElementSibling; 66 67 if ($previousElement !== null) { 68 // 直前の兄弟が要素 (DOMElement) であった場合、 69 // そのタグ名 (例: span, b, em) と内容を表示します。 70 echo " -> 直前の兄弟要素: <" . $previousElement->nodeName . "> (内容: '" . trim($previousElement->textContent) . "')" . PHP_EOL; 71 } else { 72 // 直前の兄弟が存在しない、または要素ではない場合 (例: コメントノード、別のテキストノード)。 73 // `previousElementSibling` は「要素」のみを対象とするため、これ以外は null を返します。 74 echo " -> 直前の兄弟要素は存在しません (または、直前の兄弟は要素ではありません)。" . PHP_EOL; 75 } 76 echo PHP_EOL; // 見やすくするための改行 77 } 78 } 79 } else { 80 // コンテナ要素が見つからなかった場合のメッセージです。 81 echo "指定されたコンテナ要素 'example-container' が見つかりませんでした。" . PHP_EOL; 82 } 83} 84 85// 関数を実行して、デモンストレーションを開始します。 86demonstratePreviousElementSibling();
PHPの DOMText::previousElementSibling プロパティは、HTMLやXMLドキュメントのDOM（Document Object Model）ツリーにおいて、特定のテキストノード（DOMText）の直前に位置する兄弟要素（DOMElement）を取得するために使用されます。このプロパティは引数を持ちません。
戻り値は、直前の兄弟ノードが要素である場合にそのDOMElementオブジェクトを返します。もし直前の兄弟ノードが要素ではない場合（例えば、別のテキストノードやコメントノード）、あるいは直前の兄弟ノードが存在しない場合は、nullが返されます。
サンプルコードでは、様々なテキストノードの直前の兄弟要素を調べています。例えば、「テキストノードB。」の直前には<span>要素が存在するため、previousElementSiblingはこの<span>要素を返します。しかし、「テキストノードA。」のように直前に要素が存在しない場合や、もし直前の兄弟が要素以外のノード（空白や改行を含む別のテキストノードなど）であっても、previousElementSiblingはそれらを無視してnullを返します。このプロパティを使うことで、文書構造の中から特定のテキストに関連する直前の要素を効率的に取得し、HTMLコンテンツの解析や操作を行う際に役立ちます。
DOMText::previousElementSiblingプロパティは、直前の兄弟要素のみを返します。直前のノードがテキストノードやコメントノードの場合にはnullを返すため、DOMツリー内のすべての兄弟ノードを対象とするpreviousSiblingプロパティとの違いを理解し、混同しないよう注意が必要です。HTMLソースコードの改行やインデントもDOMツリー上では空白文字だけのテキストノードとして扱われることがあります。サンプルコードのようにtrim()関数で内容を整形し、空のテキストノードを除外する処理を適切に行うことが重要です。また、DOMDocument::loadHTML()でHTMLをパースする際は、サンプルコードのように@でエラーを抑制するのではなく、エラーハンドリングを記述して予期せぬ挙動を防ぐようにしてください。プロパティの戻り値がnullである可能性を常に考慮し、必ず条件分岐でチェックするようにしましょう。
DOMText::previousElementSiblingで兄弟要素を取得する
1<?php 2 3/** 4 * DOMText::previousElementSibling プロパティの使用例を示す関数です。 5 * 6 * このプロパティは、DOMTextノード（テキストノード）の直前の兄弟要素ノードを返します。 7 * 直前の兄弟ノードがコメントノードや他のテキストノードである場合はスキップされ、 8 * DOMElement型のノードのみが対象となります。 9 * これはJavaScriptのElement.previousElementSiblingと同様の機能を提供します。 10 */ 11function demonstratePreviousElementSibling(): void 12{ 13 // サンプルとなるHTMLコンテンツを定義します。 14 // ここでは、ターゲットとなるテキストノードの前に、要素ノード、コメントノード、 15 // そして別のテキストノードを配置して、previousElementSiblingの挙動を示します。 16 $htmlContent = <<<HTML 17<div id="container"> 18 <p>これは最初の兄弟要素です。</p> 19 <!-- これはコメントノードです。previousElementSiblingによってスキップされます。 --> 20 これは間にあるテキストノードです。 21 <span>これが、私たちが探している直前の兄弟要素です。</span> 22 直前の兄弟要素を見つけたいテキストノード。 23 <b>これは後続の兄弟要素です。</b> 24</div> 25HTML; 26 27 // DOMDocument オブジェクトを作成し、HTMLコンテンツをロードします。 28 // LIBXML_HTML_NOIMPLIED: HTML/HEAD/BODYタグが自動追加されるのを防ぎます。 29 // LIBXML_NOERROR: HTMLの解析エラーを抑制します（デバッグ時は有効にすると良いでしょう）。 30 $dom = new DOMDocument(); 31 $dom->loadHTML($htmlContent, LIBXML_HTML_NOIMPLIED | LIBXML_NOERROR); 32 33 // DOMXPath オブジェクトを作成し、DOMツリー内で特定のノードを検索するために使用します。 34 $xpath = new DOMXPath($dom); 35 36 // ターゲットとなるテキストノードを検索します。 37 // ここでは「直前の兄弟要素を見つけたいテキストノード。」というコンテンツを持つノードを探します。 38 // XPathの `//text()[contains(., '文字列')]` は、指定された文字列を含むすべてのテキストノードを選択します。 39 $targetTextNodes = $xpath->query("//text()[contains(., '直前の兄弟要素を見つけたいテキストノード。')]"); 40 41 if ($targetTextNodes->length > 0) { 42 // 最初に見つかったテキストノードをターゲットとします。 43 /** @var DOMText $targetTextNode */ 44 $targetTextNode = $targetTextNodes[0]; 45 46 echo "--- DOMText::previousElementSibling の使用例 ---\n\n"; 47 echo "▼ ターゲットのテキストノード:\n"; 48 echo " - 内容: 「" . trim($targetTextNode->nodeValue) . "」\n\n"; 49 50 // previousElementSibling プロパティを使用して、ターゲットテキストノードの 51 // 直前にある「兄弟要素ノード」を取得します。 52 // コメントノードや、間に挟まったテキストノードは自動的にスキップされます。 53 // 直前の兄弟要素が存在しない場合、またはDOMElement型でない場合は null を返します。 54 $previousElementSibling = $targetTextNode->previousElementSibling; 55 56 if ($previousElementSibling instanceof DOMElement) { 57 echo "▼ 直前の兄弟要素が見つかりました:\n"; 58 echo " - 要素名 (tagName): " . $previousElementSibling->tagName . "\n"; 59 echo " - 要素のテキスト内容 (textContent): 「" . trim($previousElementSibling->textContent) . "」\n"; 60 echo " - このオブジェクトはDOMElement型です。\n"; 61 } else { 62 echo "▼ ターゲットテキストノードの直前には、兄弟要素ノードが見つかりませんでした。\n"; 63 echo " (直前にノードがないか、または存在してもDOMElement型ではありませんでした。)\n"; 64 } 65 } else { 66 echo "エラー: 指定されたターゲットテキストノード「直前の兄弟要素を見つけたいテキストノード。」が見つかりませんでした。\n"; 67 } 68} 69 70// 関数を実行して、サンプルコードの動作を確認します。 71demonstratePreviousElementSibling();
DOMText::previousElementSiblingプロパティは、HTMLやXML文書の構造を操作するPHPのDOM拡張機能において、テキストノードの直前にある兄弟要素ノードを取得するために使用されます。このプロパティは引数を取らず、直前の兄弟ノードがコメントノードや他のテキストノードであっても、それらを自動的にスキップしてDOMElement型のノードのみを探します。これにより、JavaScriptのElement.previousElementSiblingと同様に、直近の要素ノードを効率的に特定できる点が特徴です。
戻り値としては、直前の兄弟要素が見つかった場合はそのDOMElementオブジェクトを返します。もし直前に兄弟要素ノードが存在しない場合や、直前の兄弟ノードがDOMElement型ではない場合はnullを返します。
サンプルコードでは、まずHTMLコンテンツをDOMDocumentにロードし、DOMXPathを使って特定のテキストノード「直前の兄弟要素を見つけたいテキストノード。」を検索しています。このターゲットとなるDOMTextノードに対してpreviousElementSiblingプロパティを呼び出すことで、その直前にある要素ノード（この例では<span>要素）を正確に取得し、その要素名やテキスト内容を表示しています。これにより、DOMツリー内のテキストノードから隣接する要素ノードへ簡単にアクセスできることがわかります。
DOMText::previousElementSiblingは、テキストノードの直前にある要素ノード（DOMElement）のみを取得するプロパティです。直前の兄弟ノードがコメントや他のテキストノードであっても、それらは自動的にスキップされます。戻り値はDOMElementオブジェクトまたは、条件に合う要素が見つからない場合はnullとなります。そのため、プロパティの結果を使用する際は、必ずif ($previousElementSibling instanceof DOMElement)のように型のチェックを行い、nullではないことを確認してから操作してください。このプロパティはJavaScriptのElement.previousElementSiblingと似た振る舞いをしますが、PHPではサーバーサイドでDOMを処理している点を理解して活用しましょう。HTMLの構造を正しく把握し、意図しない結果にならないよう注意が必要です。