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

Copy
1<?php
2
3/**
4 * DOMElement::getAttributeNS メソッドの使用例を示します。
5 * このメソッドは、名前空間を持つXML属性の値を取得する際に使用されます。
6 *
7 * システムエンジニアを目指す初心者の方へ:
8 * XMLでは、属性が特定の「名前空間」に属することがあります。
9 * 通常の getAttribute() メソッドでは名前空間を考慮しないため、
10 * 名前空間を持つ属性の値を取得するには getAttributeNS() を使用します。
11 * 引数には、属性が属する名前空間のURIと、属性のローカル名（プレフィックスを含まない名前）を指定します。
12 */
13function getNamespaceAttributeExample(): void
14{
15    // 名前空間を持つXML文字列を定義します。
16    // ここでは 'my' というプレフィックスで 'http://example.com/my-ns' 名前空間を定義し、
17    // その名前空間に属する 'data-value' 属性を持つ <data> 要素を作成しています。
18    $xmlString = <<<XML
19<?xml version="1.0" encoding="UTF-8"?>
20<root xmlns:my="http://example.com/my-ns">
21    <data id="item1" my:data-value="HelloFromNamespace">
22        これは名前空間を持つデータです。
23    </data>
24</root>
25XML;
26
27    // DOMDocumentオブジェクトを作成します。
28    $dom = new DOMDocument();
29    // XML文字列をDOMDocumentにロードします。
30    // エラーが発生した場合、falseを返すため、チェックします。
31    if (!$dom->loadXML($xmlString)) {
32        echo "エラー: XMLのロードに失敗しました。\n";
33        return;
34    }
35
36    // <data> 要素を取得します。
37    // getElementsByTagNameはDOMNodeListを返すため、item(0)で最初の要素にアクセスします。
38    $dataElement = $dom->getElementsByTagName('data')->item(0);
39
40    // 要素が正しく取得できたか確認します。
41    if ($dataElement instanceof DOMElement) {
42        // 名前空間URIとローカル名を指定して属性値を取得します。
43        // 名前空間URIはXMLで定義されているURI ('http://example.com/my-ns') です。
44        // ローカル名は、属性名 ('my:data-value') のコロンより後の部分 ('data-value') です。
45        $namespaceUri = "http://example.com/my-ns";
46        $localName = "data-value";
47
48        $attributeValue = $dataElement->getAttributeNS($namespaceUri, $localName);
49
50        echo "名前空間属性 'my:data-value' の値: " . $attributeValue . "\n";
51
52        // 属性が存在しない場合、getAttributeNS() は空文字列を返します。
53        // 例: 存在しない名前空間URIやローカル名を指定した場合
54        // $nonExistentValue = $dataElement->getAttributeNS("http://example.com/non-existent-ns", "attr");
55        // echo "存在しない属性の値: " . ($nonExistentValue === '' ? "[空文字列]" : $nonExistentValue) . "\n";
56    } else {
57        echo "エラー: <data> 要素が見つかりませんでした。\n";
58    }
59}
60
61// 関数を実行して、サンプルコードの動作を確認します。
62getNamespaceAttributeExample();

PHPのDOMElement::getAttributeNSメソッドは、XML文書内で「名前空間」を持つ属性の値を取得する際に使用するメソッドです。名前空間を考慮しないgetAttribute()とは異なり、XMLの特定の名前空間に属する属性の値を取得する場合に利用します。

引数として2つの値を受け取ります。1つ目の$namespaceには、対象の属性が属する名前空間のURI（例えばhttp://example.com/my-ns）を指定します。2つ目の$localNameには、属性のローカル名、つまりプレフィックス（my:のような部分）を除いた属性名（例えばdata-value）を指定します。

サンプルコードでは、名前空間が定義されたXML文書をDOMDocumentにロードし、<data>要素からmy:data-value属性の値を取得します。その際、getAttributeNS()に名前空間URIhttp://example.com/my-nsとローカル名data-valueを渡します。戻り値は属性値の文字列です。もし指定した名前空間やローカル名を持つ属性が存在しない場合は空文字列が返されます。これにより、XMLの名前空間を考慮した属性の安全な取得が可能です。

Copy
1<?php
2
3/**
4 * DOMElement::getAttributeNS の使用例
5 *
6 * この関数は、XML ドキュメント内の要素から特定名前空間に属する属性値を取得する方法を示します。
7 *
8 * @return void
9 */
10function demonstrateGetAttributeNSExample(): void
11{
12    // XML ドキュメントを作成します。
13    // 'myns' というプレフィックスで名前空間 'http://example.com/myns' を定義し、
14    // その名前空間に属する属性 'myns:data' と 'myns:id' を含めます。
15    $xmlString = <<<XML
16<root xmlns:myns="http://example.com/myns">
17    <element myns:data="データ値" normal-attr="通常の属性値">
18        <child myns:id="子要素ID"/>
19    </element>
20</root>
21XML;
22
23    $dom = new DOMDocument();
24    $dom->loadXML($xmlString);
25
26    // <element> 要素を取得します。
27    $element = $dom->getElementsByTagName('element')->item(0);
28
29    if ($element instanceof DOMElement) {
30        // 'http://example.com/myns' 名前空間に属する 'data' 属性の値を取得します。
31        // getAttributeNS() の最初の引数には、名前空間のURIを指定します。
32        $namespaceURI = "http://example.com/myns";
33        $localName = "data";
34        $attributeValue = $element->getAttributeNS($namespaceURI, $localName);
35
36        echo "取得した名前空間付き属性 (myns:data): " . $attributeValue . PHP_EOL; // 出力例: データ値
37
38        // 存在しない名前空間付き属性の取得を試みます。
39        // 存在しない場合は空文字列を返します。
40        $nonExistentAttribute = $element->getAttributeNS($namespaceURI, "nonExistentAttr");
41        echo "存在しない名前空間付き属性: '" . $nonExistentAttribute . "'" . PHP_EOL; // 出力例: ''
42
43        // 注意: getAttributeNS は、名前空間を持たない属性（通常の属性）の取得には適していません。
44        // 名前空間 URI を null にしても、名前空間を持たない属性は取得できません（空文字列を返します）。
45        $normalAttrAttempt = $element->getAttributeNS(null, "normal-attr");
46        echo "通常の属性を getAttributeNS で試行 (null 名前空間): '" . $normalAttrAttempt . "'" . PHP_EOL; // 出力例: ''
47
48        // 通常の属性は getAttribute() メソッドを使用して取得します。
49        $normalAttrValue = $element->getAttribute("normal-attr");
50        echo "通常の属性 (normal-attr): " . $normalAttrValue . PHP_EOL; // 出力例: 通常の属性値
51
52        // 子要素から名前空間付き属性を取得する例
53        $childElement = $dom->getElementsByTagName('child')->item(0);
54        if ($childElement instanceof DOMElement) {
55            $childAttrValue = $childElement->getAttributeNS($namespaceURI, 'id');
56            echo "子要素から取得した名前空間付き属性 (myns:id): " . $childAttrValue . PHP_EOL; // 出力例: 子要素ID
57        }
58    } else {
59        echo "指定された 'element' 要素が見つかりませんでした。" . PHP_EOL;
60    }
61}
62
63// 上記で定義した関数を実行します。
64demonstrateGetAttributeNSExample();
65

DOMElement::getAttributeNSメソッドは、PHPでXMLドキュメントの要素から、特定の名前空間に属する属性の値を取得するために使用されます。このメソッドは、第一引数に取得したい属性が属する名前空間のURI（Uniform Resource Identifier）を、第二引数に属性のローカル名（プレフィックスを含まない名前）を指定します。属性が見つかった場合はその値が文字列として返され、見つからなかった場合は空文字列が返されます。

サンプルコードでは、xmlns:myns="http://example.com/myns"という名前空間が定義されたXMLドキュメントを作成しています。そして、<element>要素に定義されているmyns:data属性の値をgetAttributeNSを使って取得しています。この際、名前空間URIとしてhttp://example.com/myns、ローカル名としてdataを指定することで、「データ値」という結果が得られています。

存在しない名前空間付き属性や、指定した名前空間に属さない属性の取得を試みた場合、このメソッドは空文字列を返します。また、名前空間を持たない通常の属性（例: normal-attr）を取得する場合にはgetAttributeNSは適しておらず、名前空間引数をnullにしても空文字列が返されます。通常の属性は、getAttribute()メソッドを使用して取得する必要があります。この例は、子要素に定義された名前空間付き属性も同様に取得できることを示し、DOMElement::getAttributeNSの正確な挙動と使用場面を明確にしています。