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

Copy
1<?php
2
3/**
4 * DOMElement::hasAttributeNS メソッドの使用例を示します。
5 * この関数は、XML要素が特定の名前空間とローカル名を持つ属性を持っているかをチェックします。
6 *
7 * システムエンジニアを目指す初心者の方へ:
8 * XMLデータには、同じ名前の要素や属性でも、異なる情報源からのもの区別するために
9 * 「名前空間 (Namespace)」という仕組みがよく使われます。
10 * hasAttributeNSは、この名前空間を考慮して属性の有無を確認する際に利用します。
11 */
12function demonstrateHasAttributeNS(): void
13{
14    // 新しいDOMドキュメントを作成します。XMLバージョンとエンコーディングを指定します。
15    $dom = new DOMDocument('1.0', 'UTF-8');
16    // 出力時にXMLを整形し、読みやすくします。
17    $dom->formatOutput = true;
18
19    // ルート要素を作成します。ここでは、書籍に関するXMLを想定し、
20    // 'http://example.com/books' というURIを名前空間として定義します。
21    // 'bk' はこの名前空間のプレフィックスです。
22    $bookstore = $dom->createElementNS('http://example.com/books', 'bk:bookstore');
23    $dom->appendChild($bookstore);
24
25    // 書籍を表す要素を作成し、それをbookstore要素の子として追加します。
26    $book = $dom->createElementNS('http://example.com/books', 'bk:book');
27    $bookstore->appendChild($book);
28
29    // 名前空間を持つ属性 'bk:id' を書籍要素に追加します。
30    // 名前空間URI: 'http://example.com/books', ローカル名: 'id'
31    $book->setAttributeNS('http://example.com/books', 'bk:id', 'B123');
32
33    // 名前空間を持たない通常の属性 'title' を書籍要素に追加します。
34    $book->setAttribute('title', 'PHPプログラミング入門');
35
36    // 生成されたXMLドキュメントの内容を表示します。
37    echo "--- 生成されたXMLドキュメント ---\n";
38    echo $dom->saveXML();
39    echo "----------------------------------\n\n";
40
41    echo "書籍要素 (<bk:book>) の属性の有無をチェックします。\n";
42
43    // 1. 存在する名前空間属性をチェックします。
44    // 名前空間URI: 'http://example.com/books', ローカル名: 'id'
45    // 期待値: true (属性 'bk:id' は存在します)
46    $existsNamespacedAttr = $book->hasAttributeNS('http://example.com/books', 'id');
47    echo "属性 'bk:id' (名前空間URI: 'http://example.com/books', ローカル名: 'id') は存在しますか？ "
48         . ($existsNamespacedAttr ? "はい" : "いいえ") . "\n";
49
50    // 2. 存在しない名前空間属性をチェックします。
51    // 名前空間URI: 'http://example.com/books', ローカル名: 'publisher'
52    // 期待値: false (この属性は追加されていません)
53    $notExistsNamespacedAttr = $book->hasAttributeNS('http://example.com/books', 'publisher');
54    echo "属性 'bk:publisher' (名前空間URI: 'http://example.com/books', ローカル名: 'publisher') は存在しますか？ "
55         . ($notExistsNamespacedAttr ? "はい" : "いいえ") . "\n";
56
57    // 3. 名前空間は合致するが、ローカル名が異なる属性をチェックします。
58    // 'title'属性は名前空間を持たずに設定されているため、
59    // 名前空間URIを指定したhasAttributeNSではマッチしません。
60    // 期待値: false
61    $wrongLocalName = $book->hasAttributeNS('http://example.com/books', 'title');
62    echo "属性 'bk:title' (名前空間URI: 'http://example.com/books', ローカル名: 'title') は存在しますか？ "
63         . ($wrongLocalName ? "はい" : "いいえ") . "\n";
64
65    // 4. 名前空間を持たない属性をhasAttributeNSでチェックします。
66    // PHP 8では、namespace引数に null や空文字列 "" を渡すことで、
67    // 名前空間を持たない属性をチェックできます。
68    // 期待値: true (属性 'title' は存在します)
69    $existsNonNamespacedAttrWithNullNs = $book->hasAttributeNS(null, 'title');
70    echo "属性 'title' (名前空間URI: null, ローカル名: 'title') は存在しますか？ "
71         . ($existsNonNamespacedAttrWithNullNs ? "はい" : "いいえ") . "\n";
72}
73
74// 上記の関数を実行して、DOMElement::hasAttributeNS の動作を確認します。
75demonstrateHasAttributeNS();
76

PHP 8のDOMElement::hasAttributeNSメソッドは、XMLの要素が特定の名前空間URIとローカル名を持つ属性を持っているかを確認するために使用されます。XMLにおいて名前空間は、異なる情報源からの要素や属性を区別し、名前の衝突を避けるための重要な仕組みです。

このメソッドは2つの引数を取ります。1つ目の$namespaceには確認したい属性の名前空間URIを文字列で指定し、2つ目の$localNameには属性のローカル名を文字列で指定します。例えば、<bk:book bk:id="B123" />という要素に対し、名前空間URIが'http://example.com/books'で、ローカル名が'id'という属性が存在するかをチェックできます。

戻り値は真偽値（bool）で、指定した名前空間とローカル名に一致する属性が存在すればtrueを、存在しなければfalseを返します。サンプルコードでは、名前空間を持つbk:id属性が存在するかを確認し、正しくtrueが返される様子を示しています。また、名前空間を持たない通常の属性をチェックしたい場合は、$namespace引数にnullや空文字列を渡すことで、その属性の有無を確認できる点もこのメソッドの重要な挙動の一つです。このメソッドを使うことで、XMLデータを名前空間のセマンティクスに沿って正確に操作できるようになります。

Copy
1<?php
2
3/**
4 * DOMElement::hasAttributeNS メソッドの使用例を示します。
5 * XMLドキュメント内のDOM要素が、指定された名前空間とローカル名を持つ属性を持っているかをチェックします。
6 * システムエンジニアを目指す初心者にも理解しやすいよう、具体的なXML構造と確認手順を提示します。
7 */
8function checkDomElementHasAttributeNSExample(): void
9{
10    // 1. DOMDocument オブジェクトを作成し、XMLをロードします。
11    //    名前空間 'bk' (http://www.example.com/bookstore) とそれに属する 'category' 属性を持つXMLを用意します。
12    $dom = new DOMDocument('1.0', 'UTF-8');
13    $dom->formatOutput = true; // 出力整形を有効にして、デバッグ時にXMLを見やすくします
14
15    $xmlString = <<<XML
16<bookstore xmlns:bk="http://www.example.com/bookstore">
17  <book bk:category="programming">
18    <title>PHP Basics</title>
19  </book>
20  <book category="fiction">
21    <title>The Great Novel</title>
22  </book>
23</bookstore>
24XML;
25
26    // XML文字列をDOMドキュメントにロードします
27    if (!$dom->loadXML($xmlString)) {
28        echo "エラー: XMLのロードに失敗しました。\n";
29        return;
30    }
31
32    // 2. 最初の 'book' 要素を取得します。
33    //    getElementsByTagNameNS を使用して、任意の名前空間（'*'）の 'book' タグを取得します。
34    $books = $dom->getElementsByTagNameNS('*', 'book');
35
36    if ($books->length === 0) {
37        echo "エラー: book要素が見つかりませんでした。\n";
38        return;
39    }
40
41    // 最初の <book bk:category="programming"> 要素を処理します。
42    /** @var DOMElement $firstBook */
43    $firstBook = $books->item(0);
44    echo "--- 最初の <book> 要素の属性チェック (bk:category=\"programming\") ---\n";
45
46    // 'bk:category' 属性があるか確認します。
47    // 名前空間URIとローカル名（プレフィックスを含まない）を指定します。
48    $bkNamespaceURI = 'http://www.example.com/bookstore';
49    $categoryLocalName = 'category'; // "bk:" の部分はローカル名には含めません
50
51    if ($firstBook->hasAttributeNS($bkNamespaceURI, $categoryLocalName)) {
52        echo "✓ 最初の <book> 要素は、名前空間 '{$bkNamespaceURI}' に属する '{$categoryLocalName}' 属性を持っています。\n";
53        echo "  属性値: " . $firstBook->getAttributeNS($bkNamespaceURI, $categoryLocalName) . "\n";
54    } else {
55        echo "✗ 最初の <book> 要素は、名前空間 '{$bkNamespaceURI}' に属する '{$categoryLocalName}' 属性を持っていません。\n";
56    }
57
58    // 名前空間なしの 'category' 属性があるか確認します (この要素には存在しません)。
59    // 名前空間の引数に null を指定します。
60    if ($firstBook->hasAttributeNS(null, $categoryLocalName)) {
61        echo "✗ 最初の <book> 要素は、名前空間なしの '{$categoryLocalName}' 属性を持っています。\n";
62    } else {
63        echo "✓ 最初の <book> 要素は、名前空間なしの '{$categoryLocalName}' 属性を持っていません。\n";
64    }
65    echo "\n";
66
67
68    // 3. 2番目の 'book' 要素を取得し、属性の有無をチェックします。
69    //    この要素は名前空間なしの 'category' 属性を持っています。
70    if ($books->length > 1) {
71        /** @var DOMElement $secondBook */
72        $secondBook = $books->item(1); // 2番目の <book category="fiction"> 要素
73        echo "--- 2番目の <book> 要素の属性チェック (category=\"fiction\") ---\n";
74
75        // 名前空間 'http://www.example.com/bookstore' の 'category' 属性があるか確認します (この要素には存在しません)。
76        if ($secondBook->hasAttributeNS($bkNamespaceURI, $categoryLocalName)) {
77            echo "✗ 2番目の <book> 要素は、名前空間 '{$bkNamespaceURI}' に属する '{$categoryLocalName}' 属性を持っています。\n";
78        } else {
79            echo "✓ 2番目の <book> 要素は、名前空間 '{$bkNamespaceURI}' に属する '{$categoryLocalName}' 属性を持っていません。\n";
80        }
81
82        // 名前空間なしの 'category' 属性があるか確認します (この要素には存在します)。
83        // 名前空間の引数に null を指定します。
84        if ($secondBook->hasAttributeNS(null, $categoryLocalName)) {
85            echo "✓ 2番目の <book> 要素は、名前空間なしの '{$categoryLocalName}' 属性を持っています。\n";
86            echo "  属性値: " . $secondBook->getAttributeNS(null, $categoryLocalName) . "\n";
87        } else {
88            echo "✗ 2番目の <book> 要素は、名前空間なしの '{$categoryLocalName}' 属性を持っていません。\n";
89        }
90    }
91}
92
93// サンプル関数を実行します。
94checkDomElementHasAttributeNSExample();
95

PHPのDOMElement::hasAttributeNSメソッドは、XMLドキュメント内のDOM要素が、指定された名前空間とローカル名を持つ属性を持っているかどうかを確認するために使用されます。このメソッドは、第一引数に属性の名前空間URI（ユニフォームリソース識別子）を、第二引数に属性のローカル名（プレフィックスを含まない名称）を受け取ります。戻り値は真偽値（bool）で、該当する属性が存在すればtrueを、存在しなければfalseを返します。

例えば、サンプルコードでは、bk:category="programming"のように名前空間プレフィックス「bk」が付いたcategory属性がある場合、http://www.example.com/bookstoreという名前空間URIとcategoryというローカル名を指定することで、この属性の有無を正確に判別できます。また、名前空間を持たないcategory="fiction"のような属性をチェックしたい場合は、第一引数にnullを指定することで、名前空間に属さないcategory属性の有無を確認することが可能です。

このように、XML構造が複雑で、同じ属性名が異なる名前空間で使われている場合でも、意図した属性を正確に識別し、処理の分岐に役立てることができます。XMLを扱うシステム開発において、要素の属性の有無を条件に応じて判断する場面で重要な役割を果たすメソッドです。