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

previousSiblingプロパティは、Dom\CommentオブジェクトがDOMツリー内で持つ、直前の兄弟ノードを保持するプロパティです。DOM（Document Object Model）ツリーとは、HTMLやXMLのようなマークアップ文書を、プログラムからアクセスし操作できるように木構造で表現したものです。このプロパティは、現在のコメントノードと同じ親ノードを持ち、かつDOMツリー上での出現順序が現在のコメントノードの直前にあるノードを指します。

具体的には、Dom\CommentインスタンスにおいてpreviousSiblingプロパティにアクセスすると、そのコメントの直前に位置する兄弟ノードがDom\Node型のオブジェクトとして返されます。兄弟ノードは、要素ノード（Dom\Element）、テキストノード（Dom\Text）、別のコメントノード（Dom\Comment）など、様々な種類のノードである可能性があります。もし、現在のコメントノードの直前に兄弟ノードが存在しない場合、つまり、現在のコメントノードが親ノードの最初の子である場合には、このプロパティはnullを返します。

このプロパティは、文書の構造をプログラムでたどったり、特定のノードの前にある情報を確認したりする際に非常に有用です。例えば、コメントノードの直前にある要素の内容に基づいて処理を変えるといったDOM操作を行う際に利用できます。PHPのDOM拡張機能では、previousSiblingを含む様々なプロパティやメソッドを用いて、複雑な文書構造も効率的に扱えるようになっています。

Copy
1<?php
2$dom = new DOMDocument();
3$parentElement = $dom->createElement('div');
4$dom->appendChild($parentElement);
5
6$firstElement = $dom->createElement('p', '最初の要素');
7$parentElement->appendChild($firstElement);
8
9$commentNode = $dom->createComment('これはコメントです');
10$parentElement->appendChild($commentNode);
11
12// Dom\Comment::previousSibling プロパティを使用して、直前の兄弟ノードを取得
13// $commentNode は Dom\Comment オブジェクト
14$previousSibling = $commentNode->previousSibling;
15
16// $previousSibling は $firstElement と同じ DOMElement オブジェクトを参照する
17?>

引数なし

引数はありません

Dom\Node|null

このプロパティは、現在のコメントノードの直前の兄弟ノード、または兄弟ノードが存在しない場合は null を返します。