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

Copy
1<?php
2
3// このコードは、PHPのDOM拡張機能を使ってXMLドキュメントを解析し、
4// DOCTYPE宣言内のNOTATION（記法）宣言からpublicIdプロパティを取得する方法を示します。
5// また、publicIdが「public」なプロパティであることと、
6// PHPにおけるpublic/privateアクセス修飾子の基本的な違いについても説明します。
7
8// XML ドキュメントを作成します。
9// DOCTYPE 宣言に NOTATION (記法) 宣言を含めます。
10// NOTATION 宣言は、XML ドキュメント内で外部データを参照する方法を定義します。
11// ここでは "my_notation" という名前の NOTATION を定義し、PUBLIC 識別子と SYSTEM 識別子を持たせます。
12$xmlString = <<<XML
13<?xml version="1.0"?>
14<!DOCTYPE root [
15  <!NOTATION my_notation PUBLIC "urn:example:public-id" "file:///path/to/system-id">
16  <!ELEMENT root EMPTY>
17]>
18<root/>
19XML;
20
21// DOMDocument オブジェクトを作成し、XML 文字列をロードします。
22$dom = new DOMDocument();
23$dom->loadXML($xmlString);
24
25// ドキュメントタイプ (DOCTYPE) ノードを取得します。
26$doctype = $dom->doctype;
27
28// ドキュメントタイプが存在し、かつ NOTATION (記法) が定義されている場合
29if ($doctype instanceof DOMDocumentType && $doctype->notations !== null) {
30    echo "--- Dom\\Notation の publicId プロパティの取得 ---" . PHP_EOL;
31
32    // 定義されている各 NOTATION をループ処理します。
33    foreach ($doctype->notations as $notation) {
34        // $notation は Dom\Notation クラスのインスタンスです。
35        if ($notation instanceof Dom\Notation) {
36            // publicId は Dom\Notation クラスの public プロパティです。
37            // public プロパティは、クラスの外部から直接アクセス（読み書き）できるプロパティです。
38            // 対照的に private プロパティは、そのクラスの内部からのみアクセス可能です。
39            echo "Notation Name: " . $notation->nodeName . PHP_EOL;
40            echo "  Public ID: " . ($notation->publicId ?? 'N/A') . PHP_EOL; // publicId は ?string (stringまたはnull) なので null の可能性も考慮
41            echo "  System ID: " . ($notation->systemId ?? 'N/A') . PHP_EOL;
42            echo PHP_EOL;
43        }
44    }
45} else {
46    echo "DOCTYPE または NOTATION が見つかりませんでした。" . PHP_EOL;
47}

Dom\Notation::publicId プロパティは、PHPのDOM拡張機能の一部として、XMLドキュメントのDOCTYPE宣言内に定義されるNOTATION（記法）宣言のPUBLIC識別子を取得するために使用されます。NOTATION宣言は、XMLドキュメント内で外部のデータや形式を参照する方法を定義するもので、通常は特定の公開識別子とシステム識別子を持ちます。

このプロパティにアクセスすると、該当するNOTATION宣言にPUBLIC識別子が定義されていれば、その識別子の文字列が返されます。もしPUBLIC識別子が存在しない場合は、nullが返されるため、戻り値の型は?string（文字列またはnull）となります。

publicIdは「public」プロパティであり、これはクラスの外部から直接アクセスできるプロパティであることを意味します。これに対し、「private」プロパティは、そのプロパティが定義されているクラスの内部からのみアクセス可能です。サンプルコードでは、まずXML文字列からDOMDocumentオブジェクトを作成し、DOCTYPEノードを通じてNOTATIONの一覧を取得しています。その後、取得したDom\NotationインスタンスのpublicIdプロパティに直接アクセスして、その値を出力する具体的な方法が示されています。値がnullの場合に備え、?? 'N/A'を使って代替表示を行う例も含まれています。

Copy
1<?php
2
3/**
4 * XMLドキュメント内のNOTATION要素からpublicIdプロパティを取得し表示するサンプルコードです。
5 * Dom\Notation::publicId は、XML DTDで定義されたNOTATIONの公開識別子 (public identifier) を表します。
6 * publicIdはDom\Notationクラスのpublicプロパティであり、外部から直接アクセスできます。
7 */
8function demonstrateDomNotationPublicId(): void
9{
10    // XML文書を文字列で定義します。
11    // ここでは、DTD内で2つのNOTATIONを定義し、それぞれpublicIdを設定しています。
12    $xmlString = <<<XML
13<?xml version="1.0" encoding="UTF-8"?>
14<!DOCTYPE root [
15  <!NOTATION gif-image PUBLIC "-//W3C//DTD GIF 89a//EN" "gif.dtd">
16  <!NOTATION png-image PUBLIC "PNG 1.0 Specification" "png.dtd">
17  <!NOTATION my-system-only-notation SYSTEM "system.dtd">
18]>
19<root/>
20XML;
21
22    // DOMDocumentオブジェクトを作成し、XMLをロードします。
23    $dom = new DOMDocument();
24    $dom->loadXML($xmlString);
25
26    // ドキュメントタイプ (DTD) を取得します。
27    // DTDがない場合や読み込めない場合はnullになることがあります。
28    $doctype = $dom->doctype;
29
30    if ($doctype !== null && $doctype->notations !== null) {
31        echo "XMLドキュメントに定義されている表記 (Notation) のPublic ID:\n";
32
33        // ドキュメントタイプから定義されている表記 (notations) のリストを反復処理します。
34        foreach ($doctype->notations as $notationName => $notation) {
35            // Dom\NotationオブジェクトのpublicIdプロパティにアクセスします。
36            // このプロパティは?string型であり、public識別子が定義されていない場合はnullになります。
37            $publicId = $notation->publicId;
38
39            echo "  表記名: " . $notationName;
40            if ($publicId !== null) {
41                echo ", Public ID: '" . $publicId . "'\n";
42            } else {
43                echo ", Public ID: (定義なし)\n";
44            }
45        }
46    } else {
47        echo "XMLドキュメントにドキュメントタイプ (DTD) または表記 (Notation) が定義されていません。\n";
48    }
49}
50
51// サンプル関数を実行します。
52demonstrateDomNotationPublicId();

PHPのDom\Notation::publicIdは、XML文書のDTD（Document Type Definition）で定義されるNOTATION（表記）要素の公開識別子（Public ID）を取得するためのプロパティです。このプロパティはpublicなアクセス修飾子を持つため、Dom\Notationクラスのインスタンスから直接アクセスして値を取得できます。プロパティの型は?stringとなっており、公開識別子がXML内で定義されていれば文字列が返され、定義されていない場合はnullとなります。

サンプルコードでは、まずDTD内でNOTATIONが定義されたXML文字列をDOMDocumentオブジェクトにロードします。次に、$dom->doctypeを通じてドキュメントタイプを取得し、その中のnotationsプロパティから定義されているすべての表記のリストを反復処理します。各Dom\Notationオブジェクトに対して$notation->publicIdにアクセスすることで、対応する公開識別子を取得し、その値と定義の有無を表示しています。これにより、XML文書が外部リソースを参照する際の識別子情報を効率的に扱うことが可能となります。