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

Copy
1<?php
2
3// Dom\Element::removeAttributeNS メソッドのサンプルコード
4// このメソッドは、指定された名前空間URIとローカル名を持つ属性を要素から削除します。
5
6// DOMDocumentクラスを使用して新しいXMLドキュメントを作成します。
7// これはXMLデータを操作するための主要なオブジェクトです。
8$dom = new DOMDocument('1.0', 'UTF-8');
9// 出力時にXMLが読みやすいように整形する設定です。
10$dom->formatOutput = true;
11
12// ルート要素 'document' を作成し、ドキュメントに追加します。
13$documentRoot = $dom->createElement('document');
14$dom->appendChild($documentRoot);
15
16// 名前空間 'http://example.com/ns1' を持つ要素 'item' を作成します。
17// 'ns1:item' はプレフィックスとローカル名を結合した修飾名です。
18// この要素は Dom\Element のインスタンスとして扱われます（PHP 8ではDOMElementがこれを継承）。
19$elementWithNamespace = $dom->createElementNS('http://example.com/ns1', 'ns1:item');
20$documentRoot->appendChild($elementWithNamespace);
21
22// 上で作成した要素に、名前空間を持つ属性を追加します。
23// 属性の完全な名前は 'ns1:id' となりますが、
24// 名前空間URIは 'http://example.com/ns1'、ローカル名は 'id' です。
25$elementWithNamespace->setAttributeNS('http://example.com/ns1', 'ns1:id', 'unique-id-123');
26
27// 別の名前空間を持つ属性も追加してみます。
28// 名前空間URIは 'http://example.com/ns2'、ローカル名は 'status' です。
29$elementWithNamespace->setAttributeNS('http://example.com/ns2', 'ns2:status', 'active');
30
31echo "--- 属性削除前のXML ---\n";
32// 現在のXML構造を出力して確認します。
33echo $dom->saveXML();
34echo "\n";
35
36// Dom\Element::removeAttributeNS メソッドを使用して、名前空間付き属性を削除します。
37// 引数:
38//   1. string $namespace: 削除したい属性の名前空間URI
39//   2. string $localName: 削除したい属性のローカル名（プレフィックスを含まない部分）
40// ここでは 'http://example.com/ns1' 名前空間に属する 'id' 属性を削除します。
41$elementWithNamespace->removeAttributeNS('http://example.com/ns1', 'id');
42
43echo "--- 'id' 属性削除後のXML ---\n";
44// 'id' 属性が削除された後のXML構造を出力して確認します。
45// 'ns1:id' 属性がなくなっていることを確認してください。
46echo $dom->saveXML();
47echo "\n";
48
49// さらに別の属性も削除してみましょう。
50// 'http://example.com/ns2' 名前空間に属する 'status' 属性を削除します。
51$elementWithNamespace->removeAttributeNS('http://example.com/ns2', 'status');
52
53echo "--- 'status' 属性削除後のXML ---\n";
54// 'status' 属性が削除された後のXML構造を出力して確認します。
55// 'ns2:status' 属性がなくなっていることを確認してください。
56echo $dom->saveXML();
57echo "\n";
58
59?>

Dom\Element::removeAttributeNSは、PHP 8で導入されたDOM拡張機能の一部で、XML文書内の要素から特定の名前空間に属する属性を削除する際に使用されるメソッドです。このメソッドは、XMLの標準や特定のスキーマに従って名前空間が厳密に管理されている場合、正確な属性の操作を行うために非常に重要です。

引数としては、まず string $namespace で削除したい属性の名前空間URIを正確に指定する必要があります。次に string $localName で、プレフィックスを含まない属性のローカル名（実際の属性名部分）を文字列で指定します。この二つの情報が揃うことで、複数の名前空間に同じローカル名の属性が存在していても、意図した属性のみを削除することが可能になります。

戻り値は void であり、属性の削除が成功しても特に値は返しません。

サンプルコードでは、DOMDocument を用いてXML文書を作成し、名前空間を持つ要素とそれに付随する属性を追加しています。そして、removeAttributeNS メソッドを呼び出し、指定した名前空間URIとローカル名に一致する属性を削除する一連の流れが示されています。属性削除前後のXML出力を比較することで、目的の属性が正しく削除されている様子を視覚的に確認でき、名前空間を意識した属性操作の仕組みを理解する助けとなります。

Copy
1<?php
2
3/**
4 * DOMDocument を使用してXML要素から名前空間付きの属性を削除するサンプル関数。
5 * システムエンジニアを目指す初心者向けに、Dom\Element::removeAttributeNS メソッドの使用方法を示します。
6 *
7 * PHP 8 では Dom\Element は DOMElement のエイリアスです。
8 */
9function removeNamespaceAttributeExample(): void
10{
11    // 1. 新しい DOMDocument オブジェクトを作成します。
12    //    XMLバージョンとエンコーディングを指定し、出力時に整形するように設定します。
13    $dom = new DOMDocument('1.0', 'UTF-8');
14    $dom->formatOutput = true;
15
16    // 2. ルート要素 'root' を作成し、ドキュメントに追加します。
17    $rootElement = $dom->createElement('root');
18    $dom->appendChild($rootElement);
19
20    // 3. 名前空間を持つ要素 'ns:item' を作成し、ルート要素に追加します。
21    //    'http://example.com/data-ns' がこの要素の名前空間URIです。
22    $elementNamespaceUri = 'http://example.com/data-ns';
23    $elementWithNs = $dom->createElementNS($elementNamespaceUri, 'ns:item');
24    $rootElement->appendChild($elementWithNs);
25
26    // 4. その要素に名前空間付きの属性 'attr:dataId' を追加します。
27    //    'http://example.com/attr-ns' がこの属性の名前空間URIです。
28    //    'dataId' が属性のローカル名です。
29    $attributeNamespaceUri = 'http://example.com/attr-ns';
30    $attributeLocalName = 'dataId';
31    $attributePrefix = 'attr'; // 属性のプレフィックス
32    $attributeFullName = $attributePrefix . ':' . $attributeLocalName; // プレフィックス付きの完全な属性名
33    $attributeValue = 'A123';
34    $elementWithNs->setAttributeNS($attributeNamespaceUri, $attributeFullName, $attributeValue);
35
36    echo "--- 属性削除前のXML ---" . PHP_EOL;
37    echo $dom->saveXML() . PHP_EOL;
38
39    // 5. Dom\Element オブジェクトを取得します。
40    //    $elementWithNs は DOMElement (Dom\Element のエイリアス) のインスタンスです。
41    //    removeAttributeNS はこの Dom\Element インスタンスに対して呼び出されます。
42    $domElement = $elementWithNs;
43
44    // 6. removeAttributeNS メソッドを使用して、名前空間付きの属性を削除します。
45    //    引数には、削除したい属性の名前空間URIとローカル名を正確に渡す必要があります。
46    echo "属性 '" . $attributeFullName . "' (名前空間URI: '" . $attributeNamespaceUri . "') を削除します..." . PHP_EOL;
47    $domElement->removeAttributeNS($attributeNamespaceUri, $attributeLocalName);
48
49    echo PHP_EOL . "--- 属性削除後のXML ---" . PHP_EOL;
50    echo $dom->saveXML() . PHP_EOL;
51}
52
53// サンプル関数を実行します。
54removeNamespaceAttributeExample();

このサンプルコードは、PHP 8でXML要素から名前空間付きの属性を削除する方法を、Dom\Element::removeAttributeNSメソッドを用いて具体的に示しています。PHP 8ではDom\ElementはDOMElementのエイリアスとして機能します。

コードではまず、DOMDocumentオブジェクトを作成し、XMLのルート要素を設定します。次に、ns:itemという名前空間を持つ要素を作成し、さらにその要素に対してattr:dataIdという名前空間付きの属性を追加します。removeAttributeNSメソッドを呼び出す前には、この属性がXML内に存在していることが出力で確認できます。

その後、対象となるDom\Elementインスタンスに対してremoveAttributeNSメソッドが呼び出されます。このメソッドは、指定された名前空間URIとローカル名に一致する属性をXML要素から削除する役割を持っています。引数として、削除したい属性の「名前空間URI (string $namespace)」と「ローカル名 (string $localName)」を正確に渡す必要があります。たとえば、http://example.com/attr-nsという名前空間URIとdataIdというローカル名を持つ属性を指定することで、対象の属性を特定し削除します。

removeAttributeNSメソッドの戻り値はvoidであるため、このメソッド自体は値を返しませんが、呼び出し元のDom\Elementオブジェクト、すなわち基盤となるXML構造が直接変更されます。メソッド実行後のXML出力を見ると、指定した名前空間付き属性が正常に削除されていることがわかります。この機能は、XMLデータをプログラム的に加工する際に、特定の属性を効率的に除去するために非常に有用です。