【PHP8.x】DOMDocumentFragment::isDefaultNamespace()メソッドの使い方

Copy
1<?php
2
3/**
4 * DOMDocumentFragment クラスの isDefaultNamespace メソッドのサンプル。
5 *
6 * DOMDocumentFragment は XML ドキュメントの断片を保持するコンテナであり、
7 * それ自身は名前空間のコンテキストを持たないため、
8 * isDefaultNamespace メソッドを呼び出すと常に false を返します。
9 * このメソッドは、通常 DOMElement など、実際に名前空間を持つノードに対して、
10 * そのノードが指定された名前空間をデフォルト名前空間として使用しているかを確認するために使用されます。
11 */
12function demonstrateDomDocumentFragmentIsDefaultNamespace(): void
13{
14    // 新しい DOMDocument インスタンスを作成
15    $dom = new DOMDocument('1.0', 'UTF-8');
16
17    // DOMDocumentFragment インスタンスを作成
18    // これは、ドキュメントに追加される XML の断片を表します。
19    $fragment = $dom->createDocumentFragment();
20
21    // 確認したい名前空間URIを定義
22    $namespaceUri = 'http://example.com/mynamespace';
23
24    // DOMDocumentFragment の isDefaultNamespace メソッドを呼び出す
25    // DOMDocumentFragment は名前空間のコンテキストを持たないため、
26    // どの名前空間URIに対しても false が返されます。
27    $isDefault = $fragment->isDefaultNamespace($namespaceUri);
28
29    echo "指定された名前空間 '{$namespaceUri}' が DOMDocumentFragment のデフォルト名前空間か: " . ($isDefault ? 'はい' : 'いいえ') . "\n";
30
31    // 別の名前空間URIでも試す
32    $anotherNamespaceUri = 'http://www.w3.org/2000/svg';
33    $isAnotherDefault = $fragment->isDefaultNamespace($anotherNamespaceUri);
34    echo "指定された名前空間 '{$anotherNamespaceUri}' が DOMDocumentFragment のデフォルト名前空間か: " . ($isAnotherDefault ? 'はい' : 'いいえ') . "\n";
35}
36
37// 関数を実行
38demonstrateDomDocumentFragmentIsDefaultNamespace();

DOMDocumentFragment::isDefaultNamespaceメソッドは、指定された名前空間URIがXMLノードのデフォルト名前空間として使用されているかを確認するために使用されます。引数 $namespace には確認したい名前空間のURI（Uniform Resource Identifier）を文字列で指定し、戻り値はデフォルト名前空間であれば true、そうでなければ false の真偽値を返します。

しかし、このメソッドが所属する DOMDocumentFragment クラスは、XMLドキュメントの断片を扱うためのコンテナであり、それ自身は名前空間のコンテキストを持ちません。そのため、DOMDocumentFragment インスタンスに対して isDefaultNamespace メソッドを呼び出すと、どの名前空間URIを指定した場合でも常に false が返されます。

サンプルコードでは、DOMDocumentFragment を作成し、異なる名前空間URIでこのメソッドを呼び出していますが、いずれの場合も false が出力されることを示しています。このメソッドは通常、DOMElement のような、実際に名前空間を持つノードが、指定された名前空間をデフォルトとして使用しているかを確認する際に利用されるものです。

Copy
1<?php
2
3/**
4 * DOMDocumentFragment::isDefaultNamespace メソッドの使用例をデモンストレーションします。
5 *
6 * この関数は、XMLにおけるデフォルト名前空間の「定義」と、
7 * DOMDocumentFragmentインスタンスがその名前空間をデフォルトとして持つかどうかの「判定」を示します。
8 * DOMDocumentFragmentは名前空間のコンテキストを持たないため、
9 * isDefaultNamespaceメソッドを呼び出した場合、常にfalseを返します。
10 *
11 * @return void
12 */
13function demonstrateDomDocumentFragmentIsDefaultNamespace(): void
14{
15    // 1. DOMDocument を作成し、XMLのルート要素にデフォルト名前空間を定義します。
16    $dom = new DOMDocument('1.0', 'UTF-8');
17    $dom->formatOutput = true; // 出力されるXMLを整形して見やすくする
18
19    // ここでXMLのデフォルト名前空間を「定義」します。
20    // これは、XML要素に `xmlns="http://example.com/ns/default"` の形式で
21    // 名前空間を割り当てることに相当します。
22    $defaultNamespaceUri = 'http://example.com/ns/default';
23    $root = $dom->createElementNS($defaultNamespaceUri, 'root');
24    $dom->appendChild($root);
25
26    echo "--- XML 名前空間の定義と判定のデモンストレーション ---\n";
27    echo "XMLルート要素に定義されたデフォルト名前空間URI: '$defaultNamespaceUri'\n\n";
28
29    // 2. DOMDocumentFragment を作成します。
30    // DOMDocumentFragmentは、XMLドキュメントツリーの一部ではない、軽量なコンテナです。
31    // それ自身は直接的な名前空間の概念やデフォルト名前空間を持ちません。
32    $fragment = $dom->createDocumentFragment();
33
34    // 3. DOMDocumentFragment インスタンスに対して isDefaultNamespace を呼び出します。
35    // PHPのDOMNode::isDefaultNamespaceの仕様により、DOMDocumentFragmentのようなノードは、
36    // 要素ノード (DOMElement) や属性ノード (DOMAttr) ではないため、
37    // 常に false を返します。
38    $isDefaultForFragment = $fragment->isDefaultNamespace($defaultNamespaceUri);
39
40    echo "DOMDocumentFragment が '$defaultNamespaceUri' をデフォルト名前空間として持つか: ";
41    echo ($isDefaultForFragment ? 'はい' : 'いいえ') . "\n";
42    echo "(補足: DOMDocumentFragmentは名前空間のコンテキストを持たないため、常に 'いいえ' を返します。)\n\n";
43
44    // 比較のために、デフォルト名前空間を持つ「要素ノード」であるルート要素に対して
45    // isDefaultNamespace を呼び出します。
46    // これにより、isDefaultNamespaceメソッドが要素ノードに対してどのように機能するかを示します。
47    $isDefaultForRootElement = $root->isDefaultNamespace($defaultNamespaceUri);
48
49    echo "XMLルート要素 'root' が '$defaultNamespaceUri' をデフォルト名前空間として持つか: ";
50    echo ($isDefaultForRootElement ? 'はい' : 'いいえ') . "\n";
51    echo "(補足: このルート要素は '$defaultNamespaceUri' をデフォルト名前空間として定義しているので 'はい' となります。)\n";
52}
53
54// スクリプトが直接実行された場合にデモンストレーション関数を呼び出す
55demonstrateDomDocumentFragmentIsDefaultNamespace();

DOMDocumentFragment::isDefaultNamespaceメソッドは、XMLの名前空間（namespace）がノードのデフォルト名前空間であるかどうかを判定するために使用します。引数string $namespaceには、確認したい名前空間のURIを指定し、戻り値として真偽値（bool）を返します。指定されたURIがノードのデフォルト名前空間であればtrue、そうでなければfalseです。

しかしながら、DOMDocumentFragmentはXMLドキュメントの断片を一時的に保持する軽量なコンテナであり、それ自体は名前空間のコンテキストを持ちません。そのため、このメソッドをDOMDocumentFragmentインスタンスに対して呼び出した場合、引数にどのような名前空間URIを指定しても、常にfalseが戻り値として返されます。

サンプルコードでは、まずDOMDocumentを用いて「http://example.com/ns/default」というURIをデフォルト名前空間として定義したルート要素を作成します。その後、`DOMDocumentFragment`に対してこのデフォルト名前空間URIを使って`isDefaultNamespace`を呼び出すと、「いいえ」と表示され、常に`false`が返される挙動が確認できます。比較として、実際にデフォルト名前空間を定義しているルート要素に対してこのメソッドを呼び出すと、「はい」と表示され、`true`が返されることが示されており、`isDefaultNamespace`メソッドは名前空間を持つノードに対して機能することが理解できます。