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

Copy
1<?php
2
3/**
4 * Dom\HTMLElement::removeAttributeNS() メソッドの使用例。
5 * HTML要素から指定された名前空間に属する属性を削除する方法を示します。
6 *
7 * このサンプルでは、'xlink' 名前空間に属する 'href' 属性を削除します。
8 * システムエンジニアを目指す初心者の方でも理解しやすいように、基本的なHTML要素操作から順を追って説明します。
9 */
10
11// 1. 新しいDOMドキュメントを作成します。
12// DOMはHTMLやXMLドキュメントの構造を表現・操作するためのAPIです。
13// '1.0' はXMLのバージョン、'UTF-8' は文字エンコーディングを指定します。
14$document = new Dom\Document('1.0', 'UTF-8');
15// 出力されるHTMLを見やすくするために、自動整形を有効にします。
16$document->formatOutput = true;
17
18// 2. HTML要素（例: <div>）を作成し、ドキュメントのルート要素として追加します。
19// createElement() メソッドは新しい要素ノードを作成します。
20// Dom\HTMLElementはDom\Elementを継承しており、HTML要素に特化した機能を提供します。
21// ここで作成される $element は、HTMLコンテキストではDom\HTMLElementとして機能します。
22$element = $document->createElement('div');
23$document->appendChild($element);
24
25// 3. 要素に名前空間付きの属性と通常の属性を追加します。
26// removeAttributeNS() の動作を確認するため、まず属性を追加します。
27// 'xlink' 名前空間に属する 'href' 属性を追加します。
28$namespaceUri = 'http://www.w3.org/1999/xlink'; // 'xlink' 名前空間のURI (一意の識別子)
29$qualifiedName = 'xlink:href';                   // プリフィックス付きの属性名 (例: <div xlink:href="...">)
30$localName = 'href';                             // 属性のローカル名 (プリフィックスなしの名前)
31$attributeValue = 'https://example.com/resource'; // 属性に設定する値
32
33// setAttributeNS() を使用して、名前空間付きの属性を要素に追加します。
34$element->setAttributeNS($namespaceUri, $qualifiedName, $attributeValue);
35// 比較のために、名前空間を持たない通常の属性も追加します。
36$element->setAttribute('data-info', 'some-data');
37
38echo "--- 属性削除前のHTML ---\n";
39// 現在のDOMドキュメントのHTMLコンテンツを出力します。
40// ここでは 'xlink:href' と 'data-info' の両方の属性が見られます。
41echo $document->saveHTML() . "\n";
42
43// 4. Dom\HTMLElement::removeAttributeNS() を使用して、名前空間付きの属性を削除します。
44// 最初の引数は属性が属する名前空間のURI、2番目の引数は属性のローカル名です。
45// このメソッドは属性を削除するだけで、戻り値はありません (void)。
46$element->removeAttributeNS($namespaceUri, $localName);
47
48echo "\n--- 属性削除後のHTML ---\n";
49// 属性削除後のDOMドキュメントのHTMLコンテンツを出力します。
50// 'xlink:href' 属性が削除され、'data-info' 属性のみが残っていることが確認できます。
51echo $document->saveHTML() . "\n";
52
53// 削除が正常に行われたかを確認するための補足メッセージです。
54// hasAttributeNS() を使って、特定の名前空間属性が存在するかどうかをチェックできます。
55if (!$element->hasAttributeNS($namespaceUri, $localName)) {
56    echo "\n[確認] 名前空間属性 'xlink:href' は正常に削除されました。\n";
57} else {
58    echo "\n[エラー] 名前空間属性 'xlink:href' が削除されませんでした。\n";
59}
60
61?>

このPHPサンプルコードは、Dom\HTMLElement::removeAttributeNS() メソッドを使って、HTML要素から特定の名前空間に属する属性を削除する方法を初心者向けに示しています。

まず、HTMLドキュメントをPHPのDom\Documentオブジェクトとして作成し、操作対象となるdiv要素を追加します。次に、setAttributeNS() メソッドを用いて、xlink:hrefという名前空間付きの属性と、data-infoという通常の属性を要素に追加します。ここで、xlinkは名前空間のプレフィックスであり、その実体はURI (http://www.w3.org/1999/xlink) で識別されます。

removeAttributeNS() メソッドは、この名前空間付きの属性を削除するために使用されます。第一引数には削除したい属性が属する名前空間のURIを、第二引数にはその属性のローカル名（この例ではhref）を指定します。これにより、同じローカル名を持つ別の名前空間の属性とは区別して、正確な属性を削除できます。このメソッドの戻り値はvoidであり、属性を削除する処理のみを行い、結果を値として返しません。

コードの実行結果として、属性削除前と削除後のHTML内容が出力され、xlink:href属性が正しく削除されていることが確認できます。最後に、hasAttributeNS() メソッドを用いて、属性が実際に存在しないことをプログラム的に検証し、削除が成功したことをメッセージで示しています。

Copy
1<?php
2
3// Dom\HTMLElement::removeAttributeNS の使用例を示す関数
4function demonstrateRemoveAttributeNS(): void
5{
6    // 新しいDOMドキュメントを作成
7    $dom = new DOMDocument('1.0', 'UTF-8');
8    // 出力を整形して見やすくする設定
9    $dom->formatOutput = true;
10
11    // 'div' 要素を作成します。
12    // PHP 8ではDOMElementクラスがDom\HTMLElementを継承しているため、
13    // Dom\HTMLElementのメソッドをDOMElementのインスタンスで直接呼び出すことができます。
14    $divElement = $dom->createElement('div');
15    $divElement->setAttribute('id', 'myElement'); // 通常の属性を追加
16
17    // 作成した 'div' 要素をドキュメントのルート要素として追加します。
18    $dom->appendChild($divElement);
19
20    echo "--- ドキュメント初期状態 ---\n";
21    echo $dom->saveHTML() . "\n\n";
22
23    // --- 名前空間を持たない属性の追加と削除の例 ---
24    echo "--- 名前空間を持たない属性の操作例 --- \n";
25
26    // Dom\HTMLElement::setAttributeNS を使って、名前空間を持たないカスタム属性を追加します。
27    // 第1引数に null を指定すると、名前空間を持たない属性として扱われます。
28    $divElement->setAttributeNS(null, 'data-custom-attribute', 'some-value');
29    echo "属性 'data-custom-attribute' を追加後:\n";
30    echo $dom->saveHTML() . "\n\n";
31
32    // Dom\HTMLElement::removeAttributeNS を使って、名前空間を持たない属性を削除します。
33    // 第1引数に null、第2引数に削除したい属性のローカル名 (localName) を指定します。
34    $divElement->removeAttributeNS(null, 'data-custom-attribute');
35    echo "属性 'data-custom-attribute' を削除後:\n";
36    echo $dom->saveHTML() . "\n\n";
37
38    // --- 特定の名前空間を持つ属性の追加と削除の例 ---
39    echo "--- 特定の名前空間を持つ属性の操作例 --- \n";
40
41    // SVG要素を想定した名前空間付き属性を追加します。
42    $svgNamespace = 'http://www.w3.org/2000/svg';
43    // Dom\HTMLElement::setAttributeNS の第2引数には、通常、接頭辞付きの名前（qualifiedName）を指定します。
44    // 例: 'svg:viewBox'
45    $divElement->setAttributeNS($svgNamespace, 'svg:viewBox', '0 0 100 100');
46    echo "名前空間付き属性 'svg:viewBox' を追加後:\n";
47    echo $dom->saveHTML() . "\n\n";
48
49    // Dom\HTMLElement::removeAttributeNS を使って、名前空間付き属性を削除します。
50    // 第1引数に名前空間URI、第2引数には接頭辞を含まないローカル名（localName）を指定します。
51    // setAttributeNSとは異なり、localNameのみを渡す点に注意してください。
52    $divElement->removeAttributeNS($svgNamespace, 'viewBox');
53    echo "名前空間付き属性 'svg:viewBox' を削除後:\n";
54    echo $dom->saveHTML() . "\n\n";
55
56    // 存在しない属性を削除しようとしても、エラーにはならず、何も影響を与えません。
57    echo "--- 存在しない属性を削除しようとした場合 (影響なし) --- \n";
58    $divElement->removeAttributeNS(null, 'non-existent-attribute');
59    echo $dom->saveHTML() . "\n\n";
60}
61
62// 上記で定義した関数を実行します。
63demonstrateRemoveAttributeNS();

PHP 8のDom\HTMLElement::removeAttributeNSメソッドは、DOM要素から特定の名前空間に属する属性、または名前空間を持たない属性を削除するために使用されます。

このメソッドは二つの引数を取ります。$namespaceには削除したい属性の名前空間URIを指定し、名前空間を持たない場合はnullを指定します。$localNameには、属性のローカル名（接頭辞を含まない名前）を指定します。戻り値はvoidで、属性削除後に値は返しません。

サンプルコードは、div要素への属性操作を通じてこのメソッドの具体的な使い方を示しています。名前空間を持たない属性を削除する際は、第一引数にnull、第二引数にその属性のローカル名を渡します。

一方、名前空間付きの属性を削除する際には、第一引数に名前空間URI、第二引数には接頭辞を含まないローカル名を指定します。属性を追加するsetAttributeNSとは異なり、removeAttributeNSでは常にローカル名のみを渡す点がポイントです。

存在しない属性を削除しようとしてもエラーは発生しません。