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

Copy
1<?php
2
3/**
4 * Dom\Notation クラスの firstChild プロパティの使用例を示します。
5 *
6 * Notationノードは、DTD(文書型定義)内で定義される表記宣言を表します。
7 * DOMの仕様上、Notationノードは子ノードを持つことができないため、
8 * firstChildプロパティは常にnullを返します。
9 * このコードは、実際にNotationノードを取得し、そのfirstChildがnullであることを確認します。
10 */
11function demonstrateNotationFirstChild(): void
12{
13    // DTD内で'jpeg'という名前のNotationを定義したXML文字列
14    $xmlString = <<<XML
15    <?xml version="1.0" encoding="UTF-8"?>
16    <!DOCTYPE root [
17      <!NOTATION jpeg SYSTEM "image/jpeg">
18    ]>
19    <root/>
20    XML;
21
22    // DOMDocumentオブジェクトをインスタンス化
23    $dom = new DOMDocument();
24
25    // DTDを解析するために、XMLを読み込む前にvalidateOnParseをtrueに設定
26    $dom->validateOnParse = true;
27    $dom->loadXML($xmlString);
28
29    // DocumentTypeノード (<!DOCTYPE ...> の部分) を取得
30    $docType = $dom->doctype;
31
32    // DocumentTypeが存在し、Notationが含まれているかを確認
33    if ($docType && $docType->notations) {
34        // 'jpeg'という名前のNotationノード (Dom\Notationオブジェクト) を取得
35        /** @var ?Dom\Notation $notation */
36        $notation = $docType->notations->getNamedItem('jpeg');
37
38        if ($notation) {
39            // Notationノードの最初の子ノードを取得
40            // Notationノードは子を持てないため、ここは常にnullになります
41            $firstChild = $notation->firstChild;
42
43            echo "Dom\Notation の publicId: " . $notation->publicId . PHP_EOL;
44            echo "Dom\Notation の systemId: " . $notation->systemId . PHP_EOL;
45
46            echo 'Dom\Notation->firstChild の値: ';
47            var_dump($firstChild); // 出力結果は NULL となります
48        } else {
49            echo "Notation 'jpeg' が見つかりませんでした。" . PHP_EOL;
50        }
51    } else {
52        echo 'DTDまたはNotationが見つかりませんでした。' . PHP_EOL;
53    }
54}
55
56// 関数を実行
57demonstrateNotationFirstChild();

PHPのDom\Notationクラスに所属するfirstChildプロパティは、Notationノードの最初の子ノードを取得するために使用されます。Notationノードとは、XML文書のDTD（文書型定義）内で、画像や外部アプリケーションのデータ形式など、XMLパーサが直接解釈しないデータの種類を定義するものです。

このプロパティに引数はなく、戻り値は最初の子ノードを表すDom\Nodeオブジェクト、または子ノードが存在しない場合はnullです。

ここで重要な点は、DOMの仕様上、Notationノードは子ノードを持つことができないと定められていることです。そのため、Dom\NotationオブジェクトのfirstChildプロパティは、常にnullを返します。

サンプルコードでは、DTDを含むXML文書を読み込み、'jpeg'という名前のNotationノードを取得しています。そして、そのfirstChildプロパティの値を確認すると、仕様通りnullが出力されることをvar_dump関数を使って示しています。これは、Notationノードが子を持てないというルールを実際にコードで確認する例です。