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

Copy
1<?php
2
3/**
4 * DOMNotation::systemId プロパティの使用例をデモンストレーションします。
5 *
6 * この関数は、DTD (Document Type Definition) 内に SYSTEM 識別子を持つ NOTATION
7 * 宣言を含む XML ドキュメントを解析し、DOMNotation オブジェクトからその
8 * systemId プロパティの値を取得する方法を示します。
9 *
10 * システムエンジニアを目指す初心者の方へ:
11 * - DOM (Document Object Model) は、XML や HTML ドキュメントをオブジェクトとして
12 *   表現し、プログラムからアクセス・操作するための標準的な方法です。
13 * - DTD (Document Type Definition) は、XML ドキュメントの構造や要素、属性などを
14 *   定義するためのルールセットです。
15 * - NOTATION (記法) は、DTD において、解析されないエンティティの形式を定義するために
16 *   使用されます (例: 画像フォーマットやマルチメディア形式)。
17 * - SYSTEM 識別子 は、NOTATION の外部リソースへの URI やシステム固有の識別子を指定します。
18 */
19function demonstrateDomNotationSystemId(): void
20{
21    // 1. SYSTEM 識別子を持つ NOTATION 宣言を含む XML 文字列を定義します。
22    // ここでは 'image-gif' というNOTATIONを定義し、そのSYSTEM識別子として
23    // 'http://example.com/image/gif' を指定しています。
24    $xmlString = <<<XML
25<?xml version="1.0" encoding="UTF-8"?>
26<!DOCTYPE document [
27  <!NOTATION image-gif SYSTEM "http://example.com/image/gif">
28  <!ELEMENT document EMPTY>
29]>
30<document/>
31XML;
32
33    // 2. DOMDocument オブジェクトを作成します。
34    $dom = new DOMDocument();
35
36    // 3. DTD が正しく解析されるように validateOnParse を true に設定します。
37    // これにより、NOTATION などの DTD 情報が DOM ツリーにロードされます。
38    $dom->validateOnParse = true;
39
40    // 4. XML 文字列をロードします。
41    // @ を使用して、DTD の解析に関連しない警告を抑制しています。
42    @$dom->loadXML($xmlString);
43
44    // 5. DOMDocument から DOMDocumentType オブジェクトを取得します。
45    // DOMDocumentType は DTD に関する情報を含んでいます。
46    $docType = $dom->doctype;
47
48    if ($docType !== null) {
49        echo "DOMDocumentType が見つかりました。\n";
50
51        // 6. DOMDocumentType から notations (記法) のコレクションを取得します。
52        $notations = $docType->notations;
53
54        if ($notations !== null && $notations->count() > 0) {
55            echo "NOTATION が " . $notations->count() . " 件見つかりました。\n";
56            foreach ($notations as $notation) {
57                // 各 NOTATION オブジェクトが DOMNotation インスタンスであることを確認します。
58                if ($notation instanceof DOMNotation) {
59                    echo "  NOTATION 名: " . $notation->nodeName . "\n";
60                    // systemId プロパティにアクセスし、その値を出力します。
61                    // systemId は string または null を返すため、null の場合は 'N/A' と表示します。
62                    echo "  SYSTEM ID: " . ($notation->systemId ?? 'N/A') . "\n";
63                    echo "  PUBLIC ID: " . ($notation->publicId ?? 'N/A') . "\n";
64                    echo "  ノード値: " . ($notation->nodeValue ?? 'N/A') . "\n";
65                }
66            }
67        } else {
68            echo "DTD 内に NOTATION は見つかりませんでした。\n";
69        }
70    } else {
71        echo "DOMDocumentType が見つかりませんでした。XML に DTD が含まれていることを確認してください。\n";
72    }
73}
74
75// 関数を実行してデモンストレーションを行います。
76demonstrateDomNotationSystemId();
77
78?>

PHP 8のDOMNotation::systemIdプロパティは、XMLドキュメントのDTD（Document Type Definition）で定義されたNOTATION（記法）に関する情報を提供するものです。このプロパティは引数を取らず、NOTATIONが参照する外部リソースのURIやシステム固有の識別子を表す文字列（string）を返します。該当する識別子が定義されていない場合はnullを返します。

DOM（Document Object Model）は、XMLやHTMLドキュメントをプログラムで操作するための標準的なインターフェースであり、DOMNotationクラスはその中の特定の記法を表現します。サンプルコードでは、まずDTD内で<!NOTATION image-gif SYSTEM "http://example.com/image/gif">のようにSYSTEM識別子を持つNOTATIONを定義したXML文字列を用意します。このXMLをDOMDocumentオブジェクトにロードし、validateOnParseを有効にすることでDTD情報が正しく解析されるようにしています。

次に、DOMDocumentからDOMDocumentTypeオブジェクトを取得し、そこに含まれるnotationsコレクションから個々のDOMNotationオブジェクトを取り出します。そして、各DOMNotationオブジェクトのsystemIdプロパティにアクセスすることで、XMLのDTDに記述された"http://example.com/image/gif"のようなSYSTEM識別子の値を取得し、表示しています。これにより、XMLドキュメントの構造定義に含まれる外部参照情報をプログラムで効率的に扱えることがわかります。

Copy
1<?php
2
3/**
4 * DOMNotation クラスの systemId プロパティの使用例を示します。
5 * systemId は、XMLのDTD (Document Type Definition) 内のNOTATION宣言で
6 * 指定される SYSTEM 識別子（外部リソースのURIなど）を返します。
7 *
8 * この関数は、架空のNOTATION宣言を含むXMLをパースし、
9 * そのNOTATIONのsystemIdを取得して表示します。
10 */
11function demonstrateDomNotationSystemId(): void
12{
13    // NOTATION宣言を含むXML文字列を定義します。
14    // - gif NOTATION は SYSTEM "image/gif" を持ち、systemIdは 'image/gif' になります。
15    // - jpeg NOTATION は PUBLIC "-//W3C//DTD JPEG//EN" を持ち、SYSTEM識別子がないため systemIdは null になります。
16    // - pdf NOTATION は SYSTEM "application/pdf" を持ち、systemIdは 'application/pdf' になります。
17    $xmlString = <<<XML
18<?xml version="1.0" encoding="UTF-8"?>
19<!DOCTYPE root [
20  <!NOTATION gif SYSTEM "image/gif">
21  <!NOTATION jpeg PUBLIC "-//W3C//DTD JPEG//EN">
22  <!NOTATION pdf SYSTEM "application/pdf">
23  <!ELEMENT root EMPTY>
24]>
25<root/>
26XML;
27
28    $dom = new DOMDocument();
29    // XML読み込み時のエラーを内部で処理し、警告などを抑制します。
30    libxml_use_internal_errors(true);
31
32    // XML文字列をDOMDocumentオブジェクトにロードします。
33    if (!$dom->loadXML($xmlString)) {
34        echo "エラー: XMLのロードに失敗しました。\n";
35        // 発生したXMLパースエラーを表示します。
36        foreach (libxml_get_errors() as $error) {
37            echo "  - " . trim($error->message) . "\n";
38        }
39        libxml_clear_errors(); // エラーバッファをクリアします。
40        return;
41    }
42    libxml_use_internal_errors(false); // エラー処理を元に戻します。
43
44    // ドキュメントのDOCTYPE（DTD情報）を取得します。
45    $doctype = $dom->doctype;
46
47    // DTDが存在し、NOTATION宣言が含まれているか確認します。
48    if ($doctype && $doctype->notations) {
49        echo "DOMNotation の systemId プロパティの取得例:\n";
50        // 取得したNOTATION宣言をループで処理します。
51        foreach ($doctype->notations as $notation) {
52            // 現在のノードが DOMNotation クラスのインスタンスであることを確認します。
53            if ($notation instanceof DOMNotation) {
54                $name = $notation->nodeName; // NOTATIONの名前を取得します。
55                $systemId = $notation->systemId; // DOMNotation::systemId プロパティにアクセスします。
56
57                echo "  NOTATION名: '$name'\n";
58                // systemId が null の場合は 'null' と表示し、それ以外は値と共に表示します。
59                echo "    SYSTEM ID: " . (is_null($systemId) ? "null" : "'$systemId'") . "\n";
60            }
61        }
62    } else {
63        echo "XMLドキュメントにDTDまたはNOTATION宣言が見つかりませんでした。\n";
64    }
65}
66
67// 関数を実行してサンプルコードの動作を確認します。
68demonstrateDomNotationSystemId();
69

PHPのDOMNotationクラスに属するsystemIdプロパティは、XMLのDTD（Document Type Definition）内で定義されるNOTATION宣言のSYSTEM識別子を取得する際に使用されます。NOTATION宣言は、XMLドキュメントが利用する外部リソースの種類（例：特定の画像形式やアプリケーション形式）を識別するために用いられます。

このプロパティは、NOTATION宣言でSYSTEMキーワードの後に指定された、外部リソースを特定するためのURIなどを文字列として返します。もし、NOTATION宣言にSYSTEM識別子が指定されておらず、PUBLIC識別子のみが宣言されているような場合は、nullが返されます。戻り値の型はstringまたはnullです。

サンプルコードは、<!NOTATION ... SYSTEM "..." >という形式でSYSTEM識別子を持つものと、持たないものを含むXML文字列を定義しています。DOMDocumentクラスを用いてこのXMLをパースし、ドキュメントのdoctypeプロパティからNOTATION宣言のコレクションを取得します。その後、コレクション内の各DOMNotationオブジェクトに対してsystemIdプロパティにアクセスし、その値を出力しています。これにより、SYSTEM識別子が存在するNOTATIONからは対応する文字列が、存在しないNOTATIONからはnullが取得される挙動を確認できます。この機能は、XMLが参照する外部リソースのタイプをプログラムで特定する際に役立ちます。