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

Copy
1<?php
2
3/**
4 * DOMNotation クラスの previousSibling プロパティの使用例を示します。
5 *
6 * DOMNotation ノードは DTD (Document Type Definition) の一部であり、
7 * 通常のDOMツリーの要素やテキストノードとは異なる特殊なノードです。
8 * DOMNotation ノードの親ノード (parentNode) は常に null であるため、
9 * previousSibling プロパティも常に null を返します。
10 */
11function demonstrateDomNotationPreviousSibling(): void
12{
13    // DTD に NOTATION 宣言を含むシンプルなXML文字列を作成します。
14    $xmlString = <<<XML
15<!DOCTYPE document [
16  <!NOTATION example_notation PUBLIC "example_id">
17  <!ELEMENT document EMPTY>
18]>
19<document/>
20XML;
21
22    $dom = new DOMDocument();
23    $dom->loadXML($xmlString);
24
25    // ドキュメントタイプ (DOCTYPE) を取得します。
26    $doctype = $dom->doctype;
27
28    // ドキュメントタイプが存在し、NOTATION宣言が含まれているか確認します。
29    if ($doctype instanceof DOMDocumentType && $doctype->notations->length > 0) {
30        // 最初の DOMNotation ノードを取得します。
31        // DOMDocumentType::notations は DOMNamedNodeMap を返します。
32        $notationNode = $doctype->notations->item(0);
33
34        if ($notationNode instanceof DOMNotation) {
35            echo "取得した DOMNotation ノード名: " . $notationNode->nodeName . "\n";
36            echo "この DOMNotation ノードの previousSibling プロパティを確認します。\n";
37            
38            $previousSibling = $notationNode->previousSibling;
39
40            if ($previousSibling === null) {
41                echo "結果: previousSibling は null です。\n";
42                echo "理由: DOMNotation ノードはDOMツリーの物理的な階層に属さず、" .
43                     "親ノードを持たないため、兄弟ノードも存在しません。\n";
44            } else {
45                // この分岐は理論上、DOMNotation::previousSibling の場合は実行されません。
46                echo "結果: " . $previousSibling->nodeName . " が返されました。\n";
47            }
48        }
49    } else {
50        echo "DTD または DOMNotation ノードが見つかりませんでした。\n";
51    }
52}
53
54// 関数の実行
55demonstrateDomNotationPreviousSibling();

PHPのDOMNotation::previousSiblingプロパティは、現在のノードの直前にある兄弟ノードを取得するために使用されます。このプロパティに引数はなく、戻り値は直前の兄弟ノードをDOMNodeオブジェクトとして返すか、兄弟ノードが存在しない場合はnullを返します。

しかし、DOMNotationクラスはDTD（Document Type Definition）の一部として定義される特殊なノードであり、通常のXMLドキュメントのDOMツリー構造とは異なる扱いです。DOMNotationノードはXMLドキュメントの論理的な定義に含まれますが、物理的なDOMツリーの階層には直接配置されません。そのため、DOMNotationノードには親ノード（parentNode）が存在せず、常にnullを返します。

このサンプルコードでは、NOTATION宣言を含むXMLドキュメントを生成し、そこからDOMNotationノードを取得しています。取得したDOMNotationノードに対してpreviousSiblingプロパティを呼び出すと、結果は常にnullとなります。これは、DOMNotationノードがDOMツリー内に兄弟関係を持つことがないためです。この例を通して、DOMNotation::previousSiblingが常にnullを返す挙動とその理由を理解できます。

Copy
1<?php
2
3/**
4 * DOMNotation クラスの previousSibling プロパティの使用例を示します。
5 *
6 * DOMNotation は DTD (Document Type Definition) で定義される NOTATION 要素に対応します。
7 * これらのノードは通常のDOMツリーの要素ノードとは異なり、
8 * 一般的には兄弟ノードを持たないため、previousSibling は null を返すことが多いです。
9 *
10 * @link https://www.php.net/manual/ja/class.domnotation.php
11 */
12function showDomNotationPreviousSiblingExample(): void
13{
14    // DTD（Document Type Definition）を含むXML文字列を定義します。
15    // DOMNotation は、DTD内で定義される NOTATION 要素に対応します。
16    $xmlString = <<<XML
17<?xml version="1.0"?>
18<!DOCTYPE root [
19  <!NOTATION gif SYSTEM "image/gif">
20  <!NOTATION jpeg SYSTEM "image/jpeg">
21  <!ELEMENT root EMPTY>
22]>
23<root/>
24XML;
25
26    // DOMDocument オブジェクトを作成し、XMLをロードします。
27    $dom = new DOMDocument();
28    $dom->loadXML($xmlString);
29
30    // ドキュメントタイプ（DTD情報）を取得します。
31    $doctype = $dom->doctype;
32
33    // DTDが存在する場合に処理を進めます。
34    if ($doctype) {
35        // DTDに定義されているすべてのNOTATIONを取得します。
36        // これは DOMNamedNodeMap オブジェクトで、NOTATION名をキーとして DOMNotation オブジェクトを格納します。
37        $notations = $doctype->notations;
38
39        // NOTATIONノードが存在するか確認します。
40        if ($notations->length > 0) {
41            // 最初の DOMNotation ノードを取得します。
42            // DOMNamedNodeMap は順序を保証しませんが、item(0) で最初の要素を取得できます。
43            /** @var DOMNotation $firstNotation */
44            $firstNotation = $notations->item(0);
45
46            // DOMNotation ノードの previousSibling プロパティにアクセスします。
47            // DOMNotation ノードは通常、DOMツリーの通常の要素ノードのような兄弟関係を持たないため、
48            // このプロパティはほとんどの場合 null を返します。
49            // 戻り値の型は ?DOMNode なので、null の可能性も考慮します。
50            $previousSibling = $firstNotation->previousSibling;
51
52            // 結果を出力して確認します。
53            echo "--- DOMNotation::previousSibling の使用例 ---\n";
54            echo "対象のNOTATIONノード名: " . $firstNotation->nodeName . "\n";
55            echo "対象のNOTATIONノードのシステムID: " . $firstNotation->systemId . "\n";
56
57            if ($previousSibling instanceof DOMNode) {
58                echo "前の兄弟ノードが存在します。ノード名: " . $previousSibling->nodeName . "\n";
59                // PHP 8以降では DOMNode::getNodeTypeName() でノードタイプ名を簡単に取得できます。
60                echo "前の兄弟ノードのタイプ: " . DOMNode::getNodeTypeName($previousSibling->nodeType) . "\n";
61            } else {
62                echo "前の兄弟ノードは存在しません (null)。\n";
63            }
64            echo "--------------------------------------------\n";
65        } else {
66            echo "DTD内にNOTATIONノードが見つかりませんでした。\n";
67        }
68    } else {
69        echo "XMLドキュメントにDTDが見つかりませんでした。\n";
70    }
71}
72
73// 関数を実行してサンプルコードの動作を確認します。
74showDomNotationPreviousSiblingExample();

DOMNotation::previousSiblingは、現在のDOMNotationノードの直前にある兄弟ノードを取得するためのプロパティです。DOMNotationは、XMLドキュメントのDTD（Document Type Definition）内で定義されるNOTATION要素を表す特別なノードです。一般的なXML要素ノードと異なり、DOMツリー上での通常の兄弟関係を持つことは稀であるため、このプロパティはほとんどの場合nullを返します。

このプロパティには引数がなく、戻り値は?DOMNode型です。これは、直前の兄弟ノードが存在すればDOMNodeオブジェクトを返しますが、存在しない場合はnullを返すことを意味します。

サンプルコードでは、DTD内に定義されたNOTATION要素を含むXMLを読み込み、その中のDOMNotationノードを取得しています。そして、取得したDOMNotationノードのpreviousSiblingプロパティにアクセスし、通常はnullとなるその挙動を確認しています。これにより、DOMNotationノードの特性とpreviousSiblingの動作が理解できます。