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

Copy
1<?php
2
3/**
4 * Dom\Notation の parentNode プロパティの使用例を示します。
5 *
6 * Notationノードは通常、文書型定義（DTD）内に存在します。
7 * このコードでは、DTDを含むXMLを読み込み、特定のNotationノードを取得して、
8 * その親ノード（この場合はDocumentTypeノード）の情報を表示します。
9 */
10function showNotationParentNode(): void
11{
12    // DTD内でNotationが定義されたXML文字列
13    $xmlString = <<<XML
14    <?xml version="1.0" encoding="UTF-8"?>
15    <!DOCTYPE root [
16      <!NOTATION jpg SYSTEM "image/jpeg">
17      <!NOTATION png SYSTEM "image/png">
18    ]>
19    <root>some content</root>
20    XML;
21
22    // DOMDocumentオブジェクトを作成
23    $doc = new DOMDocument();
24
25    // XML文字列を読み込む
26    $doc->loadXML($xmlString);
27
28    // DocumentTypeノード（<!DOCTYPE ...>の部分）を取得
29    // Notationノードの親はDocumentTypeノードです
30    $doctype = $doc->doctype;
31
32    if ($doctype && $doctype->notations) {
33        // 'jpg' という名前のNotationノードを取得
34        // $notationsはDom\NamedNodeMapオブジェクト
35        $notation = $doctype->notations->getNamedItem('jpg');
36
37        if ($notation) {
38            // parentNodeプロパティを使って親ノードを取得
39            $parentNode = $notation->parentNode;
40
41            // 親ノードが存在する場合、その情報を出力
42            if ($parentNode) {
43                echo "Notation '{$notation->nodeName}' を取得しました。\n";
44                echo "親ノードのノード名: " . $parentNode->nodeName . "\n";
45                echo "親ノードのクラス名: " . get_class($parentNode) . "\n";
46            } else {
47                echo "Notation '{$notation->nodeName}' に親ノードが見つかりません。\n";
48            }
49        } else {
50            echo "Notation 'jpg' が見つかりません。\n";
51        }
52    } else {
53        echo "DTDまたはNotationが見つかりません。\n";
54    }
55}
56
57// 関数を実行
58showNotationParentNode();

PHPのDom\Notationクラスに属するparentNodeプロパティは、あるNotationノードがDOMツリー内で属している親ノードを取得するために使用します。このプロパティは値を取得するだけなので、引数はありません。

サンプルコードは、文書型定義（DTD）を含むXML文書を扱っています。Notationノードは、このDTDの中に定義されるのが一般的です。コードでは、まずXMLを読み込んでDOMDocumentオブジェクトを生成し、そこからdoctypeプロパティを使ってDTDを表すDom\DocumentTypeノードを取得します。次に、そのnotationsプロパティから特定のNotationノード（この例では'jpg'）を探し出します。

取得したNotationノードに対してparentNodeプロパティを呼び出すと、その親ノード、つまりこの場合はDom\DocumentTypeノードが返されます。戻り値は、親ノードを表すDom\Nodeオブジェクトですが、親が存在しない状況ではnullを返す可能性があるため、コード内でもif文で存在を確認してから使用しています。このように、parentNodeはDOMの階層構造を遡って要素を特定する際に役立ちます。