【PHP8.x】DOMDocumentType::namespaceURIプロパティの使い方

Copy
1<?php
2
3/**
4 * DOMDocumentType::namespaceURI プロパティの動作と、XML名前空間についてデモンストレーションします。
5 *
6 * この関数は、DTD（Document Type Definition）を持つXMLをロードし、
7 * そのDOMDocumentTypeオブジェクトから namespaceURI プロパティの値を取得します。
8 *
9 * キーワード「php namespaceとは」について補足：
10 * ここで扱う `namespaceURI` はXMLドキュメントの要素や属性に関連する「XMLの名前空間」の概念です。
11 * PHP言語自体のコード構造を管理し、名前の衝突を防ぐための「PHPの名前空間 (namespace MyProject; など)」とは
12 * 異なる概念であることに注意してください。
13 */
14function demonstrateDomDocumentTypeNamespaceURI(): void
15{
16    // DTD を持つシンプルなXMLドキュメントを定義します。
17    // DTD 自体は通常、XML名前空間とは直接関連しません。
18    $xmlString = <<<XML
19<!DOCTYPE example_doc [
20  <!ELEMENT example_doc (#PCDATA)>
21]>
22<example_doc>
23  これはDTDを持つXMLのサンプルです。
24</example_doc>
25XML;
26
27    $dom = new DOMDocument();
28    // 厳密なエラーチェックを無効にして、DTD のパースエラーで処理が中断されないようにします。
29    $dom->validateOnParse = false;
30    $dom->loadXML($xmlString);
31
32    // ドキュメントタイプ (DTD) オブジェクトを取得します。
33    // DTD が存在する場合、DOMDocumentType のインスタンスが返されます。
34    $documentType = $dom->doctype;
35
36    if ($documentType instanceof DOMDocumentType) {
37        // DOMDocumentType::namespaceURI は、このドキュメント型の名前空間URIを返します。
38        // DTD 自体は通常 XML 名前空間を持たないため、このプロパティはほとんどの場合 null を返します。
39        $namespaceURI = $documentType->namespaceURI;
40
41        echo "DOMDocumentType::namespaceURI: " . (is_null($namespaceURI) ? 'null' : $namespaceURI) . "\n";
42
43        // この結果が 'null' になるのは、DOMDocumentType が表す DTD には
44        // XML 名前空間という概念が適用されないためです。
45        // XML 名前空間は、XMLドキュメント内の要素や属性の識別子を区別するために使われるURIです。
46    } else {
47        echo "DOMDocumentType がXMLドキュメントから見つかりませんでした。\n";
48    }
49}
50
51// 関数を実行して、サンプルコードの動作を確認します。
52demonstrateDomDocumentTypeNamespaceURI();

PHPのDOMDocumentType::namespaceURIは、DOM拡張機能が提供するDOMDocumentTypeオブジェクトのプロパティです。このプロパティは、ドキュメント型の名前空間URIを返します。引数はなく、戻り値は文字列（string）またはnullとなります。

サンプルコードでは、DTD（Document Type Definition）を持つXMLをロードし、そのDOMDocumentTypeオブジェクトからnamespaceURIプロパティの値を取得しています。DTD自体はXML名前空間という概念を持たないため、このプロパティはほとんどの場合nullを返します。そのため、サンプルコードの実行結果もnullとなります。

ここでいうnamespaceURIは、XMLドキュメント内で要素や属性の名前の衝突を防ぎ、識別するために使われる「XMLの名前空間」を指します。「php namespaceとは」というキーワードが示すPHP言語のnamespace（例: namespace MyProject;など）は、PHPコードのクラス名などの名前の衝突を防ぎ、コード構造を整理するためのものです。これらは全く異なる概念ですので混同しないよう注意してください。DOMDocumentType::namespaceURIは、DTDにはXML名前空間が適用されないため、通常nullを返すことを理解しておくことが重要です。

Copy
1<?php
2
3// PHPの推奨コーディングスタイルに従い、App\XmlProcessing 名前空間を定義します。
4// これにより、関連するクラスを整理し、コードの可読性と保守性を高めます。
5namespace App\XmlProcessing;
6
7use DOMDocument;      // グローバル名前空間からDOMDocumentクラスをインポートします。
8                      // これにより、フルパス(例: \DOMDocument)ではなくDOMDocumentと記述できます。
9use DOMDocumentType;  // グローバル名前空間からDOMDocumentTypeクラスをインポートします。
10
11/**
12 * XML/HTMLドキュメントのDocument Type情報を解析するユーティリティクラス。
13 * システムエンジニアを目指す初心者向けに、DOMDocumentType::namespaceURIプロパティの使用例を示します。
14 */
15class DocumentTypeAnalyzer
16{
17    /**
18     * 指定されたマークアップ文字列からDocument Typeの情報を抽出します。
19     * DOMDocumentType::namespaceURIプロパティは、DOCTYPEの場合、通常nullを返します。
20     * これは、DOCTYPE宣言自体がXMLの名前空間に属さないためです。
21     * 戻り値の型はstring|nullなので、nullは有効な値です。
22     *
23     * @param string $markup 解析対象のHTMLまたはXML文字列。
24     * @return array ドキュメントタイプ名とその名前空間URI、または見つからない場合はnullを含む配列。
25     */
26    public function analyzeDocumentType(string $markup): array
27    {
28        $dom = new DOMDocument();
29        // HTMLの読み込み中に発生する警告（例えば、不正なHTML）を抑制します。
30        // プロダクションコードでは、エラーハンドリングを適切に行うべきです。
31        @$dom->loadHTML($markup);
32
33        // DOMDocument::doctypeプロパティでDOMDocumentTypeオブジェクトを取得します。
34        // ドキュメントにDOCTYPE宣言がない場合はnullを返します。
35        $docType = $dom->doctype;
36
37        if ($docType instanceof DOMDocumentType) {
38            return [
39                'name'         => $docType->name,
40                // DOMDocumentType::namespaceURIプロパティの値を取得します。
41                // DOCTYPEでは通常nullですが、これは仕様に沿った動作です。
42                'namespaceURI' => $docType->namespaceURI,
43                'publicId'     => $docType->publicId,
44                'systemId'     => $docType->systemId,
45            ];
46        }
47
48        // DOCTYPEが見つからない場合
49        return [
50            'name'         => null,
51            'namespaceURI' => null,
52            'publicId'     => null,
53            'systemId'     => null,
54        ];
55    }
56}
57
58// --- メインスクリプト部分 ---
59// ここでは、定義した名前空間のクラスを「use」キーワードでインポートし、実際に利用します。
60
61// App\XmlProcessing\DocumentTypeAnalyzerクラスをインポートします。
62// これにより、App\XmlProcessing\DocumentTypeAnalyzerと書かずにDocumentTypeAnalyzerと記述できます。
63use App\XmlProcessing\DocumentTypeAnalyzer;
64
65echo "--- HTMLのDocument Typeを解析しています ---" . PHP_EOL;
66
67// HTMLマークアップの例（XHTML 1.0 TransitionalのDOCTYPEを含む）
68$htmlMarkup = '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
69<html>
70<head><title>My Page</title></head>
71<body>Hello, world!</body>
72</html>';
73
74$analyzer = new DocumentTypeAnalyzer();
75$htmlDocTypeInfo = $analyzer->analyzeDocumentType($htmlMarkup);
76
77echo "HTML DOCTYPE Name: " . ($htmlDocTypeInfo['name'] ?? '見つかりませんでした') . PHP_EOL;
78// DOMDocumentType::namespaceURIは、DOCTYPEの場合、通常nullが出力されます。
79echo "HTML DOCTYPE Namespace URI: " . ($htmlDocTypeInfo['namespaceURI'] ?? '該当なし (null)') . PHP_EOL;
80
81echo PHP_EOL . "--- XMLのDocument Typeを解析しています ---" . PHP_EOL;
82
83// XMLマークアップの例（DTD内部サブセットを含む）
84$xmlMarkup = '<?xml version="1.0"?>
85<!DOCTYPE book SYSTEM "book.dtd" [
86  <!ELEMENT book (title, author)>
87  <!ELEMENT title (#PCDATA)>
88  <!ELEMENT author (#PCDATA)>
89]>
90<book>
91  <title>My Book</title>
92  <author>John Doe</author>
93</book>';
94
95$xmlDocTypeInfo = $analyzer->analyzeDocumentType($xmlMarkup);
96
97echo "XML DOCTYPE Name: " . ($xmlDocTypeInfo['name'] ?? '見つかりませんでした') . PHP_EOL;
98// ここでもDOMDocumentType::namespaceURIはnullが出力されます。
99echo "XML DOCTYPE Namespace URI: " . ($xmlDocTypeInfo['namespaceURI'] ?? '該当なし (null)') . PHP_EOL;
100
101echo PHP_EOL . "--- DOCTYPEのないドキュメントを解析しています ---" . PHP_EOL;
102
103// DOCTYPEのないマークアップの例
104$noDoctypeMarkup = '<body>DOCTYPEはありません</body>';
105$noDocTypeInfo = $analyzer->analyzeDocumentType($noDoctypeMarkup);
106
107echo "DOCTYPE Name: " . ($noDoctypeInfo['name'] ?? '見つかりませんでした') . PHP_EOL;
108echo "DOCTYPE Namespace URI: " . ($noDoctypeInfo['namespaceURI'] ?? '該当なし (null)') . PHP_EOL;
109
110?>

このサンプルコードは、PHPのDOM拡張機能を使ってHTMLやXMLドキュメントのDOCTYPE（文書型宣言）情報を解析する方法を、システムエンジニアを目指す初心者向けに紹介しています。コードの冒頭では、関連するクラスを整理し、コードの可読性を高めるためにnamespace App\XmlProcessing;で名前空間を定義し、useキーワードで他のクラスをインポートしています。これにより、フルパスを記述せずにクラス名だけで利用できます。

主要な部分であるDocumentTypeAnalyzerクラスは、与えられたHTMLやXMLからDOCTYPEに関する情報を抽出します。特に、DOMDocumentType::namespaceURIプロパティの利用方法に焦点を当てています。このプロパティは引数を取りませんが、文書型宣言の名前空間URIを文字列として返します。しかし、DOCTYPE宣言自体はXMLの名前空間に属さないため、通常はnullを返します。これは、string|nullという戻り値の型と一致する、仕様通りの動作です。

analyzeDocumentTypeメソッドでは、まずDOMDocumentでマークアップを読み込み、$dom->doctypeを通じてDOMDocumentTypeオブジェクトを取得します。もしDOCTYPEが存在すれば、その名前やパブリックID、システムIDと共にnamespaceURIプロパティの値も取得し、結果を配列で返します。メインスクリプト部分では、定義したDocumentTypeAnalyzerクラスをuseキーワードでインポートし、HTML、XML、そしてDOCTYPEのないドキュメントの3つのパターンで解析を実行し、それぞれのnamespaceURIの出力結果を確認しています。namespaceURIがnullの場合も「該当なし (null)」として明確に表示されることが示されています。