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

Copy
1<?php
2
3// DOMDocument クラスは、XML ドキュメントをオブジェクトとして表現するために使用されます。
4// PHP 8 では、DOM 拡張機能が標準で提供されています。
5$dom = new DOMDocument('1.0', 'UTF-8');
6$dom->formatOutput = true; // 生成される XML の可読性を向上させます。
7
8// 名前空間 URI を定義します。
9$myNamespaceUri = 'http://example.com/myns';
10
11// ルート要素を作成し、それをドキュメントに追加します。
12// createElementNS は名前空間付きの要素を作成します。
13$root = $dom->createElementNS($myNamespaceUri, 'myns:root');
14$dom->appendChild($root);
15
16// 子要素を作成し、ルート要素に追加します。
17$itemElement = $dom->createElement('item');
18$root->appendChild($itemElement);
19
20// Dom\Element::setAttributeNS メソッドを使用して、名前空間付き属性を追加します。
21// 最初の引数は名前空間URI、二番目は属性名（接頭辞付き）、三番目は属性値です。
22$itemElement->setAttributeNS($myNamespaceUri, 'myns:data-id', 'unique-value-123');
23
24// Dom\Element::setAttribute メソッドを使用して、名前空間なし属性を追加します。
25$itemElement->setAttribute('data-type', 'example');
26
27echo "--- 生成された XML ドキュメント ---\n";
28echo $dom->saveXML();
29echo "----------------------------------\n\n";
30
31echo "Dom\\Element::hasAttributeNS メソッドのテスト:\n";
32
33// 1. 名前空間付き属性が存在するか確認します（存在するケース）。
34// hasAttributeNS は、指定された名前空間URIとローカル名を持つ属性が要素に存在するかをチェックします。
35$namespaceToSearch = $myNamespaceUri;
36$localNameToSearch = 'data-id';
37if ($itemElement->hasAttributeNS($namespaceToSearch, $localNameToSearch)) {
38    echo "  - 「{$namespaceToSearch}」の名前空間URIと「{$localNameToSearch}」のローカル名を持つ属性は存在します。\n";
39} else {
40    echo "  - 「{$namespaceToSearch}」の名前空間URIと「{$localNameToSearch}」のローカル名を持つ属性は存在しません。\n";
41}
42
43// 2. 名前空間付き属性が存在するか確認します（存在しないケース）。
44$namespaceToSearch = $myNamespaceUri;
45$localNameToSearch = 'nonExistentId';
46if ($itemElement->hasAttributeNS($namespaceToSearch, $localNameToSearch)) {
47    echo "  - 「{$namespaceToSearch}」の名前空間URIと「{$localNameToSearch}」のローカル名を持つ属性は存在します。\n";
48} else {
49    echo "  - 「{$namespaceToSearch}」の名前空間URIと「{$localNameToSearch}」のローカル名を持つ属性は存在しません。\n";
50}
51
52// 3. 名前空間なし属性が存在するか確認します（存在するケース）。
53// 名前空間なし属性を hasAttributeNS でチェックする場合、名前空間URIには空文字列を指定します。
54$namespaceToSearch = ''; // 空文字列は名前空間なしを意味します
55$localNameToSearch = 'data-type';
56if ($itemElement->hasAttributeNS($namespaceToSearch, $localNameToSearch)) {
57    echo "  - 名前空間なしで「{$localNameToSearch}」のローカル名を持つ属性は存在します。\n";
58} else {
59    echo "  - 名前空間なしで「{$localNameToSearch}」のローカル名を持つ属性は存在しません。\n";
60}
61
62// 4. 名前空間なし属性が存在するか確認します（存在しないケース）。
63$namespaceToSearch = '';
64$localNameToSearch = 'missing-data';
65if ($itemElement->hasAttributeNS($namespaceToSearch, $localNameToSearch)) {
66    echo "  - 名前空間なしで「{$localNameToSearch}」のローカル名を持つ属性は存在します。\n";
67} else {
68    echo "  - 名前空間なしで「{$localNameToSearch}」のローカル名を持つ属性は存在しません。\n";
69}
70
71// 参考: 名前空間なし属性の存在チェックには、通常 hasAttribute() メソッドを使用する方がシンプルです。
72echo "\n--- 参考: Dom\\Element::hasAttribute メソッドのテスト ---\n";
73if ($itemElement->hasAttribute('data-type')) {
74    echo "  - 「data-type」という名前の属性は存在します。(hasAttributeを使用)\n";
75} else {
76    echo "  - 「data-type」という名前の属性は存在しません。(hasAttributeを使用)\n";
77}

Dom\Element::hasAttributeNSメソッドは、PHPでXMLドキュメントの要素が、特定の名前空間とローカル名を持つ属性を持っているかを判定する際に利用するメソッドです。

一つ目の引数$namespaceには、検索したい属性の名前空間URIを文字列で指定します。二つ目の引数$localNameには、属性の名前空間接頭辞を含まないローカル名を文字列で指定します。このメソッドは、対象の要素に指定した名前空間URIとローカル名に一致する属性が存在すればtrueを、存在しなければfalseというブール値を戻り値として返します。

サンプルコードでは、まずXML要素にsetAttributeNSで名前空間付き属性を、setAttributeで名前空間なし属性を追加しています。その後、hasAttributeNSを使ってこれらの属性の存在を判定しています。名前空間付き属性の確認では、その正確な名前空間URIとローカル名を指定します。一方、名前空間を持たない属性の存在を確認する際は、$namespace引数に空文字列''を指定します。これにより、名前空間の有無を考慮した属性の正確な判定が可能です。このメソッドは、特に名前空間が使われるXMLドキュメントにおいて、特定の属性の有無を確認する際に非常に有用です。

Copy
1<?php
2
3/**
4 * Dom\Element::hasAttributeNS メソッドの使用例を示します。
5 * この関数は、指定された名前空間URIとローカル名を持つ属性が、DOM要素に存在するかどうかを確認します。
6 * システムエンジニアを目指す初心者向けに、簡潔かつ正確なコードを提供します。
7 */
8function demonstrateHasAttributeNS(): void
9{
10    // 1. 新しい Dom\Document インスタンスを作成します。
11    //    これはXMLドキュメント全体を操作するための基盤となるオブジェクトです。
12    $dom = new Dom\Document();
13
14    // 2. 名前空間付きの属性と通常の属性を持つXML文字列をロードします。
15    //    `xmlns:my="http://example.com/my-namespace"` は名前空間を定義しています。
16    //    `<item my:id="123" regular-attr="value">` の `my:id` は名前空間付き属性、`regular-attr` は通常の属性です。
17    $xmlString = <<<XML
18<root xmlns:my="http://example.com/my-namespace">
19    <item my:id="123" regular-attr="value">
20        これは名前空間付き属性を持つアイテムです。
21    </item>
22</root>
23XML;
24    $dom->loadXML($xmlString);
25
26    // 3. ドキュメントから特定の要素（ここでは 'item' 要素）を取得します。
27    //    getElementsByTagName は、指定されたタグ名を持つすべての要素を含む Dom\NodeList を返します。
28    $items = $dom->getElementsByTagName('item');
29
30    // 要素が取得できたか確認します。
31    if ($items->count() === 0) {
32        echo "エラー: ドキュメントに 'item' 要素が見つかりませんでした。\n";
33        return;
34    }
35
36    // 4. 最初に見つかった 'item' 要素を取得します。
37    //    Dom\NodeList::item(0) は Dom\Node を返しますが、この場合、それは Dom\Element のインスタンスです。
38    /** @var Dom\Element $itemElement */
39    $itemElement = $items->item(0);
40
41    // 5. Dom\Element::hasAttributeNS() を使用して、特定の名前空間とローカル名を持つ属性が存在するか確認します。
42    //    第一引数には名前空間のURI、第二引数には属性のローカル名（プレフィックスを含まない部分）を指定します。
43    $namespaceUri = 'http://example.com/my-namespace'; // XMLで定義した名前空間URI
44    $localName    = 'id';                               // 属性名 'my:id' のローカル部分
45
46    echo "要素に名前空間属性 '{$namespaceUri}:{$localName}' が存在するか確認します...\n";
47    $hasMyIdAttribute = $itemElement->hasAttributeNS($namespaceUri, $localName);
48
49    if ($hasMyIdAttribute) {
50        echo "  - はい、属性 'my:id' は存在します。\n";
51        // 存在する場合は、getAttributeNS() でその値を取得できます。
52        echo "  - 属性値: " . $itemElement->getAttributeNS($namespaceUri, $localName) . "\n";
53    } else {
54        echo "  - いいえ、属性 'my:id' は存在しません。\n";
55    }
56
57    echo "\n";
58
59    // 6. 存在しない名前空間属性をチェックする例。
60    $nonExistentLocalName = 'version';
61    echo "要素に名前空間属性 '{$namespaceUri}:{$nonExistentLocalName}' が存在するか確認します...\n";
62    $hasNonExistentAttribute = $itemElement->hasAttributeNS($namespaceUri, $nonExistentLocalName);
63    if ($hasNonExistentAttribute) {
64        echo "  - はい、属性 'my:version' は存在します。\n";
65    } else {
66        echo "  - いいえ、属性 'my:version' は存在しません。(これは期待される結果です)\n";
67    }
68
69    echo "\n";
70
71    // 7. 名前空間を持たない通常の属性を hasAttributeNS でチェックするとどうなるか確認します。
72    //    hasAttributeNS は名前空間付き属性に特化しており、名前空間のない属性をチェックする際は通常 false を返します。
73    //    空文字列を名前空間URIとして渡しても、XML仕様に準拠した名前空間がないとみなされます。
74    $regularAttributeName = 'regular-attr';
75    echo "要素に通常の属性 '{$regularAttributeName}' が存在するか hasAttributeNS で確認します...\n";
76    $hasRegularAttributeNSCheck = $itemElement->hasAttributeNS('', $regularAttributeName);
77    if ($hasRegularAttributeNSCheck) {
78        echo "  - はい、属性 '{$regularAttributeName}' は存在します (hasAttributeNS)。\n";
79    } else {
80        echo "  - いいえ、属性 '{$regularAttributeName}' は存在しません (hasAttributeNS)。\n";
81        echo "    名前空間を持たない属性をチェックするには、Dom\Element::hasAttribute() を使用するのが適切です。\n";
82    }
83
84    // 8. 名前空間を持たない通常の属性を Dom\Element::hasAttribute() でチェックする例。
85    echo "要素に通常の属性 '{$regularAttributeName}' が存在するか hasAttribute で確認します...\n";
86    $hasRegularAttribute = $itemElement->hasAttribute($regularAttributeName);
87    if ($hasRegularAttribute) {
88        echo "  - はい、属性 '{$regularAttributeName}' は存在します (hasAttribute)。\n";
89        echo "  - 属性値: " . $itemElement->getAttribute($regularAttributeName) . "\n";
90    } else {
91        echo "  - いいえ、属性 '{$regularAttributeName}' は存在しません (hasAttribute)。\n";
92    }
93}
94
95// 上記のデモンストレーション関数を実行します。
96demonstrateHasAttributeNS();
97

Dom\Element::hasAttributeNSは、PHPでXMLドキュメントを操作する際に、特定の要素が指定された名前空間URIとローカル名を持つ属性を保持しているかを確認するメソッドです。このメソッドは、XML内の名前空間付き属性の有無を厳密にチェックする際に利用します。

引数string $namespaceには確認したい属性の名前空間URIを、string $localNameには属性名のプレフィックスを含まないローカル名を指定します。戻り値はbool型で、指定された名前空間URIとローカル名を持つ属性が要素に存在すればtrueを、存在しなければfalseを返します。

サンプルコードでは、名前空間付き属性my:idを含むXMLからitem要素を取得し、itemElement->hasAttributeNS('http://example.com/my-namespace', 'id')のように呼び出すことでその存在を確認しています。この例では属性が存在するため、trueが返されます。

なお、名前空間を持たない通常の属性の有無をチェックする場合は、Dom\Element::hasAttributeNSではなくDom\Element::hasAttribute()メソッドを使用することが適切です。hasAttributeNSは名前空間付き属性専用であり、通常の属性には機能しないため、目的に応じたメソッドの使い分けが重要です。