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

previousSiblingプロパティは、PHPのDOM拡張機能において、Dom\Entityオブジェクトが自身の直前に位置する兄弟ノードを保持するプロパティです。DOM（Document Object Model）とは、HTMLやXMLのようなドキュメントの構造を木のような形式（ツリー構造）で表現し、プログラムからアクセス・操作できるようにするモデルを指します。

Dom\Entityクラスは、XMLドキュメント内で定義される実体（エンティティ）ノードを表します。このプロパティを利用することで、あるDom\Entityノードの親ノードが持つ子ノードのリストにおいて、当該Dom\Entityノードのすぐ前に存在するノードにアクセスすることが可能になります。例えば、複数の要素が並んでいる場合、このプロパティを使って直前の要素やテキストノードなどを取得できます。

もし、現在のDom\Entityノードが親ノードの最初の子ノードであり、直前に兄弟ノードが存在しない場合は、このプロパティはnullを返します。それ以外の場合は、直前の兄弟ノードを表すDom\Node型のオブジェクトが返されます。

このプロパティは、XMLドキュメントのツリー構造を後ろ向きに（あるいは双方向に）たどり、特定ノードの前後関係を調査したり、隣接するノードの情報を取得して処理を行ったりする際に非常に有用です。初心者の方でも、ドキュメントの構造を理解し、その中から特定の情報を効率的に取得するための基本的な手段として活用できます。

Copy
1<?php
2
3// XML ドキュメントを定義し、DTD内でエンティティを宣言します。
4$xml = <<<XML
5<!DOCTYPE root [
6  <!ENTITY first "最初のエンティティ">
7  <!ENTITY second "二番目のエンティティ">
8]>
9<root>
10  <child/>
11</root>
12XML;
13
14$dom = new DOMDocument();
15$dom->loadXML($xml);
16
17// ドキュメントタイプ (DOCTYPE) を取得します。
18$doctype = $dom->doctype;
19
20if ($doctype && $doctype->entities) {
21    // Dom\NamedNodeMap から "second" という名前のエンティティを取得します。
22    // Dom\NamedNodeMap は順序を保証しないため、previousSiblingは通常nullを返します。
23    $entity = $doctype->entities->getNamedItem('second');
24
25    if ($entity instanceof DOM\Entity) {
26        // Dom\Entity クラスの previousSibling プロパティにアクセスします。
27        // これは、現在のエンティティの直前の兄弟ノード (Dom\Nodeオブジェクト) を返します。
28        // 直前の兄弟ノードが存在しない場合は null を返します。
29        $previousSibling = $entity->previousSibling;
30
31        if ($previousSibling) {
32            echo "エンティティ ('second') の直前の兄弟ノードの名前: " . $previousSibling->nodeName . "\n";
33        } else {
34            echo "エンティティ ('second') には直前の兄弟ノードが存在しません。\n";
35        }
36    } else {
37        echo "指定されたエンティティが見つからないか、Dom\\Entity型ではありません。\n";
38    }
39} else {
40    echo "DOCTYPEまたはエンティティが定義されていません。\n";
41}
42
43?>

引数なし

引数はありません

?Dom\Node

現在のノードの直前の兄弟ノードを返します。兄弟ノードが存在しない場合は null を返します。