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

Copy
1<?php
2
3// Dom\CDATASection::isDefaultNamespace メソッドのサンプルコード
4// このメソッドは、指定された名前空間URIが、CDATASectionが属するXMLコンテキストの
5// デフォルト名前空間であるかどうかを判定します。
6
7// DOMDocument を作成し、XMLを整形する設定を有効にします。
8$dom = new DOMDocument('1.0', 'UTF-8');
9$dom->formatOutput = true;
10
11// XMLのルート要素を作成し、デフォルト名前空間を定義します。
12// 例: <root xmlns="http://example.com/default-namespace">
13// ここで定義された名前空間が、子ノードのデフォルト名前空間のコンテキストとなります。
14$defaultNamespaceUri = 'http://example.com/default-namespace';
15$root = $dom->createElementNS($defaultNamespaceUri, 'root');
16$dom->appendChild($root);
17
18// CDATASection を作成し、ルート要素の子として追加します。
19// CDATASection自体は名前空間を持ちませんが、親要素のコンテキストから名前空間を継承します。
20$cdataContent = 'この中に <script>タグや &記号</script> のような特殊文字を含めることができます。';
21$cdata = $dom->createCDATASection($cdataContent);
22$root->appendChild($cdata);
23
24echo "--- 生成されたXML構造 ---\n";
25echo $dom->saveXML() . "\n\n";
26
27echo "--- Dom\\CDATASection::isDefaultNamespace の動作確認 ---\n";
28
29// ケース1: 親要素に定義されたデフォルト名前空間URIを指定してチェック
30// CDATAセクションは親要素からデフォルト名前空間を継承するため、通常は true が返されます。
31$isDefault1 = $cdata->isDefaultNamespace($defaultNamespaceUri);
32echo "1. CDATAセクションはデフォルト名前空間 '$defaultNamespaceUri' を持っていますか？ "
33    . ($isDefault1 ? 'はい' : 'いいえ') . "\n"; // 期待値: はい (true)
34
35// ケース2: 異なる名前空間URIを指定してチェック
36// 定義されたデフォルト名前空間とは異なるため、 false が返されます。
37$anotherNamespaceUri = 'http://example.com/another-namespace';
38$isDefault2 = $cdata->isDefaultNamespace($anotherNamespaceUri);
39echo "2. CDATAセクションはデフォルト名前空間 '$anotherNamespaceUri' を持っていますか？ "
40    . ($isDefault2 ? 'はい' : 'いいえ') . "\n"; // 期待値: いいえ (false)
41
42// ケース3: null を指定してチェック
43// null を指定した場合、PHPのDOM実装では通常、いかなる名前空間URIとも一致しないと判断され、
44// false が返されることが多いです。これは、「null」という特定の名前空間URIと
45// 比較していると解釈されるためです。
46$isDefault3 = $cdata->isDefaultNamespace(null);
47echo "3. CDATAセクションはデフォルト名前空間 (null指定) を持っていますか？ "
48    . ($isDefault3 ? 'はい' : 'いいえ') . "\n"; // 期待値: いいえ (false)
49
50?>

Dom\CDATASection::isDefaultNamespaceメソッドは、PHP 8で提供されるXML操作機能の一つで、XMLドキュメント内のCDATAセクションが、そのXMLコンテキストにおいてデフォルトの名前空間を持っているかどうかを判定します。CDATAセクション自体は名前空間を持ちませんが、XMLツリー内の位置によって親要素のデフォルト名前空間のコンテキストを継承します。

このメソッドは?string $namespaceを引数として受け取ります。引数には、確認したい名前空間のURIを文字列で指定します。nullを指定することも可能です。メソッドの戻り値はbool型で、指定された名前空間URIがCDATAセクションの属するコンテキストのデフォルト名前空間と一致する場合にtrueを、そうでなければfalseを返します。

サンプルコードでは、まずルート要素に「http://example.com/default-namespace」というデフォルト名前空間を定義し、その中にCDATAセクションを作成しています。このCDATAセクションは親要素からこのデフォルト名前空間を継承します。そのため、定義したデフォルト名前空間URIを引数に渡すと`true`が返されます。一方、異なる名前空間URIや`null`を引数に渡した場合は、一致しないと判断され`false`が返される動作を確認できます。このメソッドは、XML構造をプログラムで操作する際に、要素の名前空間コンテキストが意図したものであるかを確認したい場合に役立ちます。

Copy
1<?php
2
3/**
4 * PHP DOM拡張におけるXML名前空間の扱いと Dom\CDATASection::isDefaultNamespace メソッドの利用例を示します。
5 *
6 * この関数は、XMLドキュメント内で名前空間を定義し、CDATAセクションが属する要素の
7 * デフォルト名前空間が何かを Dom\CDATASection::isDefaultNamespace メソッドを使って確認する方法を説明します。
8 *
9 * 注: PHPの 'namespace' キーワードはPHPコードの構造化に用いられますが、
10 * このサンプルコードで扱うのはXMLの名前空間であり、異なる概念です。
11 */
12function demonstrateXmlNamespaceAndCdataSectionIsDefaultNamespace(): void
13{
14    // DOMDocumentのインスタンスを作成
15    $dom = new Dom\Document('1.0', 'UTF-8');
16    $dom->formatOutput = true; // 出力されるXMLを見やすく整形
17
18    // XMLのデフォルト名前空間を持つルート要素を作成
19    // ここで 'http://www.example.com/ns/default' がルート要素のデフォルト名前空間として定義されます。
20    $defaultNamespaceUri = 'http://www.example.com/ns/default';
21    $rootElement = $dom->createElementNS($defaultNamespaceUri, 'root');
22    $dom->appendChild($rootElement);
23
24    // デフォルト名前空間に属する子要素を作成
25    // この子要素も親要素からデフォルト名前空間を継承します。
26    $childElement = $dom->createElementNS($defaultNamespaceUri, 'child');
27    $rootElement->appendChild($childElement);
28
29    // CDATASectionを作成し、子要素に追加
30    // CDATASection自体は名前空間を持ちませんが、親要素の名前空間コンテキスト内で存在します。
31    $cdata = $dom->createCDATASection('This is <CDATA> content with special characters.');
32    $childElement->appendChild($cdata);
33
34    // 別の名前空間を持つ要素も作成してみる
35    $anotherNamespaceUri = 'http://www.example.com/ns/another';
36    // プレフィックス 'other' を持つ要素。この名前空間はデフォルトではありません。
37    $otherElement = $dom->createElementNS($anotherNamespaceUri, 'other:item');
38    $rootElement->appendChild($otherElement);
39
40    // 他の名前空間を持つ要素にCDATAセクションを追加
41    $otherCdata = $dom->createCDATASection('Another CDATA for other namespace.');
42    $otherElement->appendChild($otherCdata);
43
44    echo "--- 生成されたXMLドキュメント ---\n";
45    echo $dom->saveXML();
46    echo "---------------------------------\n\n";
47
48    // Dom\CDATASection::isDefaultNamespace メソッドのテスト
49    echo "--- Dom\\CDATASection::isDefaultNamespace の確認 ---\n";
50
51    // 1. デフォルト名前空間を持つ親要素に属するCDATAセクションのテスト
52    echo "◆ 'child' 要素内のCDATAセクションについて:\n";
53    echo "  指定したURI '{$defaultNamespaceUri}' がデフォルト名前空間か？ ";
54    // CDATASectionはDom\Nodeを継承しており、isDefaultNamespaceは親ノードの名前空間を評価します。
55    if ($cdata->isDefaultNamespace($defaultNamespaceUri)) {
56        echo "はい、そうです。\n"; // 親要素である'child'のデフォルト名前空間と一致
57    } else {
58        echo "いいえ、違います。\n";
59    }
60
61    $nonMatchingUri = 'http://www.example.com/ns/non-matching';
62    echo "  指定したURI '{$nonMatchingUri}' がデフォルト名前空間か？ ";
63    if ($cdata->isDefaultNamespace($nonMatchingUri)) {
64        echo "はい、そうです。\n";
65    } else {
66        echo "いいえ、違います。\n"; // 指定したURIが親要素のデフォルト名前空間と一致しない
67    }
68
69    echo "  デフォルト名前空間が 'null' (つまり、親要素にデフォルト名前空間がない) か？ ";
70    if ($cdata->isDefaultNamespace(null)) {
71        echo "はい、そうです。\n";
72    } else {
73        echo "いいえ、違います。\n"; // 親要素'child'にはデフォルト名前空間が設定されているため
74    }
75
76    // 2. 別の名前空間を持つ親要素に属するCDATAセクションのテスト
77    echo "\n◆ 'other:item' 要素内のCDATAセクションについて:\n";
78    // この 'other:item' 要素自体は 'other' というプレフィックスを持つ名前空間に属します。
79    // プレフィックスを持つ名前空間は「デフォルト名前空間」ではないため、isDefaultNamespace() は false を返します。
80    echo "  指定したURI '{$anotherNamespaceUri}' がデフォルト名前空間か？ ";
81    if ($otherCdata->isDefaultNamespace($anotherNamespaceUri)) {
82        echo "はい、そうです。\n";
83    } else {
84        echo "いいえ、違います。\n"; // 'other:item' の名前空間はデフォルトではありません。
85    }
86
87    echo "  デフォルト名前空間が 'null' (つまり、親要素にデフォルト名前空間がない) か？ ";
88    if ($otherCdata->isDefaultNamespace(null)) {
89        echo "はい、そうです。\n"; // 'other:item' にはデフォルト名前空間が設定されていないため
90    } else {
91        echo "いいえ、違います。\n";
92    }
93
94    // 3. デフォルト名前空間を持たない要素 (例えば、HTMLのような非名前空間XML)
95    $noNsElement = $dom->createElement('plain-element');
96    $rootElement->appendChild($noNsElement);
97    $noNsCdata = $dom->createCDATASection('Plain CDATA content.');
98    $noNsElement->appendChild($noNsCdata);
99
100    echo "\n◆ 名前空間を持たない 'plain-element' 内のCDATAセクションについて:\n";
101    echo "  指定したURI '{$defaultNamespaceUri}' がデフォルト名前空間か？ ";
102    if ($noNsCdata->isDefaultNamespace($defaultNamespaceUri)) {
103        echo "はい、そうです。\n";
104    } else {
105        echo "いいえ、違います。\n";
106    }
107
108    echo "  デフォルト名前空間が 'null' (つまり、親要素にデフォルト名前空間がない) か？ ";
109    if ($noNsCdata->isDefaultNamespace(null)) {
110        echo "はい、そうです。\n"; // 親要素にデフォルト名前空間が設定されていないため
111    } else {
112        echo "いいえ、違います。\n";
113    }
114}
115
116// サンプルコードの実行
117demonstrateXmlNamespaceAndCdataSectionIsDefaultNamespace();

このサンプルコードは、PHPのDOM拡張機能を用いてXMLドキュメントを操作する際に役立つDom\CDATASection::isDefaultNamespaceメソッドの使い方を示します。このメソッドは、CDATAセクションが属する親要素のデフォルト名前空間が、引数として指定されたURIと一致するかどうかを判定します。

引数$namespaceには、比較したいXML名前空間のURIを文字列で渡します。もしnullを渡した場合、親要素にデフォルト名前空間が設定されていない場合にtrueを返します。戻り値はbool型で、条件が一致すればtrue、しなければfalseです。

PHPコードの構造化に用いるnamespaceキーワードとは異なり、ここで扱うのはXMLドキュメント内の名前空間の概念です。CDATAセクション自体は名前空間を持ちませんが、その親要素の名前空間コンテキストで評価されます。

サンプルでは、デフォルト名前空間を持つ要素、プレフィックス付きの名前空間を持つ要素、そして名前空間を持たない要素を作成し、それぞれの要素内のCDATAセクションに対してisDefaultNamespaceメソッドを適用しています。これにより、デフォルト名前空間が設定されている場合や、プレフィックス付きの名前空間、あるいは名前空間が全く設定されていない場合のメソッドの挙動の違いを具体的に確認できます。特に、プレフィックスを持つ名前空間は「デフォルト名前空間」とは区別される点がポイントです。