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

Copy
1<?php
2
3/**
4 * DOMElementのgetAttributeNodeメソッドの使用例を示します。
5 * この関数は、新しいDOM要素を作成し、属性を追加した後、
6 * getAttributeNodeメソッドを使って特定の属性ノードを取得し、その情報を表示します。
7 *
8 * システムエンジニアを目指す初心者の方にも分かりやすいように、
9 * DOMElementオブジェクトの作成から属性の追加、そしてgetAttributeNodeでの取得までを
10 * 順を追って説明します。
11 */
12function showGetAttributeNodeExample(): void
13{
14    // 1. DOMDocumentオブジェクトを作成します。
15    // これはHTMLやXML文書全体を表現するための基盤となります。
16    $dom = new DOMDocument('1.0', 'UTF-8');
17    $dom->formatOutput = true; // 出力されるXML/HTMLを整形するために設定します。
18
19    // 2. ルートとなるDOMElement（例えば 'div' タグ）を作成し、DOMDocumentに追加します。
20    // DOMElementはHTML/XMLの個々の要素（タグ）を表します。
21    $rootElement = $dom->createElement('div');
22    $dom->appendChild($rootElement);
23
24    // 3. 作成したDOMElementにsetAttributeメソッドで属性を追加します。
25    // ここでは 'id' と 'class' 属性を追加しています。
26    $rootElement->setAttribute('id', 'main-container');
27    $rootElement->setAttribute('class', 'wrapper');
28    $rootElement->setAttribute('data-custom', 'some-value');
29
30    echo "--- 作成した要素と属性 ---\n";
31    // saveHTML($rootElement) は、指定された要素のHTML表現を文字列として返します。
32    echo $dom->saveHTML($rootElement);
33    echo "--------------------------\n\n";
34
35    // 4. DOMElement::getAttributeNode() メソッドを使って属性ノードを取得します。
36    // このメソッドは、指定された属性名に対応するDOMAttrオブジェクトを返します。
37    // 属性が存在しない場合は null を返します。
38
39    // 存在する属性 'id' のノードを取得する例
40    echo "属性 'id' のノードを検索中...\n";
41    $idAttributeNode = $rootElement->getAttributeNode('id');
42    if ($idAttributeNode !== null) {
43        // 属性ノードが見つかった場合、その名前と値を出力します。
44        echo "  属性 'id' のノードが見つかりました。\n";
45        echo "    属性名: " . $idAttributeNode->name . "\n"; // DOMAttrオブジェクトの 'name' プロパティ
46        echo "    属性値: " . $idAttributeNode->value . "\n"; // DOMAttrオブジェクトの 'value' プロパティ
47    } else {
48        echo "  属性 'id' のノードは見つかりませんでした。\n";
49    }
50    echo "\n";
51
52    // 存在する属性 'data-custom' のノードを取得する例
53    echo "属性 'data-custom' のノードを検索中...\n";
54    $customAttributeNode = $rootElement->getAttributeNode('data-custom');
55    if ($customAttributeNode !== null) {
56        echo "  属性 'data-custom' のノードが見つかりました。\n";
57        echo "    属性名: " . $customAttributeNode->name . "\n";
58        echo "    属性値: " . $customAttributeNode->value . "\n";
59    } else {
60        echo "  属性 'data-custom' のノードは見つかりませんでした。\n";
61    }
62    echo "\n";
63
64    // 存在しない属性 'style' のノードを取得する例
65    echo "属性 'style' のノードを検索中...\n";
66    $styleAttributeNode = $rootElement->getAttributeNode('style');
67    if ($styleAttributeNode !== null) {
68        // この場合は実行されません
69        echo "  属性 'style' のノードが見つかりました。\n";
70        echo "    属性名: " . $styleAttributeNode->name . "\n";
71        echo "    属性値: " . $styleAttributeNode->value . "\n";
72    } else {
73        echo "  属性 'style' のノードは見つかりませんでした。 (期待される結果)\n";
74    }
75    echo "\n";
76}
77
78// 関数を実行してサンプルコードの動作を確認します。
79showGetAttributeNodeExample();

PHPのDOMElement::getAttributeNodeメソッドは、HTMLやXMLドキュメント内の要素（タグ）から、指定した名前の属性ノード（DOMAttrオブジェクト）を取得するために使用されます。このサンプルコードでは、まずDOMDocumentとDOMElementを作成し、複数の属性を追加した後、getAttributeNodeメソッドを使って特定の属性ノードを取得する手順を示しています。

このメソッドの引数string $qualifiedNameには、取得したい属性の名前（例えば、「id」や「data-custom」）を文字列で指定します。戻り値はDOMAttr|null型で、指定された属性が要素に存在した場合は、その属性を表すDOMAttrオブジェクトが返されます。このオブジェクトからは、属性名（$attributeNode->name）や属性値（$attributeNode->value）などの情報にアクセスできます。一方、指定された属性が要素に存在しない場合は、戻り値としてnullが返されます。そのため、サンプルコードのように取得後にnullチェックを行うことで、属性の有無に応じて適切な処理を安全に分岐させることが重要です。

getAttributeNodeメソッドは、単に属性値を取得するだけでなく、属性自体をオブジェクトとして扱いたい場合に特に有用です。

Copy
1<?php
2
3/**
4 * DOMElement::getAttributeNode メソッドの使用例を示します。
5 * この関数は、指定されたHTMLまたはXMLドキュメントから特定の要素を取得し、
6 * その要素の特定の属性ノード（DOMAttrオブジェクト）を取得します。
7 *
8 * DOMAttr オブジェクトは、属性の名前と値の両方を含みます。
9 * 属性が存在しない場合は null を返します。
10 *
11 * @param string $htmlContent 処理するHTMLまたはXML文字列
12 */
13function demonstrateGetAttributeNode(string $htmlContent): void
14{
15    // DOMDocument オブジェクトを作成します。
16    // HTMLやXML文書を読み込み、解析するために使用します。
17    $dom = new DOMDocument();
18
19    // HTML文字列をDOMDocumentにロードします。
20    // loadHTMLはHTML5の新しい要素などで警告を出すことがあるため、
21    // 初心者が試す際にエラーが出ないよう一時的に警告を抑制しています。
22    // 本番環境ではエラーハンドリングを適切に行うことを推奨します。
23    @$dom->loadHTML($htmlContent);
24
25    echo "--- DOMElement::getAttributeNode の使用例 ---" . PHP_EOL;
26
27    // ドキュメントから最初の<img>要素を取得します。
28    // getElementsByTagName は DOMNodeList オブジェクトを返します。
29    $imgElements = $dom->getElementsByTagName('img');
30
31    if ($imgElements->length > 0) {
32        // DOMNodeListから最初の要素（DOMElement）を取り出します。
33        /** @var DOMElement $imgElement */
34        $imgElement = $imgElements->item(0);
35
36        echo "対象要素: <" . $imgElement->nodeName . ">" . PHP_EOL;
37
38        // 'src' 属性ノードを取得します。
39        // getAttributeNode は DOMAttr オブジェクトまたは null を返します。
40        $srcAttrNode = $imgElement->getAttributeNode('src');
41        if ($srcAttrNode !== null) {
42            echo "  'src' 属性名: " . $srcAttrNode->name . PHP_EOL;
43            echo "  'src' 属性値: " . $srcAttrNode->value . PHP_EOL;
44        } else {
45            echo "  'src' 属性は見つかりませんでした。" . PHP_EOL;
46        }
47
48        // 'alt' 属性ノードを取得します。
49        $altAttrNode = $imgElement->getAttributeNode('alt');
50        if ($altAttrNode !== null) {
51            echo "  'alt' 属性名: " . $altAttrNode->name . PHP_EOL;
52            echo "  'alt' 属性値: " . $altAttrNode->value . PHP_EOL;
53        } else {
54            echo "  'alt' 属性は見つかりませんでした。" . PHP_EOL;
55        }
56
57        // 存在しない属性（例: 'width'）を試します。
58        // この場合、getAttributeNode は null を返します。
59        $widthAttrNode = $imgElement->getAttributeNode('width');
60        if ($widthAttrNode !== null) {
61            echo "  'width' 属性名: " . $widthAttrNode->name . PHP_EOL;
62            echo "  'width' 属性値: " . $widthAttrNode->value . PHP_EOL;
63        } else {
64            echo "  'width' 属性は見つかりませんでした。（期待通り null が返る）" . PHP_EOL;
65        }
66
67        // 参考情報: 要素のすべての属性を列挙する方法
68        // キーワード「getattributes」に関連して、DOMElement::attributes プロパティ
69        // を使用すると、その要素のすべての属性（DOMNamedNodeMap）にアクセスできます。
70        echo PHP_EOL . "  --- 要素のすべての属性を列挙 (DOMElement::attributes) ---" . PHP_EOL;
71        foreach ($imgElement->attributes as $attr) {
72            /** @var DOMAttr $attr */
73            echo "    属性名: " . $attr->name . ", 属性値: " . $attr->value . PHP_EOL;
74        }
75
76    } else {
77        echo "指定されたHTMLから<img>要素が見つかりませんでした。" . PHP_EOL;
78    }
79
80    echo PHP_EOL . "--- 別の要素での使用例 ---" . PHP_EOL;
81
82    // ドキュメントから最初の<div>要素を取得します。
83    $divElements = $dom->getElementsByTagName('div');
84    if ($divElements->length > 0) {
85        /** @var DOMElement $divElement */
86        $divElement = $divElements->item(0);
87        echo "対象要素: <" . $divElement->nodeName . ">" . PHP_EOL;
88
89        // 'id' 属性ノードを取得します。
90        $idAttrNode = $divElement->getAttributeNode('id');
91        if ($idAttrNode !== null) {
92            echo "  'id' 属性名: " . $idAttrNode->name . PHP_EOL;
93            echo "  'id' 属性値: " . $idAttrNode->value . PHP_EOL;
94        } else {
95            echo "  'id' 属性は見つかりませんでした。" . PHP_EOL;
96        }
97
98        // 'class' 属性ノードを取得します。
99        $classAttrNode = $divElement->getAttributeNode('class');
100        if ($classAttrNode !== null) {
101            echo "  'class' 属性名: " . $classAttrNode->name . PHP_EOL;
102            echo "  'class' 属性値: " . $classAttrNode->value . PHP_EOL;
103        } else {
104            echo "  'class' 属性は見つかりませんでした。" . PHP_EOL;
105        }
106    }
107}
108
109// サンプルとして使用するHTML文字列を定義します。
110$sampleHtml = <<<HTML
111<!DOCTYPE html>
112<html>
113<head>
114    <title>PHP DOMElement::getAttributeNode Sample</title>
115</head>
116<body>
117    <div id="container" class="wrapper main-content" data-info="example">
118        <h1>Hello DOM</h1>
119        <p>This is a paragraph with some <span style="color: blue;">inline</span> text.</p>
120        <img src="images/logo.png" alt="Company Logo" data-identifier="12345">
121    </div>
122    <div id="footer">
123        <p>Copyright &copy; 2023</p>
124    </div>
125</body>
126</html>
127HTML;
128
129// 定義したHTML文字列を使用して関数を実行し、動作を確認します。
130demonstrateGetAttributeNode($sampleHtml);

PHPのDOMElement::getAttributeNodeメソッドは、HTMLやXMLドキュメントの特定の要素から、指定した属性の情報を取得するために使われます。このメソッドは、DOMElementオブジェクトに属しており、引数として取得したい属性の名前を文字列（$qualifiedName）で受け取ります。

戻り値は、その属性が存在すれば、属性の名前と値の両方を含むDOMAttrオブジェクトです。もし指定された属性が要素に見つからない場合は、nullが返されます。これにより、属性の存在を安全に確認しながら処理を進めることができます。

サンプルコードでは、まずHTML文字列をDOMDocumentにロードし、文書全体をプログラムで扱えるようにしています。次に、<img>要素や<div>要素などの特定の要素を抽出します。これらの要素に対してgetAttributeNode('src')やgetAttributeNode('id')のように呼び出すことで、それぞれの属性ノードを取得し、その名前と値を出力しています。属性が存在しない場合（例えば、<img>要素に'width'属性がない場合）はnullが返されることが確認できます。また、要素のすべての属性をまとめて取得したい場合は、DOMElement::attributesプロパティを使用する方法も補足しています。このメソッドは、Webページからの情報抽出や文書構造の解析など、HTML/XMLコンテンツをプログラムで操作する際に非常に役立ちます。