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

Copy
1<?php
2
3// DOMDocumentを新規作成し、HTMLの出力形式を設定します
4$dom = new DOMDocument('1.0', 'utf-8');
5$dom->formatOutput = true; // 整形された出力のために設定
6
7// ルート要素を作成し、DOMに添付します
8$root = $dom->createElement('bookstore');
9$dom->appendChild($root);
10
11// 属性を持つ要素を作成します
12$book = $dom->createElement('book', 'The PHP Manual');
13$root->appendChild($book);
14
15// DOMAttrオブジェクトとして属性を作成し、値を設定します
16$attribute = $dom->createAttribute('category');
17$attribute->value = 'programming';
18
19// 属性をbook要素に設定します
20$book->setAttributeNode($attribute);
21
22echo "--- 属性を削除する前のDOM状態 ---\n";
23echo $dom->saveHTML();
24echo "\n";
25
26// 削除したいDOMAttrオブジェクトを取得します
27// removeAttributeNodeは、DOMAttrオブジェクトそのものを引数として受け取ります
28$attrToRemove = $book->getAttributeNode('category');
29
30if ($attrToRemove instanceof DOMAttr) {
31    // book要素から属性ノードを削除します
32    // 削除されたDOMAttrオブジェクトが戻り値として返されます
33    $removedAttr = $book->removeAttributeNode($attrToRemove);
34
35    echo "--- 属性を削除した後のDOM状態 ---\n";
36    echo $dom->saveHTML();
37    echo "\n";
38
39    // 削除された属性の情報を表示します
40    echo "削除された属性名: " . $removedAttr->name . "\n";
41    echo "削除された属性値: " . $removedAttr->value . "\n";
42} else {
43    echo "属性 'category' が見つからなかったため、削除できませんでした。\n";
44}
45

PHPのDOMElement::removeAttributeNodeメソッドは、XMLやHTMLのDOM（Document Object Model）操作において、特定の要素から属性ノードを削除するために使用されます。このメソッドはDOMElementクラスに属し、要素に直接関連付けられた属性を扱います。

引数には、削除したいDOMAttrオブジェクトを直接指定します。これは、属性名ではなく、取得済みのDOMAttrインスタンスそのものを渡す必要があることを意味します。メソッドが正常に実行されると、削除されたDOMAttrオブジェクト自身が戻り値として返されます。これにより、削除された属性の名前や値などの情報を後で参照することが可能です。

サンプルコードでは、まずDOMDocumentを作成し、book要素にcategoryという属性（値はprogramming）を追加しています。その後、getAttributeNodeメソッドを使用してこのcategory属性のDOMAttrオブジェクトを取得し、それをremoveAttributeNodeメソッドの引数として渡すことで、book要素からcategory属性が削除されます。削除前後のDOM状態の出力により、属性が正しく削除されたことを確認でき、戻り値の$removedAttrから削除された属性の情報を取得して表示しています。

Copy
1<?php
2
3// DOMDocumentオブジェクトを作成し、XMLのバージョンとエンコーディングを指定
4$dom = new DOMDocument('1.0', 'UTF-8');
5// 出力時にXMLを整形し、見やすくする設定
6$dom->formatOutput = true;
7
8// ルート要素 'document' を作成し、DOMドキュメントに追加
9$root = $dom->createElement('document');
10$dom->appendChild($root);
11
12// 'item' という名前の子要素を作成
13$itemElement = $dom->createElement('item');
14// 'item' 要素にテキストコンテンツを追加
15$itemElement->textContent = 'これはテストアイテムです。';
16
17// 'id' 属性を追加
18$itemElement->setAttribute('id', 'item1');
19// 'status' 属性を追加 (この属性が削除の対象)
20$itemElement->setAttribute('status', 'active');
21// 'type' 属性を追加
22$itemElement->setAttribute('type', 'primary');
23
24// 'item' 要素をルート要素 'document' に子として追加
25$root->appendChild($itemElement);
26
27echo "--- 属性削除前のXMLドキュメント ---" . PHP_EOL;
28echo $dom->saveXML() . PHP_EOL; // 現在のXML構造を出力
29
30// 削除したい属性ノード 'status' を取得
31// DOMElement::getAttributeNode() は指定された属性の DOMAttr オブジェクトを返す
32$attributeToRemove = $itemElement->getAttributeNode('status');
33
34// 属性ノードが正常に取得できたかを確認
35if ($attributeToRemove instanceof DOMAttr) {
36    // DOMElement::removeAttributeNode() を使用して属性ノードを削除
37    // このメソッドは削除された DOMAttr オブジェクトを返します
38    $removedAttribute = $itemElement->removeAttributeNode($attributeToRemove);
39
40    echo "--- 属性削除後のXMLドキュメント ---" . PHP_EOL;
41    echo $dom->saveXML() . PHP_EOL; // 属性削除後のXML構造を出力
42
43    echo "削除された属性の名前: " . $removedAttribute->name . PHP_EOL;
44    echo "削除された属性の値: " . $removedAttribute->value . PHP_EOL;
45} else {
46    echo "指定された属性 'status' は要素に見つかりませんでした。" . PHP_EOL;
47}
48
49?>

このPHPサンプルコードは、DOM（Document Object Model）操作を使用して、XML要素から特定の属性を削除する方法を示しています。

まず、DOMDocumentオブジェクトを作成し、XMLのバージョンやエンコーディング、出力時にXMLを整形するための設定を行います。次に、documentというルート要素と、その子要素としてitem要素を作成します。このitem要素には、id、status、typeという三つの属性を追加しており、この中でstatus属性が今回の削除対象となります。

属性を削除する手順として、削除したい属性を表すDOMAttrオブジェクトをDOMElement::getAttributeNode()メソッドで取得します。この取得したDOMAttrオブジェクトを引数として、DOMElement::removeAttributeNode()メソッドを呼び出すことで、対象の要素から指定された属性が削除されます。

removeAttributeNode()メソッドは、引数で渡されたDOMAttrオブジェクト（つまり削除された属性ノード自身）を戻り値として返します。これにより、属性が削除された後でも、その属性の名前や値といった情報を確認することができます。サンプルコードでは、属性削除前後のXML構造を出力し、status属性が正常に削除されたことを確認できます。これは、XML文書の特定の情報を効率的に操作する際に非常に便利な機能です。