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

Copy
1<?php
2
3// HTMLコンテンツを定義します。
4// 例として、いくつかの属性を持つボタン要素を用意します。
5$htmlContent = '<button id="submitBtn" class="primary large" data-action="submit">送信</button>';
6
7// DOMDocumentオブジェクトを作成します。
8// このオブジェクトを使ってHTMLを解析し、DOMツリーを構築します。
9$dom = new DOMDocument();
10
11// HTMLコンテンツをロードする際に発生する可能性のある警告を一時的に抑制します。
12// これにより、HTMLの構造が厳密でない場合でもスクリプトが停止することなく実行できます。
13libxml_use_internal_errors(true);
14$dom->loadHTML($htmlContent);
15libxml_use_internal_errors(false); // 処理後はエラーハンドリングを元の状態に戻します
16
17// HTMLドキュメントから、特定のIDを持つ要素を取得します。
18// getElementById メソッドは、指定されたIDに合致する DOMElement のインスタンスを返します。
19// PHP 8以降では、DOMElement クラスは Dom\HTMLElement を継承しているため、
20// Dom\HTMLElement のメソッドを直接呼び出すことができます。
21$element = $dom->getElementById('submitBtn');
22
23// 要素が正常に取得できたか確認します。
24if ($element instanceof DOMElement) {
25    echo "取得した要素のタグ名: " . $element->tagName . "\n";
26
27    // 取得した要素が持つすべての属性名を取得します。
28    // Dom\HTMLElement::getAttributeNames() メソッドは、
29    // その要素に定義されているすべての属性名の配列を返します。
30    $attributeNames = $element->getAttributeNames();
31
32    echo "\nこの要素が持つ属性名の一覧:\n";
33    if (empty($attributeNames)) {
34        echo "  この要素には属性がありません。\n";
35    } else {
36        foreach ($attributeNames as $name) {
37            echo "  - " . $name . "\n";
38        }
39    }
40} else {
41    echo "指定されたID ('submitBtn') の要素が見つかりませんでした。\n";
42}
43

Dom\HTMLElement::getAttributeNames()メソッドは、HTML要素が持つすべての属性名を取得するためのPHP 8で導入された機能です。引数はなく、戻り値として属性名の文字列が格納された配列を返します。

このサンプルコードでは、まずHTMLのボタン要素を文字列として定義し、それをDOMDocumentオブジェクトに読み込ませて解析しています。libxml_use_internal_errors関数を使って、HTMLの構文エラーに関する警告を一時的に抑制し、処理が中断しないようにしています。

次に、getElementById()メソッドを使用して、定義したHTMLの中からid="submitBtn"を持つ特定のボタン要素を取得します。PHP 8以降では、DOMElementクラスがDom\HTMLElementを継承しているため、取得した要素から直接Dom\HTMLElementのメソッドを呼び出すことが可能です。

要素が正常に取得できた場合、$element->getAttributeNames()メソッドを呼び出すことで、その要素に定義されているid、class、data-actionといった属性の名前を配列として取得します。この配列をループ処理することで、各属性名を一つずつ表示しています。

このメソッドを利用することで、プログラムからHTML要素の属性情報を動的に把握し、それに基づいて処理を分岐させたり、他の操作を行ったりすることが可能になります。例えば、ウェブスクレイピングで特定の要素が持つ属性情報を収集したり、HTMLエディタのようなツールで属性を一覧表示する際などに役立ちます。

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * 指定されたHTML文字列内の最初のDIV要素の属性名を表示します。
7 *
8 * Dom\HTMLElement::getAttributeNames() メソッドの使用例です。
9 * このメソッドは、要素が持つ全ての属性の名前を配列として返します。
10 *
11 * @param string $htmlString 処理対象のHTML文字列。
12 */
13function displayElementAttributeNames(string $htmlString): void
14{
15    // Dom\Document オブジェクトを作成し、HTMLをロードします。
16    $document = new Dom\Document();
17    // @ を付けているのは、不正なHTMLが与えられた場合に発生する可能性のある警告を抑制するためです。
18    // PHP 8.0では特定のHTML5パーシングオプションは直接指定できないため、デフォルトでロードします。
19    @$document->loadHTML($htmlString);
20
21    // ドキュメントから 'div' タグを持つ全ての要素を取得し、最初の要素にアクセスします。
22    $divElements = $document->getElementsByTagName('div');
23    $element = $divElements->item(0); // 要素がない場合は null を返します。
24
25    // 取得した要素が Dom\HTMLElement のインスタンスであるかを確認します。
26    // Dom\HTMLElement はPHP 8で導入され、DOM要素を表す型です。
27    if ($element instanceof Dom\HTMLElement) {
28        // 処理対象のHTML文字列を表示（改行を除去し一行にする）
29        echo "HTML文字列:\n\"" . str_replace(["\n", "\r"], "", $htmlString) . "\"\n";
30        echo "----------------------------------------\n";
31        echo "取得した最初の 'div' 要素の属性名:\n";
32
33        // getAttributeNames() メソッドを呼び出し、要素が持つ属性の名前を配列で取得します。
34        $attributeNames = $element->getAttributeNames();
35
36        if (empty($attributeNames)) {
37            echo "  この要素には属性がありません。\n";
38        } else {
39            // 取得した属性名を一つずつ表示します。
40            foreach ($attributeNames as $name) {
41                echo "- " . $name . "\n";
42            }
43        }
44    } else {
45        // 'div' 要素が見つからなかった場合のメッセージ
46        echo "HTML文字列:\n\"" . str_replace(["\n", "\r"], "", $htmlString) . "\"\n";
47        echo "----------------------------------------\n";
48        echo "指定されたHTMLから最初の 'div' 要素を見つけることができませんでした。\n";
49    }
50    echo "\n"; // 出力の区切りとして改行
51}
52
53// --- サンプル実行 ---
54
55// 1. 複数の属性を持つ 'div' 要素の例
56$sampleHtmlWithAttributes = '<div id="myId" class="test-class" data-value="123" tabindex="0">コンテンツ</div>';
57displayElementAttributeNames($sampleHtmlWithAttributes);
58
59// 2. 属性を持たない 'div' 要素の例
60$sampleHtmlWithoutAttributes = '<div>シンプルなコンテンツ</div>';
61displayElementAttributeNames($sampleHtmlWithoutAttributes);
62
63// 3. 'div' 要素を含まないHTMLの例
64$sampleHtmlNoDiv = '<p>これは段落です。</p>';
65displayElementAttributeNames($sampleHtmlNoDiv);
66
67?>

PHP 8で提供されるDom\HTMLElement::getAttributeNamesメソッドは、HTML要素が持つ全ての属性の名前を文字列の配列として取得するために使用されます。このメソッドは引数を受け取らず、指定されたHTML要素に設定されている属性名（例えばidやclassなど）を戻り値として配列で返します。

サンプルコードでは、まずDom\Documentオブジェクトを作成し、指定されたHTML文字列をロードしてWebページのような構造として扱えるようにします。次に、このドキュメントから特定のタグ名（ここではdiv）を持つ要素を検索し、最初に見つかったdiv要素を取り出します。取得した要素がDom\HTMLElement型であることを確認した後、その要素に対してgetAttributeNames()メソッドを呼び出しています。

メソッドの呼び出しにより、そのdiv要素に設定されている属性の名前が配列として得られます。例えば<div id="myId" class="test-class">という要素であれば、['id', 'class']という配列が返されます。もし要素に属性が一つも設定されていなければ、空の配列が返されます。この機能は、HTMLコンテンツをプログラムで解析し、特定の要素がどのような属性を持っているかを動的に把握する際に非常に有用です。ウェブスクレイピングやコンテンツの自動処理など、HTMLの構造を詳細に調べたい場面で活用できます。