【PHP8.x】DOMNotation::nextSiblingプロパティの使い方

nextSiblingプロパティの使い方について、初心者にもわかりやすく解説します。

作成日: 2025年09月11日更新日: 2025年12月04日

基本的な使い方

nextSiblingプロパティは、現在のノードの直後にある次の兄弟ノードを保持するプロパティです。このプロパティは、PHPのDOM拡張機能におけるDOMNotationクラスの一部として利用できますが、実際にはDOMNodeクラスから継承された共通のプロパティです。DOMNotationオブジェクトは、XMLドキュメントのDOCTYPE宣言において定義される表記法（NOTATION）を表すノードです。

DOMツリー構造において、あるノードと同じ親ノードを持ち、かつそのノードの直後に位置するノードを「次の兄弟ノード」と呼びます。nextSiblingプロパティを使用すると、現在のDOMNotationオブジェクトがDOMツリー内で持つ次の兄弟ノードにアクセスできます。

具体的には、もし現在のDOMNotationノードの直後に別の兄弟ノードが存在する場合、このプロパティはその兄弟ノードを表すDOMNodeオブジェクトを返します。これにより、DOMツリーを順方向にたどり、隣接するノードの情報を取得したり、操作したりすることが可能になります。しかし、もし現在のDOMNotationノードがDOMツリーにおける最後の兄弟ノードであるなど、直後に兄弟ノードが存在しない場合は、このプロパティはnullを返します。システム開発において、XMLドキュメントの構造を解析し、特定のノードから次の要素へと処理を進める際に非常に役立つ基本的なプロパティです。

構文(syntax)


1<?php
2$dom = new DOMDocument();
3$dom->loadXML('<!DOCTYPE root [<!NOTATION example1 SYSTEM "uri1"><!NOTATION example2 SYSTEM "uri2">]><root/>');
4
5$notation = null;
6if ($dom->doctype && $dom->doctype->notations) {
7    $notation = $dom->doctype->notations->getNamedItem('example1');
8}
9
10$nextSiblingNode = null;
11if ($notation instanceof DOMNotation) {
12    $nextSiblingNode = $notation->nextSibling;
13}
14?>

引数(parameters)

引数なし

引数はありません

戻り値(return)

?DOMNode

DOMNotationクラスのnextSiblingプロパティは、現在のノードの直後に位置する兄弟ノードを返します。直後に兄弟ノードが存在しない場合は、nullを返します。

サンプルコード

PHP DOM nextSibling で兄弟ノードを取得する


1<?php
2
3/**
4 * DOMNotationのnextSiblingプロパティの使用例を示します。
5 *
6 * nextSiblingプロパティは、現在のノードの直後にある兄弟ノードを取得します。
7 * このサンプルでは、DTD内で宣言されたあるノーテーションの次に宣言された
8 * 別のノーテーションを取得します。
9 */
10function demonstrateDomNotationNextSibling(): void
11{
12    // 2つのノーテーション (notation1, notation2) を含むDTDを定義したXML文字列
13    $xmlString = <<<XML
14    <?xml version="1.0" encoding="UTF-8"?>
15    <!DOCTYPE root [
16        <!NOTATION notation1 PUBLIC "Notation 1 Public ID">
17        <!NOTATION notation2 PUBLIC "Notation 2 Public ID">
18    ]>
19    <root />
20    XML;
21
22    // DOMDocument オブジェクトを生成します
23    $dom = new DOMDocument();
24
25    // 空白文字のノードを無視する設定です。
26    // これにより、ノーテーション間の改行がテキストノードとして扱われなくなり、
27    // nextSibling が次のノーテーションを直接指すようになります。
28    $dom->preserveWhiteSpace = false;
29
30    // XML文字列を読み込みます
31    $dom->loadXML($xmlString);
32
33    // ドキュメントの型定義 (DTD) を取得します
34    $doctype = $dom->doctype;
35
36    // DTD内の最初のノーテーション (notation1) を名前で取得します
37    // $doctype->notations はノーテーションのリスト (DOMNamedNodeMap) です。
38    $firstNotation = $doctype->notations->getNamedItem('notation1');
39
40    if ($firstNotation instanceof DOMNotation) {
41        echo '基準となるノーテーション名: ' . $firstNotation->nodeName . PHP_EOL;
42
43        // firstNotation の次の兄弟ノードを取得します。
44        // 戻り値は DOMNode または null になります (?DOMNode)。
45        $nextSiblingNode = $firstNotation->nextSibling;
46
47        // 次の兄弟ノードが存在するかを確認します
48        if ($nextSiblingNode instanceof DOMNotation) {
49            echo 'nextSibling で取得したノーテーション名: ' . $nextSiblingNode->nodeName . PHP_EOL;
50            echo 'その公開識別子: ' . $nextSiblingNode->publicId . PHP_EOL;
51        } else {
52            echo '次の兄弟ノードは見つかりませんでした。' . PHP_EOL;
53        }
54    }
55}
56
57// 関数を実行します
58demonstrateDomNotationNextSibling();
59
60?>

DOMNotationクラスのnextSiblingプロパティは、XML文書のDTD（文書型定義）内で、あるノーテーションの直後に宣言されている兄弟ノードを取得するために使用します。このプロパティに引数はありません。

このサンプルコードでは、まずDTD内にnotation1とnotation2という2つのノーテーションを隣接して定義したXMLを読み込みます。次に、getNamedItemメソッドでnotation1を取得し、そのnextSiblingプロパティにアクセスすることで、notation1のすぐ後ろにあるnotation2を取得しています。

戻り値は、次の兄弟ノードが存在する場合はそのノードを表すDOMNodeオブジェクト、存在しない場合（現在のノードが最後の兄弟ノードである場合）はnullとなります。そのため、コード内でinstanceofを使用して、取得したノードが期待通りDOMNotationであるかを確認した上で、その名前や公開識別子を出力しています。

また、$dom->preserveWhiteSpace = false;という設定は重要です。これにより、ノーテーション間の改行などが不要なテキストノードとして扱われるのを防ぎ、nextSiblingが正しく次のノーテーションを指すようになります。このプロパティを使うことで、DTD内のノーテーションを順番に処理することができます。

nextSiblingプロパティを使用する際は、DOMDocumentのpreserveWhiteSpaceをfalseに設定することが重要です。この設定がないと、XML内の改行や空白がテキストノードとして扱われ、期待通りに次のノーテーションを取得できない場合があります。また、nextSiblingは次の兄弟ノードが存在しない場合にnullを返します。そのため、取得した値を使用する前に必ずnullでないかを確認する必要があります。さらに、兄弟ノードがコメントなど別の種類である可能性も考慮し、instanceof DOMNotationで型をチェックしてからプロパティにアクセスすると、より安全なコードになります。