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

Copy
1<?php
2
3/**
4 * Dom\NamedNodeMap::getNamedItem メソッドの使用例を示します。
5 * このメソッドは、要素の属性セットから指定された名前の属性 (Dom\Attr オブジェクト) を取得します。
6 *
7 * @return void
8 */
9function demonstrateDomGetNamedItem(): void
10{
11    // 1. サンプルとなるHTMLコンテンツを準備します。
12    // ここでは、いくつかの属性を持つdiv要素を作成します。
13    $htmlContent = '<div id="header" class="main-header" data-status="active">
14                        <h1>ウェルカムページ</h1>
15                    </div>';
16
17    // 2. DOMDocument オブジェクトを作成し、HTMLを読み込みます。
18    // loadHTML() はHTMLのパースエラーで警告を生成することがあるため、
19    // 初心者向けにはエラー抑制演算子 @ を使用していますが、
20    // 本番コードでは適切なエラーハンドリングを推奨します。
21    $dom = new DOMDocument();
22    @$dom->loadHTML($htmlContent);
23
24    // 3. 属性を取得したい特定の要素を取得します。
25    // ここでは、id="header" を持つdiv要素を取得します。
26    $element = $dom->getElementById('header');
27
28    if ($element === null) {
29        echo "エラー: ID 'header' を持つ要素が見つかりませんでした。\n";
30        return;
31    }
32
33    // 4. 取得した要素からその属性のマップ (Dom\NamedNodeMap) を取得します。
34    // $element->attributes は Dom\NamedNodeMap のインスタンスを返します。
35    $attributesMap = $element->attributes;
36
37    echo "Dom\\NamedNodeMap::getNamedItem の使用例:\n";
38    echo "------------------------------------------\n";
39
40    // 5. 'id' という名前の属性を Dom\NamedNodeMap から取得します。
41    // getNamedItem は Dom\Attr オブジェクト、または属性が見つからない場合は null を返します。
42    $idAttribute = $attributesMap->getNamedItem('id');
43
44    if ($idAttribute !== null) {
45        echo "属性 'id' が見つかりました。\n";
46        // Dom\Attr オブジェクトの 'name' プロパティで属性名を取得できます。
47        // これはキーワード 'getname() php' に関連します。
48        echo "  属性名: " . $idAttribute->name . "\n";
49        echo "  属性値: " . $idAttribute->value . "\n";
50    } else {
51        echo "属性 'id' は見つかりませんでした。\n";
52    }
53
54    echo "\n";
55
56    // 6. 別の属性 'class' を取得してみます。
57    $classAttribute = $attributesMap->getNamedItem('class');
58
59    if ($classAttribute !== null) {
60        echo "属性 'class' が見つかりました。\n";
61        echo "  属性名: " . $classAttribute->name . "\n";
62        echo "  属性値: " . $classAttribute->value . "\n";
63    } else {
64        echo "属性 'class' は見つかりませんでした。\n";
65    }
66
67    echo "\n";
68
69    // 7. 存在しない属性 'style' を取得しようとします。
70    $nonExistentAttribute = $attributesMap->getNamedItem('style');
71
72    if ($nonExistentAttribute !== null) {
73        echo "属性 'style' が見つかりました。\n";
74        echo "  属性名: " . $nonExistentAttribute->name . "\n";
75        echo "  属性値: " . $nonExistentAttribute->value . "\n";
76    } else {
77        echo "属性 'style' は見つかりませんでした (null が返されました)。\n";
78    }
79}
80
81// 定義した関数を実行してデモンストレーションを行います。
82demonstrateDomGetNamedItem();

PHPのDom\NamedNodeMap::getNamedItemメソッドは、HTMLやXMLドキュメント内の要素が持つ属性（アトリビュート）を名前で取得するために使用されるメソッドです。このメソッドは、要素の全ての属性を管理するDom\NamedNodeMapオブジェクトから呼び出されます。

引数にはstring $qualifiedNameとして、取得したい属性の名前を文字列で指定します。例えば、HTML要素が<div id="header" class="main">という形であれば、'id'や'class'といった属性名を指定します。

戻り値は?Dom\Attr型です。これは、指定された名前の属性がDom\NamedNodeMap内に存在すれば、その属性を表すDom\Attrオブジェクトが返されることを意味します。もし該当する属性が見つからなかった場合は、nullが返されます。戻り値がnullになる可能性があるため、コードで利用する際にはnullチェックを行うことが重要です。

サンプルコードでは、まずHTMLコンテンツをDOMDocumentに読み込み、特定の要素（例：id="header"を持つdiv要素）を取得しています。その要素が持つ属性の集合（attributesプロパティから得られるDom\NamedNodeMapオブジェクト）に対してgetNamedItemメソッドを使用し、'id'や'class'といった特定の属性名を指定して属性オブジェクトを取得しています。取得したDom\Attrオブジェクトからは、その属性の名前をnameプロパティで、属性の値をvalueプロパティで参照できます。このように、ドキュメント内の特定の属性情報を効率的に取得し、操作する際に利用されます。

Copy
1<?php
2
3/**
4 * Dom\NamedNodeMap::getNamedItem() メソッドの使用方法を示すサンプルコードです。
5 * このメソッドは、要素の属性リストから指定された名前の属性 (Dom\Attr オブジェクト) を取得します。
6 */
7function demonstrateDomGetNamedItem(): void
8{
9    // 1. 新しい Dom\Document オブジェクトを作成します。
10    //    これはXMLドキュメント全体を表すための基盤となります。
11    $dom = new Dom\Document();
12
13    // 2. サンプルとなるXML文字列をロードします。
14    //    ここでは、属性を持つ'book'要素を含む簡単なXMLを使用します。
15    $xmlString = <<<XML
16<library>
17    <book id="BK101" category="programming" available="yes">
18        <title>Learning PHP DOM</title>
19        <author>Jane Doe</author>
20    </book>
21</library>
22XML;
23    $dom->loadXML($xmlString);
24
25    // 3. ドキュメントから特定の要素を取得します。
26    //    ここでは、最初の'book'要素を取得します。
27    $bookElement = $dom->getElementsByTagName('book')->item(0);
28
29    // 取得した要素が Dom\Element のインスタンスであることを確認します。
30    if ($bookElement instanceof Dom\Element) {
31        echo "--- 'book' 要素の属性を検索しています ---\n";
32
33        // 4. 要素から属性リスト (Dom\NamedNodeMap) を取得します。
34        //    $bookElement->attributes プロパティは Dom\NamedNodeMap オブジェクトを返します。
35        $attributes = $bookElement->attributes;
36
37        // 属性リストが実際に存在することを確認します。
38        if ($attributes instanceof Dom\NamedNodeMap) {
39
40            // 5. getNamedItem() メソッドを使用して、'id' という名前の属性を取得します。
41            $idAttribute = $attributes->getNamedItem('id');
42
43            // 取得した属性が Dom\Attr のインスタンスであることを確認し、その値を表示します。
44            if ($idAttribute instanceof Dom\Attr) {
45                echo "属性 'id' が見つかりました。値: " . $idAttribute->value . "\n";
46            } else {
47                echo "属性 'id' が見つかりませんでした。\n";
48            }
49
50            // 6. 別の属性、例えば 'category' を取得してみましょう。
51            $categoryAttribute = $attributes->getNamedItem('category');
52            if ($categoryAttribute instanceof Dom\Attr) {
53                echo "属性 'category' が見つかりました。値: " . $categoryAttribute->value . "\n";
54            } else {
55                echo "属性 'category' が見つかりませんでした。\n";
56            }
57
58            // 7. 存在しない属性を検索した場合の挙動を確認します。
59            //    この場合、getNamedItem() は null を返します。
60            $nonExistentAttribute = $attributes->getNamedItem('publisher');
61            if ($nonExistentAttribute instanceof Dom\Attr) {
62                echo "属性 'publisher' が見つかりました。値: " . $nonExistentAttribute->value . "\n";
63            } else {
64                echo "属性 'publisher' は見つかりませんでした (期待通り)。\n";
65            }
66
67        } else {
68            echo "'book' 要素には属性がありませんでした。\n";
69        }
70    } else {
71        echo "指定された 'book' 要素が見つかりませんでした。\n";
72    }
73}
74
75// 関数を実行して、Dom\NamedNodeMap::getNamedItem() の動作を確認します。
76demonstrateDomGetNamedItem();

PHPのDom\NamedNodeMap::getNamedItem()メソッドは、XMLやHTMLドキュメント内の要素が持つ属性の中から、特定の名前の属性を取得する際に用いられます。このメソッドは、要素の属性リストを表すDom\NamedNodeMapクラスのインスタンスに対して呼び出されます。

サンプルコードでは、まずDom\DocumentオブジェクトにXML文字列をロードし、book要素を取得しています。次に、取得したbook要素のattributesプロパティからDom\NamedNodeMap（属性の集合）を取得します。

getNamedItem()メソッドは、引数として検索したい属性の名前を文字列$qualifiedNameで受け取ります。例えば、$attributes->getNamedItem('id')とすることで、idという名前の属性が取得されます。属性が見つかった場合、その属性はDom\Attrオブジェクトとして返され、$idAttribute->valueのようにして属性の値にアクセスできます。サンプルではid属性とcategory属性の値を表示しています。

一方、もし指定された名前の属性が要素に存在しない場合、このメソッドはnullを返します。サンプルコードでは、存在しないpublisher属性を検索してnullが返される様子も示されており、戻り値がDom\Attr型かnullであるかを確認することで、属性の有無を安全に判定し、その後の処理を分岐させることが可能です。これにより、システムエンジニアとして堅牢なコードを書く上で重要なnullチェックの概念も理解できます。