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

Copy
1<?php
2
3/**
4 * DOMElement::removeAttributeNS の使用例
5 * 特定の名前空間を持つ属性を要素から削除します。
6 *
7 * システムエンジニアを目指す初心者向けに、XML文書から名前空間付き属性を
8 * 削除する基本的な流れを示します。
9 */
10function demonstrateRemoveAttributeNS(): void
11{
12    // 1. DOMDocument オブジェクトを初期化し、XML文書を作成します。
13    //    '1.0' はXMLのバージョン、'utf-8' は文字エンコーディングです。
14    $dom = new DOMDocument('1.0', 'utf-8');
15    // 出力時にXMLを整形するための設定です。
16    $dom->formatOutput = true;
17
18    // 2. ルート要素を作成し、DOMDocumentに追加します。
19    $root = $dom->createElement('root');
20    $dom->appendChild($root);
21
22    // 3. 子要素 (item) を作成し、ルート要素に追加します。
23    $item = $dom->createElement('item');
24    $root->appendChild($item);
25
26    // 4. 名前空間とプレフィックスを定義し、名前空間付き属性を追加します。
27    //    ここでは 'xlink' 名前空間の 'href' 属性を追加します。
28    $xlinkNamespaceURI = 'http://www.w3.org/1999/xlink';
29    // setAttributeNS(namespaceURI, qualifiedName, value)
30    // qualifiedName は 'プレフィックス:ローカル名' の形式です。
31    $item->setAttributeNS($xlinkNamespaceURI, 'xlink:href', 'https://example.com/link');
32    $item->setAttributeNS($xlinkNamespaceURI, 'xlink:type', 'simple');
33
34    // 比較のために、名前空間のない通常の属性も追加します。
35    $item->setAttribute('id', 'item1');
36    $item->setAttribute('data-value', 'test-data');
37
38    echo "--- 属性削除前 ---" . PHP_EOL;
39    // 作成したXMLの現在の状態を出力します。
40    echo $dom->saveXML();
41    echo PHP_EOL;
42
43    // 5. DOMElement::removeAttributeNS() を使用して、指定した名前空間の属性を削除します。
44    //    引数: $namespace (削除したい属性の名前空間URI), $localName (削除したい属性のローカル名)
45    echo "--- 'xlink:href' 属性を削除します ---" . PHP_EOL;
46    $item->removeAttributeNS($xlinkNamespaceURI, 'href');
47
48    // 6. 削除後のXMLの現在の状態を出力します。
49    echo $dom->saveXML();
50    echo PHP_EOL;
51
52    echo "--- 'xlink:type' 属性を削除します ---" . PHP_EOL;
53    $item->removeAttributeNS($xlinkNamespaceURI, 'type');
54
55    echo $dom->saveXML();
56    echo PHP_EOL;
57
58    echo "--- 名無し属性 'id' はそのまま残っています ---" . PHP_EOL;
59}
60
61// 関数を実行して、DOMElement::removeAttributeNS の動作を確認します。
62demonstrateRemoveAttributeNS();

PHP 8のDOMElement::removeAttributeNSメソッドは、XML要素から特定の名前空間に属する属性を削除するために使用されます。名前空間とは、XML文書内で同じ名前の要素や属性が異なる意味を持つことを区別するための仕組みです。このメソッドは、指定された名前空間URIとローカル名に合致する属性を見つけ出して削除します。

引数には、削除したい属性の「名前空間URI」と「ローカル名」を文字列で渡します。名前空間URIは、属性が定義されている名前空間を一意に識別するURL形式の文字列です。ローカル名とは、属性名のコロン（:）より後ろの部分、つまりプレフィックスを含まない本来の属性名のことです。このメソッドは属性の削除に成功しても、戻り値は特にありません。

サンプルコードでは、まずDOMDocumentでXML文書を作成し、「xlink:href」や「xlink:type」といった名前空間付き属性を持つ「item」要素を追加しています。removeAttributeNSを呼び出す際には、$xlinkNamespaceURI（http://www.w3.org/1999/xlink）と、それぞれ「href」や「type」といったローカル名を指定します。これにより、特定の名前空間に属する属性のみが正確に削除され、名前空間を持たない通常の属性は影響を受けずに残ることが確認できます。XML文書を操作する際に、名前空間の概念を理解することは非常に重要です。

Copy
1<?php
2
3/**
4 * DOMElement::removeAttributeNS メソッドの使用例を示します。
5 * この関数は、指定された名前空間URIとローカル名に一致する属性をDOM要素から削除します。
6 * システムエンジニアを目指す初心者の方でも理解しやすいよう、XMLの構築から属性削除、
7 * そして結果の確認までを順を追って説明します。
8 */
9function exampleRemoveAttributeNS(): void
10{
11    // 1. 新しいDOMドキュメントを作成します。
12    // '1.0' はXMLのバージョン、'UTF-8' はエンコーディングです。
13    $dom = new DOMDocument('1.0', 'UTF-8');
14    // 出力されるXMLを見やすく整形するための設定です。
15    $dom->formatOutput = true;
16
17    // 2. ルート要素 'document' を作成し、ドキュメントに追加します。
18    $root = $dom->createElement('document');
19    $dom->appendChild($root);
20
21    // 3. 属性を削除する対象となる要素 'data' を作成し、ルート要素に追加します。
22    $element = $dom->createElement('data');
23    $root->appendChild($element);
24
25    // 4. 削除する名前空間付き属性の情報を定義します。
26    $namespaceURI = 'http://example.com/ns/data'; // 属性の名前空間URI
27    $prefix = 'myd';                               // 属性のプレフィックス
28    $localName = 'id';                             // 属性のローカル名 (プレフィックスを含まない部分)
29    $attributeValue = 'A123';                      // 属性の値
30
31    // 5. DOMElement::setAttributeNS を使用して、名前空間付き属性を要素に追加します。
32    // 第1引数: 名前空間URI
33    // 第2引数: プレフィックスとローカル名を結合した修飾名 (例: "myd:id")
34    // 第3引数: 属性の値
35    $element->setAttributeNS($namespaceURI, $prefix . ':' . $localName, $attributeValue);
36
37    // 削除対象ではない別の属性も追加してみます（影響がないことを示すため）。
38    $element->setAttribute('standard-attr', 'value-xyz');
39
40    // 属性削除前のXML構造を表示します。
41    echo "--- 属性削除前のXML ---" . PHP_EOL;
42    echo $dom->saveXML() . PHP_EOL;
43
44    // 6. DOMElement::removeAttributeNS メソッドを使用して、名前空間付き属性を削除します。
45    // 第1引数: 削除したい属性の名前空間URI
46    // 第2引数: 削除したい属性のローカル名 (プレフィックスを含まない)
47    echo PHP_EOL . "名前空間付き属性 '" . $prefix . ":" . $localName . "' を削除します..." . PHP_EOL . PHP_EOL;
48    $element->removeAttributeNS($namespaceURI, $localName);
49
50    // 属性削除後のXML構造を表示します。
51    // 'myd:id' 属性が削除されていることを確認できます。
52    echo "--- 属性削除後のXML ---" . PHP_EOL;
53    echo $dom->saveXML() . PHP_EOL;
54}
55
56// 上記の関数を実行して、動作を確認します。
57exampleRemoveAttributeNS();

PHPのDOMElement::removeAttributeNSメソッドは、DOM要素から指定された名前空間URIとローカル名に一致する属性を削除するために利用されます。このメソッドは、第一引数に削除したい属性の名前空間URIを、第二引数にプレフィックスを含まない属性のローカル名を指定します。戻り値は特にありません。

サンプルコードでは、まず新しいXMLドキュメントを作成し、dataという要素を追加しています。次に、http://example.com/ns/dataという名前空間を持つmyd:idという属性をdata要素に追加し、その後にstandard-attrという名前空間を持たない通常の属性も追加しています。属性が追加された後のXML構造を表示することで、現在の状態を確認できます。

その後、removeAttributeNSメソッドを呼び出し、先ほど追加した名前空間URIとローカル名idを指定してmyd:id属性の削除を試みています。このメソッドの実行により、指定された属性が要素から取り除かれます。削除後のXML構造を再度表示すると、myd:id属性が要素から完全に消えていることが確認できます。一方、削除対象ではなかったstandard-attr属性はそのまま残っています。この機能は、XMLドキュメント内の名前空間付き属性を動的に管理する際に大変役立ちます。