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

Copy
1<?php
2
3/**
4 * Dom\DocumentType::systemId プロパティの使用例を示す関数です。
5 *
6 * このプロパティは、XMLやHTMLドキュメントのDOCTYPE宣言において、
7 * 外部DTD（Document Type Definition）のシステム識別子（SYSTEMで指定されたURI）を取得します。
8 *
9 * @return void
10 */
11function demonstrateDomDocumentTypeSystemId(): void
12{
13    // DOCTYPE宣言を含むXML文字列を作成します。
14    // ここで SYSTEM "http://example.com/book.dtd" がシステム識別子です。
15    $xmlString = <<<XML
16<!DOCTYPE library SYSTEM "http://example.com/book.dtd">
17<library>
18    <book id="1">
19        <title>サンプルタイトル</title>
20        <author>サンプル著者</author>
21    </book>
22</library>
23XML;
24
25    // Dom\Document オブジェクトを作成し、XML文字列を読み込みます。
26    $dom = new Dom\Document();
27    
28    // XMLを読み込みます。loadXMLが失敗した場合に備えてチェックします。
29    if (!@$dom->loadXML($xmlString)) { // @ はエラー抑制演算子で、厳密なエラー報告を一時的に抑制します。
30        echo "エラー: XML文字列の読み込みに失敗しました。\n";
31        return;
32    }
33
34    // ドキュメントタイプノードを取得します。
35    // Dom\Document::doctype プロパティは、Dom\DocumentType オブジェクトを返します。
36    $doctype = $dom->doctype;
37
38    // ドキュメントタイプが存在し、Dom\DocumentType のインスタンスであることを確認します。
39    if ($doctype instanceof Dom\DocumentType) {
40        // systemId プロパティは、DOCTYPE宣言のSYSTEM識別子（通常はURI）を返します。
41        // これは、外部DTDファイルの位置を示します。
42        echo "ドキュメントタイプ System ID: " . $doctype->systemId . "\n";
43    } else {
44        echo "XML文字列にDOCTYPE宣言が見つかりませんでした。\n";
45    }
46
47    // 補足: この Dom\DocumentType::systemId プロパティは、
48    // PHPのsystem()関数（OSコマンド実行）とは直接関係ありません。
49    // system()関数はOSコマンドを実行するもので、セキュリティ上の注意が必要です。
50}
51
52// 関数の実行
53demonstrateDomDocumentTypeSystemId();
54

Dom\DocumentType::systemIdプロパティは、XMLやHTMLドキュメントのDOCTYPE宣言において、外部DTD（Document Type Definition）のシステム識別子を取得するために使用されます。このプロパティはDom\DocumentTypeクラスに属し、引数を取らず、外部DTDの場所を示すURIなどの識別子を文字列（string）として返します。

サンプルコードでは、まず<!DOCTYPE library SYSTEM "http://example.com/book.dtd">というDOCTYPE宣言を含むXML文字列を作成しています。ここで"http://example.com/book.dtd"がシステム識別子に該当します。次に、Dom\Documentオブジェクトを作成し、このXML文字列を読み込みます。

ドキュメントの読み込みが成功すると、Dom\Documentオブジェクトのdoctypeプロパティを通じて、ドキュメントタイプ情報を表すDom\DocumentTypeオブジェクトを取得します。このDom\DocumentTypeオブジェクトからsystemIdプロパティにアクセスすることで、DOCTYPE宣言のSYSTEMキーワードで指定された識別子、すなわち"http://example.com/book.dtd"という文字列を取得し、画面に表示しています。これにより、XMLが参照している外部DTDファイルの場所をプログラムから知ることができます。

補足として、このDom\DocumentType::systemIdプロパティは、オペレーティングシステムのコマンドを実行するPHPのsystem()関数とは全く関係ありません。system()関数はOSのコマンドを実行する機能であり、セキュリティ上の注意が必要ですが、systemIdプロパティはドキュメントの構造に関する情報を取得するもので、機能目的が大きく異なりますのでご注意ください。

Copy
1<?php
2
3// このスクリプトは、Dom\DocumentType::systemId プロパティの使用方法をデモンストレーションします。
4// これは、HTMLまたはXMLドキュメントのDOCTYPE宣言から「システム識別子」を抽出するのに使われます。
5//
6// システムエンジニアを目指す初心者の方へ:
7// systemId プロパティは、外部DTD（Document Type Definition）のシステム識別子（例：URLやファイルパス）を指します。
8// これは、Linuxのシステムサービス管理ツールである「systemd」とは全く異なる概念です。
9// 「system」という単語が共通しているのは偶然であり、文脈が異なりますのでご注意ください。
10
11/**
12 * 与えられたHTML/XML文字列を解析し、そのDOCTYPE宣言に関する情報を表示します。
13 * 特に systemId プロパティの値を強調します。
14 *
15 * @param string $label 例の説明に使用するラベル。
16 * @param string $content 解析するHTMLまたはXML文字列。
17 * @return void
18 */
19function processDocumentType(string $label, string $content): void
20{
21    echo "--- " . $label . " ---\n";
22
23    $dom = new DOMDocument();
24
25    // エラーや警告を抑制することで、サンプルコードの出力をシンプルに保ちます。
26    // 実際のアプリケーションでは、エラーハンドリングを適切に行うことが推奨されます。
27    
28    // コンテンツがXML宣言で始まる場合は loadXML を使用し、それ以外は loadHTML を使用します。
29    // これにより、XMLとHTMLの両方のDOCCYPEを正確に処理できます。
30    if (strpos(trim($content), '<?xml') === 0) {
31        @$dom->loadXML($content);
32    } else {
33        @$dom->loadHTML($content);
34    }
35
36    // ドキュメントのDOCTYPEノードを取得します。
37    // DOCTYPEが存在する場合、これは Dom\DocumentType (PHP 8以前は DOMDocumentType) のインスタンスになります。
38    $docType = $dom->doctype;
39
40    if ($docType instanceof Dom\DocumentType) {
41        echo "  DOCTYPEが見つかりました。\n";
42        echo "  名前 (name): " . $docType->name . "\n";
43        echo "  公開識別子 (publicId): " . ($docType->publicId ?: '[なし]') . "\n";
44        // ここで Dom\DocumentType::systemId プロパティをデモンストレーションします。
45        echo "  システム識別子 (systemId): " . ($docType->systemId ?: '[なし]') . "\n";
46        echo "  内部サブセット (internalSubset): " . ($docType->internalSubset ?: '[なし]') . "\n";
47    } else {
48        echo "  DOCTYPE宣言が見つかりませんでした。\n";
49    }
50    echo "\n";
51}
52
53// --- サンプルコードの実行 ---
54
55// 例1: HTML5 DOCTYPE (通常、明示的なシステムIDや公開IDは持ちません)
56processDocumentType(
57    "例1: HTML5 DOCTYPE",
58    '<!DOCTYPE html><html><body><h1>Hello HTML5!</h1></body></html>'
59);
60
61// 例2: XHTML 1.0 Strict DOCTYPE (公開IDとシステムIDの両方を持つ典型的な例)
62processDocumentType(
63    "例2: XHTML 1.0 Strict DOCTYPE",
64    '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">' .
65    '<html><head><title>XHTML Page</title></head><body><p>Hello XHTML!</p></body></html>'
66);
67
68// 例3: SYSTEM DTDを持つXMLドキュメント (systemIdはDTDファイルへのパスを示します)
69processDocumentType(
70    "例3: SYSTEM DTDを持つXML",
71    '<?xml version="1.0" encoding="UTF-8"?>' . "\n" .
72    '<!DOCTYPE note SYSTEM "note.dtd">' . "\n" .
73    '<note><to>Tove</to><from>Jani</from><body>Don\'t forget me this weekend!</body></note>'
74);
75
76// 例4: DOCTYPE宣言がないドキュメント
77processDocumentType(
78    "例4: DOCTYPEなし",
79    '<html><body><p>これはDOCTYPE宣言がないシンプルなHTMLです。</p></body></html>'
80);
81
82?>

PHPのDom\DocumentType::systemIdプロパティは、HTMLやXMLドキュメントのDOCTYPE宣言に含まれる「システム識別子」を取得するために使用されます。このプロパティは引数を取らず、システム識別子を表す文字列を返します。もしシステム識別子が存在しない場合は、空文字列を返します。

システム識別子とは、ドキュメントの構造を定義する外部DTD（Document Type Definition）ファイルの場所（URLやファイルパスなど）を示すものです。これにより、ブラウザやパーサーはドキュメントがどのようなルールに基づいて書かれているかを理解できます。

このプロパティは、PHP 8で導入されたDom\DocumentTypeクラスのインスタンスを通じてアクセスします。なお、Linuxのシステムサービス管理ツールである「systemd」と名前が似ていますが、systemIdはドキュメントの構造定義に関する概念であり、システムのサービス管理とは全く関係ありませんので、混同しないようご注意ください。

サンプルコードでは、DOMDocumentクラスを使用して異なるDOCTYPE宣言を持つHTMLやXMLドキュメントを解析し、$dom->doctypeから取得したDom\DocumentTypeオブジェクトのsystemIdプロパティの値を表示しています。例えば、XHTML 1.0 Strictのような外部DTDを指定するドキュメントでは、そのDTDのURLがsystemIdとして正確に抽出されることを確認できます。これにより、プログラムでドキュメントのDTD情報を確認・利用することが可能となります。