【PHP8.x】prefixプロパティの使い方

prefixプロパティは、XML文書の要素や属性が持つ名前空間プレフィックスを保持するプロパティです。XMLにおいて、名前空間は同じ名前の要素や属性が異なる意味を持つ場合に、それらの衝突を防ぐために使用されます。この名前空間を識別するために、名前の前にコロン（:）で区切られた短い文字列、すなわちプレフィックスが付けられます。たとえば、「soap:Envelope」という要素がある場合、「soap」がそのプレフィックスにあたります。

このprefixプロパティはDOMNotationクラスに属していますが、DOMNotationはXML文書の<!NOTATION ...>宣言を表す特殊なノードタイプです。NOTATION宣言は、XML文書が参照する外部の非XMLデータ形式（例：画像ファイル）やアプリケーションに関する情報を提供するために用いられます。しかし、この種のノードはXMLの名前空間とは直接関連せず、名前空間プレフィックスを持つことはありません。

そのため、DOMNotationオブジェクトのprefixプロパティにアクセスしても、値は常に空文字列が返されます。このプロパティは、主にDOMElementやDOMAttrのように、実際に名前空間が適用され、プレフィックスを持つことが可能なノードタイプで活用されます。DOMNotationオブジェクトでこのプロパティの値を利用する場面は通常ありませんので、その特性を理解しておくことが重要です。

Copy
1<?php
2// DOMNotation オブジェクトを間接的に取得する例です。
3// まず、<!NOTATION ...> 宣言を含むXMLドキュメントを読み込みます。
4$dom = new DOMDocument();
5$dom->loadXML('<!DOCTYPE root [<!NOTATION mynotation SYSTEM "http://example.com/notation-uri">]><root/>');
6
7$notation = null;
8// ドキュメントタイプと、それに含まれるNOTATION宣言があるかを確認します。
9if ($dom->doctype && $dom->doctype->notations && $dom->doctype->notations->length > 0) {
10    // DOCTYPE から最初の DOMNotation オブジェクトを取得します。
11    $notation = $dom->doctype->notations->item(0);
12}
13
14// DOMNotation オブジェクトが正しく取得できた場合
15if ($notation instanceof DOMNotation) {
16    // DOMNotation オブジェクトの prefix プロパティにアクセスし、その値を取得します。
17    // DOMNotation は通常、XML名前空間プレフィックスを持たないため、このプロパティは null または空文字列を返します。
18    $nodePrefix = $notation->prefix;
19
20    // 取得したプレフィックスを出力します。
21    echo "Notation Prefix: " . ($nodePrefix ?? 'NULL');
22} else {
23    echo "DOMNotation オブジェクトが見つかりませんでした。";
24}

引数なし

引数はありません

string

DOMNotation オブジェクトのプレフィックスを表す文字列を返します。