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

Copy
1<?php
2
3/**
4 * DOMNotation::publicId プロパティの使用例を示します。
5 * この関数は、XMLドキュメントからNOTATIONを抽出し、そのPUBLIC識別子を表示します。
6 *
7 * @return void
8 */
9function demonstrateDomNotationPublicId(): void
10{
11    // XML文字列を定義します。DOCTYPE宣言にNOTATION要素が含まれています。
12    // NOTATIONは、外部の非XMLデータを参照するために使われます。
13    // この例では、PUBLIC識別子を持つNOTATIONを定義しています。
14    $xmlString = <<<XML
15<!DOCTYPE root [
16  <!NOTATION MyPdfViewer PUBLIC "-//Example//PDF Viewer 1.0//EN" "http://example.com/pdfviewer.app">
17  <!ELEMENT root EMPTY>
18]>
19<root/>
20XML;
21
22    $dom = new DOMDocument();
23    // 厳密なエラーチェックを有効にします（必須ではありませんが、良い習慣です）。
24    $dom->validateOnParse = true;
25    $dom->loadXML($xmlString);
26
27    // DOMDocumentTypeオブジェクトを取得します。これはXMLのDOCTYPE宣言の情報を含みます。
28    $docType = $dom->doctype;
29
30    // ドキュメントタイプが存在し、かつNOTATIONのリストがあるかを確認します。
31    if ($docType instanceof DOMDocumentType && $docType->notations !== null) {
32        echo "XMLドキュメントにNOTATIONが検出されました。\n";
33
34        // DOMNamedNodeMapであるnotationsプロパティを反復処理します。
35        foreach ($docType->notations as $notationName => $notation) {
36            // 各項目がDOMNotationのインスタンスであることを確認します。
37            if ($notation instanceof DOMNotation) {
38                echo "  NOTATION名: {$notation->nodeName}\n";
39
40                // publicIdプロパティは、XMLのPUBLIC識別子（公開識別子）を返します。
41                // このプロパティはDOMNotationクラスの 'public' メンバーであり、
42                // オブジェクトの外部から直接アクセス可能です。
43                $publicId = $notation->publicId;
44
45                if ($publicId !== null) {
46                    echo "  - PUBLIC ID (公開識別子): '" . $publicId . "'\n";
47                } else {
48                    echo "  - PUBLIC ID (公開識別子): (設定されていません)\n";
49                }
50
51                // 補足: systemIdプロパティは、リソースのURIなどを返しますが、
52                // これはPHPの'private'アクセス修飾子とは関連しません。
53                // XMLにおける'PUBLIC'識別子と'SYSTEM'識別子は異なる目的を持ちます。
54                $systemId = $notation->systemId;
55                if ($systemId !== null) {
56                    echo "  - SYSTEM ID (システム識別子): '" . $systemId . "'\n";
57                } else {
58                    echo "  - SYSTEM ID (システム識別子): (設定されていません)\n";
59                }
60            }
61        }
62    } else {
63        echo "XMLドキュメントにDOCTYPE宣言、またはNOTATIONが検出されませんでした。\n";
64    }
65}
66
67// 関数を実行して、DOMNotation::publicId の動作を確認します。
68demonstrateDomNotationPublicId();

PHPのDOMNotation::publicIdプロパティは、XMLドキュメントのDOCTYPE宣言内で定義されるNOTATION（表記法）の「公開識別子（PUBLIC ID）」を取得するために使用されます。NOTATIONは、XMLが直接処理できない外部のデータ形式（例えば画像やPDFなど）を参照する際に使われる概念です。

このプロパティは、DOMNotationクラスのインスタンスから直接アクセスでき、NOTATIONにPUBLIC識別子が設定されていればその識別子を文字列（string）として返します。設定されていない場合はnullが返されます。

サンプルコードでは、NOTATIONを含むXML文字列を定義し、それをDOMDocumentにロードしています。その後、DOMDocumentからDOMDocumentTypeオブジェクトを取得し、その中のnotationsプロパティを調べてNOTATION情報を抽出しています。foreachループで各NOTATIONにアクセスし、DOMNotation::publicIdプロパティを通じてPUBLIC識別子を取得し、その値を画面に表示しています。

ここで注意していただきたいのは、プロパティ名に含まれる「public」は、PHPにおけるクラスメンバーのアクセス修飾子（publicやprivateなど）とは異なる文脈で使われている点です。publicIdプロパティ自体は、どのPHPコードからでもアクセス可能なpublicなメンバーですが、その「public」という言葉自体はXMLのNOTATIONにおける「公開識別子」という概念を指します。これにより、外部のリソースに対する標準的な参照方法を提供します。

Copy
1<?php
2
3/**
4 * XMLドキュメントから指定されたNOTATIONのpublicIdを取得します。
5 *
6 * この関数は、XMLのDTD（Document Type Definition）内で定義されるNOTATION（記法）に関する情報を扱います。
7 * DOMNotationクラスのpublicIdプロパティは、そのNOTATIONの公開識別子（PUBLIC ID）を返します。
8 * 公開識別子とは、特定の外部エンティティを一意に識別するための標準的な文字列です。
9 *
10 * @param string $xmlString XMLコンテンツ文字列。DOCTYPE宣言を含める必要があります。
11 * @param string $notationName 検索するNOTATIONの名前。
12 * @return string|null 指定されたNOTATIONのpublicId、または見つからない場合はnull。
13 */
14function getNotationPublicId(string $xmlString, string $notationName): ?string
15{
16    // DOMDocumentの新しいインスタンスを作成し、XMLを解析します。
17    $dom = new DOMDocument();
18
19    // XMLのパース中に発生する可能性のあるエラーを内部で処理し、警告を抑制します。
20    // これにより、XMLにわずかな構文エラーがあっても、処理を続行できる場合があります。
21    libxml_use_internal_errors(true);
22    $loaded = $dom->loadXML($xmlString);
23    // エラーをチェックした後、内部エラーハンドラをクリアします。
24    libxml_clear_errors();
25
26    if (!$loaded) {
27        echo "エラー: XMLのパースに失敗しました。\n";
28        return null;
29    }
30
31    // ドキュメントのDOCTYPE（ドキュメント型宣言）を取得します。
32    // NOTATIONはDOCTYPE内に定義されるため、ここからアクセスします。
33    $doctype = $dom->doctype;
34
35    if ($doctype === null) {
36        echo "情報: XMLドキュメントにDOCTYPE宣言が見つかりませんでした。\n";
37        return null;
38    }
39
40    // DOCTYPEから、定義されているすべてのNOTATIONのリストを取得します。
41    $notations = $doctype->notations;
42
43    if ($notations === null || $notations->length === 0) {
44        echo "情報: DOCTYPE内にNOTATIONが定義されていませんでした。\n";
45        return null;
46    }
47
48    // NOTATIONのリストをループし、指定された名前のNOTATIONを探します。
49    foreach ($notations as $notation) {
50        // 現在の要素がDOMNotationオブジェクトであることを確認します。
51        // @var DOMNotation $notation
52        if ($notation instanceof DOMNotation && $notation->nodeName === $notationName) {
53            // DOMNotation::publicId プロパティは、NOTATIONの公開識別子を返します。
54            // 公開識別子が定義されていない場合は null を返します。
55            echo "NOTATION '{$notationName}' のシステムID: " . ($notation->systemId ?? 'なし') . "\n";
56            return $notation->publicId;
57        }
58    }
59
60    echo "情報: 指定されたNOTATION '{$notationName}' がXMLドキュメント内で見つかりませんでした。\n";
61    return null;
62}
63
64// --- サンプルコードの実行 ---
65
66// NOTATIONを含むXML文字列を定義します。
67// ここでは、'my_app_notation' というNOTATIONがPUBLIC ID 'MY_UNIQUE_IDENTIFIER' で定義されています。
68$sampleXmlWithPublicId = <<<XML
69<?xml version="1.0" encoding="UTF-8"?>
70<!DOCTYPE root [
71  <!NOTATION my_app_notation PUBLIC "MY_UNIQUE_IDENTIFIER" "http://example.com/myapp.dtd">
72  <!NOTATION other_notation SYSTEM "http://example.com/other.dtd">
73]>
74<root>
75    <data/>
76</root>
77XML;
78
79echo "--- publicIdの取得例 (Public IDあり) ---\n";
80$publicId = getNotationPublicId($sampleXmlWithPublicId, 'my_app_notation');
81if ($publicId !== null) {
82    echo "NOTATION 'my_app_notation' のPublic ID: '{$publicId}'\n";
83    // 期待される出力: NOTATION 'my_app_notation' のPublic ID: 'MY_UNIQUE_IDENTIFIER'
84} else {
85    echo "NOTATION 'my_app_notation' のPublic IDは取得できませんでした。\n";
86}
87
88echo "\n--- publicIdの取得例 (Public IDなし、SYSTEM IDのみ) ---\n";
89$systemOnlyPublicId = getNotationPublicId($sampleXmlWithPublicId, 'other_notation');
90if ($systemOnlyPublicId === null) {
91    echo "NOTATION 'other_notation' はPublic IDを持たないため、nullが返されました。\n";
92    // 期待される出力: NOTATION 'other_notation' はPublic IDを持たないため、nullが返されました。
93} else {
94    echo "NOTATION 'other_notation' のPublic ID: '{$systemOnlyPublicId}'\n";
95}
96
97echo "\n--- publicIdの取得例 (存在しないNOTATION) ---\n";
98$nonExistentPublicId = getNotationPublicId($sampleXmlWithPublicId, 'non_existent_notation');
99if ($nonExistentPublicId === null) {
100    echo "NOTATION 'non_existent_notation' のPublic IDは取得できませんでした。\n";
101    // 期待される出力: NOTATION 'non_existent_notation' のPublic IDは取得できませんでした。
102}
103
104echo "\n--- publicIdの取得例 (DOCTYPEなし) ---\n";
105$xmlWithoutDoctype = <<<XML
106<?xml version="1.0"?>
107<root><data/></root>
108XML;
109$publicIdNoDoctype = getNotationPublicId($xmlWithoutDoctype, 'any_notation');
110if ($publicIdNoDoctype === null) {
111    echo "DOCTYPE宣言がないため、Public IDは取得できませんでした。\n";
112    // 期待される出力: DOCTYPE宣言がないため、Public IDは取得できませんでした。
113}

PHP 8のDOMNotationクラスにあるpublicIdプロパティは、XMLドキュメントのDOCTYPE宣言内で定義されるNOTATION（記法）の情報を取得するために使われます。NOTATIONは、XML外部のデータ形式や処理方法を宣言するもので、その中に「公開識別子（PUBLIC ID）」が含まれることがあります。このpublicIdプロパティは、まさにその公開識別子を取得するためのものです。

公開識別子とは、特定の外部リソースを一意に識別するための、国際標準などで定められた文字列を指します。PHPのアクセス修飾子「public」とは異なり、このpublicIdの「public」はXMLの文脈における「公開」を意味します。

サンプルコードは、与えられたXML文字列からDOCTYPE宣言を解析し、指定された名前のNOTATIONを見つけ出す一連の流れを示しています。そして、見つかったDOMNotationオブジェクトのpublicIdプロパティにアクセスすることで、そのNOTATIONの公開識別子を読み取っています。このプロパティは引数を必要とせず、公開識別子がXML内で定義されていればstring型でその値を返し、定義されていない場合にはnullを返します。例えば、PUBLICキーワードを用いて定義されたNOTATIONからは具体的な識別子が得られますが、SYSTEMキーワードのみで定義されたNOTATIONからはnullが返される挙動が確認できます。このように、publicIdプロパティを用いることで、XMLの外部参照情報をプログラムから効率的に取得し、利用することができます。