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

previousSiblingプロパティは、PHP 8のDom拡張機能において、Dom\XMLDocumentクラスに属するプロパティです。このプロパティは、現在のノードの直前に位置する兄弟ノードを保持します。DOM（Document Object Model）ツリーにおいて、ノードは親ノードの子として階層的に配置されており、同じ親ノードを持つノード同士を兄弟ノードと呼びます。

Dom\XMLDocumentクラスは、XMLドキュメント全体、つまりDOMツリーの最上位に位置するドキュメントノードを表します。このドキュメントノードは通常、DOMツリーのルートであり、その上位に親ノードや、同じレベルに兄弟ノードを持つことはありません。そのため、Dom\XMLDocumentオブジェクトに対してpreviousSiblingプロパティを参照した場合、通常はその値はnullを返します。これは、ドキュメントノードの直前に兄弟ノードが存在しないことを意味します。

このプロパティは、主に特定の要素ノードやテキストノードなど、DOMツリー内で他のノードと並列に存在するノードに対して、その直前の兄弟ノードを取得するために使用されます。例えば、XMLドキュメント内の特定の子要素に対してpreviousSiblingプロパティを使用することで、その要素の直前にある別の要素やテキストノードを取得することができます。しかし、Dom\XMLDocumentオブジェクト自体はドキュメント全体を指すため、このプロパティが直接的に有用となる場面は稀であることを理解しておく必要があります。

Copy
1<?php
2$document = new Dom\Document();
3$node = $document->previousSibling;
4?>

引数なし

引数はありません

Dom\Node|null

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