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

Copy
1<?php
2
3/**
4 * DOM要素の名前空間URIをデモンストレーションします。
5 *
6 * この関数は、HTML要素とSVG要素を作成し、それぞれの namespaceURI プロパティの値を出力します。
7 * システムエンジニアを目指す初心者向けに、DOM要素の名前空間の概念と
8 * PHPコードにおける名前空間との違いを説明することを目的としています。
9 */
10function demonstrateDomElementNamespaceUri(): void
11{
12    // Dom\Document は、HTMLやXML文書全体を表現するオブジェクトです。
13    // ここでは新しい文書を作成します。
14    $dom = new Dom\Document();
15
16    // --- 名前空間を持つ要素の例: SVG要素 ---
17    // Dom\Document::createElementNS() を使用して、名前空間を持つ要素を作成します。
18    // SVG (Scalable Vector Graphics) はXMLベースの形式で、特定の名前空間に属します。
19    // 第一引数は名前空間URI、第二引数は要素名です。
20    $svgElement = $dom->createElementNS('http://www.w3.org/2000/svg', 'svg');
21
22    // --- 名前空間を持たない要素の例: HTMLのdiv要素 ---
23    // Dom\Document::createElement() を使用して、一般的なHTML要素を作成します。
24    // HTML要素は通常、名前空間に属しません。
25    $divElement = $dom->createElement('div');
26
27    echo "--- Dom\\Element の namespaceURI プロパティの確認 ---\n";
28
29    // Dom\HTMLElement::namespaceURI (より汎用的な Dom\Element::namespaceURI) プロパティは、
30    // そのDOM要素が属する名前空間のURIを返します。
31    // 名前空間とは、XML/HTMLなどのマークアップ言語において、要素名の衝突を防ぐための識別子です。
32    // (これは、PHPコード内でクラス名の衝突を避けるために使う 'namespace App\Http;'
33    // といったPHPの名前空間とは異なる概念ですので注意してください。)
34
35    // SVG要素の namespaceURI を取得します。
36    // SVG要素は 'http://www.w3.org/2000/svg' という名前空間に属するため、このURIが返されます。
37    $svgNamespaceUri = $svgElement->namespaceURI;
38    echo "SVG要素 (<svg>) の namespaceURI: " . ($svgNamespaceUri ?? 'null') . "\n";
39
40    // HTMLのdiv要素の namespaceURI を取得します。
41    // HTML要素は通常名前空間を持たないため、このプロパティは 'null' を返します。
42    $divNamespaceUri = $divElement->namespaceURI;
43    echo "DIV要素 (<div>) の namespaceURI: " . ($divNamespaceUri ?? 'null') . "\n";
44
45    echo "\n--- まとめ ---\n";
46    echo "Dom\\HTMLElement (および Dom\\Element) の namespaceURI プロパティは、\n";
47    echo "そのDOM要素がXML名前空間を持つ場合にそのURIを返します。\n";
48    echo "例えばSVG要素は特定のURIを持ち、HTML要素は通常 'null' を返します。\n";
49}
50
51// 関数を実行して動作を確認します。
52demonstrateDomElementNamespaceUri();

PHP 8のDom\HTMLElement::namespaceURIプロパティは、そのDOM要素が属する名前空間のURI（Uniform Resource Identifier）を返します。このプロパティは引数を取らず、戻り値として?string、つまり文字列かnullを返します。

XMLやHTMLなどのマークアップ言語において、要素名の衝突を防ぐために使用される識別子が名前空間です。例えば、createElementNSで作成した<svg>要素のようなSVG要素は、特定の名前空間URI（http://www.w3.org/2000/svg）に属します。この場合、namespaceURIプロパティはそのURI文字列を返します。一方、createElementで作成した<div>のような一般的なHTML要素は通常名前空間に属さないため、このプロパティはnullを返します。

サンプルコードでは、Dom\Documentを作成し、createElementNSでSVG要素を生成することで、そのnamespaceURIが「http://www.w3.org/2000/svg」となることを示しています。次にcreateElementでHTMLのdiv要素を生成すると、namespaceURIは「null」を出力します。これは、PHPコードでクラス名の衝突を避けるために使うnamespaceキーワードとは異なる、マークアップ言語における名前空間の概念です。このプロパティは、DOM要素が持つ名前空間情報を確認する際に利用されます。

Copy
1<?php
2
3// PHPのDom拡張モジュールが提供するDom名前空間のクラスを使用するために、
4// 'use' ステートメントを使ってクラスをインポートします。
5// これにより、完全な名前空間パス (例: \Dom\Document) を記述せずに、
6// クラス名 (例: Document) だけで参照できるようになります。
7use Dom\Document;
8use Dom\HTMLElement; // Dom\HTMLElementクラスを使用します
9
10/**
11 * 指定されたXML文字列から特定のタグ名を持つ要素を検索し、
12 * その要素の名前空間URI (namespaceURI) を表示します。
13 *
14 * システムエンジニアを目指す初心者向けに、XML名前空間の概念と
15 * PHPのDom\HTMLElement::namespaceURIプロパティの使用方法を示します。
16 *
17 * @param string $xmlString 処理するXML形式の文字列。
18 * @param string $tagName 検索するHTML/XML要素のタグ名。
19 * @return void
20 */
21function displayElementNamespaceURI(string $xmlString, string $tagName): void
22{
23    // Dom\Documentの新しいインスタンスを作成します。
24    // これはXMLドキュメント全体を表すオブジェクトです。
25    $document = new Document();
26
27    // XML文字列をDomDocumentオブジェクトにロードします。
28    // loadXMLは、パースエラーの場合にfalseを返すことがありますが、
29    // このサンプルでは簡潔さのため、有効なXMLが渡されることを前提とします。
30    if (!$document->loadXML($xmlString)) {
31        echo "エラー: XML文字列のロードに失敗しました。\n";
32        return;
33    }
34
35    // 指定されたタグ名を持つすべての要素を取得します。
36    // これはDom\HTMLCollection（またはDom\NodeList）オブジェクトを返します。
37    $elements = $document->getElementsByTagName($tagName);
38
39    // 要素が見つかったかどうかを確認します。
40    if ($elements->count() > 0) {
41        // 最初の要素を取得します。これは Dom\Element または Dom\HTMLElement のインスタンスになり得ます。
42        $element = $elements->item(0);
43
44        // 取得した要素がDom\HTMLElementのインスタンスであることを確認します。
45        // namespaceURI プロパティは Dom\Element およびその子クラスで利用可能です。
46        if ($element instanceof HTMLElement) {
47            // namespaceURI プロパティは、要素の名前空間URIを返します。
48            // 名前空間がない場合は null を返します (戻り値の型は ?string)。
49            $namespaceURI = $element->namespaceURI;
50
51            echo "要素 '<{$tagName}>' の名前空間URI: ";
52            if ($namespaceURI !== null) {
53                echo $namespaceURI . "\n";
54            } else {
55                echo "なし (null)\n";
56            }
57        } else {
58            echo "エラー: 検索された要素 '<{$tagName}>' は Dom\\HTMLElement のインスタンスではありません。\n";
59        }
60    } else {
61        echo "要素 '<{$tagName}>' が見つかりませんでした。\n";
62    }
63    echo "\n"; // 出力を見やすくするための改行
64}
65
66// --- サンプルコードの実行 ---
67
68// 例1: 名前空間を持つXML (XHTMLをXMLとして扱う)
69$xhtmlString = <<<XML
70<html xmlns="http://www.w3.org/1999/xhtml">
71    <head>
72        <title>サンプルページ</title>
73    </head>
74    <body>
75        <h1>こんにちは、世界！</h1>
76    </body>
77</html>
78XML;
79
80echo "--- 名前空間を持つXMLの例 ---\n";
81// 'html' 要素は "http://www.w3.org/1999/xhtml" という名前空間URIを持ちます。
82displayElementNamespaceURI($xhtmlString, 'html');
83// 'body' 要素も親から名前空間を継承するため、同じ名前空間URIを持ちます。
84displayElementNamespaceURI($xhtmlString, 'body');
85
86// 例2: 名前空間を持たないシンプルなXML
87$noNamespaceXmlString = <<<XML
88<root>
89    <item id="1">アイテム1</item>
90    <item id="2">アイテム2</item>
91</root>
92XML;
93
94echo "--- 名前空間を持たないXMLの例 ---\n";
95// 'root' 要素は名前空間を明示していないため、名前空間URIは null です。
96displayElementNamespaceURI($noNamespaceXmlString, 'root');
97// 'item' 要素も名前空間を明示していないため、名前空間URIは null です。
98displayElementNamespaceURI($noNamespaceXmlString, 'item');
99
100// 例3: 存在しない要素を検索した場合
101echo "--- 存在しない要素の例 ---\n";
102displayElementNamespaceURI($noNamespaceXmlString, 'nonexistent');

Dom\HTMLElement::namespaceURIプロパティは、HTMLやXMLドキュメント内で特定の要素が属する名前空間のURI（Uniform Resource Identifier）を取得するために使用されます。名前空間とは、異なるXMLアプリケーションで同じ名前の要素が使われた際に、それらを区別し衝突を避けるための仕組みです。

このサンプルコードでは、まずuseステートメントを使ってDom\DocumentやDom\HTMLElementといったPHPのDOM拡張機能が提供するクラスをインポートし、コード内で短縮名で利用できるようにしています。次に、Dom\DocumentクラスのインスタンスにXML文字列をロードし、getElementsByTagNameメソッドで指定されたタグ名を持つ要素を検索します。

検索された要素がDom\HTMLElementのインスタンスである場合、そのnamespaceURIプロパティにアクセスすることで、要素の名前空間URIを取得します。このプロパティは引数を取りません。戻り値の型は?stringであり、要素が特定の名前空間に属している場合はそのURIを文字列として返し、名前空間に属していない場合はnullを返します。

実行例を見ると、xmlns属性で名前空間が明示的に定義されたHTML要素からは対応するURIが取得され、名前空間が定義されていないシンプルなXML要素からはnullが返されることが確認できます。これにより、名前空間の有無によるnamespaceURIプロパティの挙動を具体的に理解することができます。