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

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * Dom\NotationのnextSiblingプロパティの使用例を示します。
7 *
8 * nextSiblingは、現在のノードの直後にある兄弟ノードを取得する読み取り専用プロパティです。
9 * この例では、DTD(文書型定義)内の最初の記法(Notation)ノードを取得し、
10 * そのnextSiblingプロパティを使って次の記法ノードを取得します。
11 */
12function showNotationNextSiblingExample(): void
13{
14    // DTD内で複数の記法(NOTATION)を宣言したXML文字列を定義します。
15    // これにより、記法ノードが兄弟として隣接して配置されます。
16    $xmlString = <<<XML
17<?xml version="1.0" encoding="UTF-8"?>
18<!DOCTYPE root [
19    <!NOTATION jpeg SYSTEM "image/jpeg">
20    <!NOTATION gif SYSTEM "image/gif">
21    <!NOTATION png SYSTEM "image/png">
22]>
23<root />
24XML;
25
26    // DOMDocumentオブジェクトを作成し、XMLを読み込みます。
27    $dom = new DOMDocument();
28    $dom->loadXML($xmlString);
29
30    // DTDを表すDocumentTypeノードを取得します。
31    // 記法(Notation)はDocumentTypeノードの子ノードとして含まれます。
32    $doctype = $dom->doctype;
33    if ($doctype === null) {
34        echo "DTD (DOCTYPE) が見つかりませんでした。" . PHP_EOL;
35        return;
36    }
37
38    // 最初の記法ノード('jpeg')を取得します。
39    // $doctype->notations は Dom\NamedNodeMap オブジェクトです。
40    $firstNotation = $doctype->notations->item(0);
41
42    if ($firstNotation instanceof \Dom\Notation) {
43        echo "最初の記法ノード名: " . $firstNotation->nodeName . PHP_EOL;
44
45        // nextSiblingプロパティを使い、次の兄弟ノード('gif')を取得します。
46        $secondNotation = $firstNotation->nextSibling;
47
48        // 次の兄弟ノードが存在し、それがDom\Notationインスタンスか確認します。
49        if ($secondNotation instanceof \Dom\Notation) {
50            echo "nextSiblingで取得したノード名: " . $secondNotation->nodeName . PHP_EOL;
51        } elseif ($secondNotation === null) {
52            // 最後のノードのnextSiblingはnullになります。
53            echo "次の兄弟ノードはありません。" . PHP_EOL;
54        } else {
55            // ノード間に空白などがあるとテキストノードとして解釈される場合があります。
56            echo "次の兄弟ノードは記法ノードではありませんでした。Node Type: " . $secondNotation->nodeType . PHP_EOL;
57        }
58    } else {
59        echo "記法ノードが見つかりませんでした。" . PHP_EOL;
60    }
61}
62
63// 関数を実行して結果を表示します。
64showNotationNextSiblingExample();
65

このPHPコードは、Dom\Notationクラスが持つnextSiblingプロパティの具体的な使い方を示しています。nextSiblingは、XML文書の構造上、現在のノードと同じ階層にあり、かつ直後に存在するノード（兄弟ノード）を取得するための読み取り専用プロパティです。このプロパティに引数はありません。

サンプルコードでは、まずDTD（文書型定義）内にjpeg、gif、pngという3つの隣接した記法（Notation）を定義したXMLデータを用意します。DOMDocumentでこのXMLを解析した後、最初の記法ノードであるjpegを取得します。

次に、このjpegノードに対してnextSiblingプロパティを呼び出すことで、そのすぐ隣にある兄弟ノード、すなわちgifノードを取得しています。コードの実行結果では、nextSiblingによって正しく次のノード名が表示されることが確認できます。

このプロパティの戻り値は、次の兄弟ノードが存在すればそのノードを表すDom\Nodeオブジェクト、存在しない場合（現在のノードが最後の場合）はnullとなります。このようにnextSiblingプロパティを利用することで、特定のノードから同じ階層のノードを順番に辿っていく処理を実装できます。