【PHP8.x】Dom\Attr::ownerElementプロパティの使い方

Copy
1<?php
2
3/**
4 * Dom\Attr::ownerElement プロパティの使用方法をデモンストレーションする関数です。
5 *
6 * このプロパティは、Dom\Attr (属性) ノードが現在属している Dom\Element (要素) オブジェクトを返します。
7 * 属性がどの要素にも属していない場合は null を返します。
8 *
9 * 注: ここでは PHP 8.2 以降で導入された新しい Dom 拡張のクラス (Dom\Document, Dom\Element, Dom\Attr など) を使用しています。
10 */
11function demonstrateAttrOwnerElement(): void
12{
13    // 1. Dom\Document (XML/HTMLドキュメント全体) を作成します。
14    //    これは、全ての要素や属性のコンテナとなるルートオブジェクトです。
15    $dom = new Dom\Document('1.0', 'UTF-8');
16    $dom->formatOutput = true; // 出力されるXMLを見やすく整形します。
17
18    // 2. ルート要素 'root' を作成し、ドキュメントに追加します。
19    //    全てのコンテンツはこのルート要素の下に配置されます。
20    $root = $dom->createElement('root');
21    $dom->appendChild($root);
22
23    // 3. 'item' という新しい要素を作成し、ルート要素に追加します。
24    $element = $dom->createElement('item');
25    $root->appendChild($element);
26
27    // 4. 'id' という名前の Dom\Attr (属性) を作成し、値を設定します。
28    $attr = $dom->createAttribute('id');
29    $attr->value = 'unique-item-id-123';
30
31    // 5. 作成した属性を 'item' 要素に追加します。
32    //    この時点で、$attr は $element に属するようになります。
33    $element->setAttributeNode($attr);
34
35    echo "--- 属性が要素に属している場合 ---" . PHP_EOL;
36
37    // 6. Dom\Attr::ownerElement プロパティにアクセスします。
38    //    $attr が属している要素 ($element) が返されるはずです。
39    $ownerElement = $attr->ownerElement;
40
41    if ($ownerElement instanceof Dom\Element) {
42        echo "属性名: " . $attr->name . PHP_EOL;
43        echo "属性値: " . $attr->value . PHP_EOL;
44        echo "この属性の所有要素 (ownerElement): '" . $ownerElement->nodeName . "'" . PHP_EOL;
45
46        // 7. ownerElement (要素) が属するドキュメントも確認できます。
47        //    これはキーワード 'ownerdocument' に関連する操作です。
48        $ownerDocument = $ownerElement->ownerDocument;
49        if ($ownerDocument instanceof Dom\Document) {
50            echo "所有要素が属するドキュメント (ownerDocument): '" . $ownerDocument->nodeName . "'" . PHP_EOL;
51        }
52    } else {
53        echo "属性 '" . $attr->name . "' はどの要素にも属していません。" . PHP_EOL;
54    }
55
56    echo PHP_EOL . "--- 属性がどの要素にも属していない場合 ---" . PHP_EOL;
57
58    // 8. どの要素にも追加されていない Dom\Attr ノードの例。
59    //    属性オブジェクトは作成できますが、要素に追加するまでは属していません。
60    $orphanAttr = $dom->createAttribute('data-status');
61    $orphanAttr->value = 'pending';
62
63    // 9. この属性の ownerElement を確認します。要素に属していないため、null が返されるはずです。
64    $orphanOwnerElement = $orphanAttr->ownerElement;
65
66    if ($orphanOwnerElement === null) {
67        echo "属性名: " . $orphanAttr->name . PHP_EOL;
68        echo "属性値: " . $orphanAttr->value . PHP_EOL;
69        echo "この属性の所有要素 (ownerElement): null (どの要素にも属していません)" . PHP_EOL;
70    }
71}
72
73// 関数を実行してサンプルコードの動作を確認します。
74demonstrateAttrOwnerElement();
75
76?>

PHP 8のDom\Attr::ownerElementプロパティは、XMLやHTMLのドキュメント内で特定の属性（Dom\Attrオブジェクト）がどの要素（Dom\Elementオブジェクト）に属しているかを調べるために使用されます。このプロパティは引数を取らず、戻り値としてDom\Elementオブジェクト、または属性がどの要素にも属していない場合はnullを返します。

サンプルコードでは、まず属性を要素に追加した場合の挙動をデモンストレーションしています。Dom\Document内に要素を作成し、その要素に属性ノードを追加すると、その属性のownerElementプロパティは、まさにその属性が追加された要素のDom\Elementオブジェクトを返します。これにより、属性からその親要素に関する情報（例えば要素名など）にアクセスできるようになります。さらに、その所有要素からownerDocumentプロパティを通じて、要素が属するドキュメント全体も参照できます。

次に、まだどの要素にも追加されていない「孤立した」属性ノードの例を示しています。この場合、属性は存在しますが、DOMツリーの構造内には組み込まれていないため、ownerElementプロパティにアクセスするとnullが返されます。このプロパティは、DOM構造を操作する際に、属性とその親要素との関連性を確認する上で非常に役立ちます。

Copy
1<?php
2
3/**
4 * Dom\Attr::ownerElement プロパティを使って、属性が要素に所属しているかを確認するサンプルコードです。
5 * ownerElementプロパティがnullでない場合、属性が要素に所属していると判断できます。
6 *
7 * @param string $html HTML文字列
8 * @param string $tagName 検索する要素のタグ名
9 * @param string $attrName 検索する属性の名前
10 */
11function checkAttributeOwnerElement(string $html, string $tagName, string $attrName): void
12{
13    $dom = new DOMDocument();
14    // HTMLパース時の警告を抑制
15    libxml_use_internal_errors(true);
16    $dom->loadHTML($html);
17    libxml_clear_errors();
18    libxml_use_internal_errors(false);
19
20    // 指定されたタグ名の最初の要素を取得
21    $element = $dom->getElementsByTagName($tagName)->item(0);
22
23    if ($element) {
24        // 要素から指定された属性ノードを取得
25        $attr = $element->getAttributeNode($attrName);
26
27        if ($attr) {
28            // Dom\Attr::ownerElement プロパティをチェック
29            // このプロパティは、属性が所属する要素（DOMElement）を返します。
30            // 属性がどの要素にも所属していない場合は null を返します。
31            if ($attr->ownerElement !== null) {
32                echo sprintf(
33                    "属性 '%s' は要素 '%s' に所属しています。所属要素のタグ名: %s\n",
34                    $attrName,
35                    $tagName,
36                    $attr->ownerElement->tagName
37                );
38            } else {
39                echo sprintf(
40                    "属性 '%s' は要素 '%s' に所属していません。\n",
41                    $attrName,
42                    $tagName
43                );
44            }
45        } else {
46            echo sprintf("要素 '%s' に属性 '%s' は見つかりませんでした。\n", $tagName, $attrName);
47        }
48    } else {
49        echo sprintf("タグ名 '%s' の要素が見つかりませんでした。\n", $tagName);
50    }
51
52    // どの要素にも所属していない（独立した）属性ノードの例
53    $independentAttrName = 'data-custom';
54    $independentAttr = $dom->createAttribute($independentAttrName);
55    $independentAttr->value = 'value-for-independent-attr';
56
57    // 独立した属性は ownerElement が null であることを確認
58    if ($independentAttr->ownerElement === null) {
59        echo sprintf("独立した属性 '%s' はどの要素にも所属していません。（期待される動作）\n", $independentAttrName);
60    } else {
61        echo sprintf("独立した属性 '%s' は要素に所属しています。（予期しない動作）\n", $independentAttrName);
62    }
63}
64
65// サンプルコードの実行例
66$htmlContent = <<<'HTML'
67<!DOCTYPE html>
68<html>
69<body>
70    <div id="main-container">
71        <p class="intro" my-data="example">Hello PHP DOM!</p>
72    </div>
73</body>
74</html>
75HTML;
76
77echo "--- 既存の要素に所属する属性の例 ---\n";
78checkAttributeOwnerElement($htmlContent, 'p', 'my-data');
79echo "\n";
80
81echo "--- 別の既存の要素に所属する属性の例 ---\n";
82checkAttributeOwnerElement($htmlContent, 'div', 'id');
83echo "\n";
84
85echo "--- 存在しない属性の例 ---\n";
86checkAttributeOwnerElement($htmlContent, 'p', 'non-existent-attr');
87echo "\n";
88
89echo "--- 存在しない要素の属性の例 ---\n";
90checkAttributeOwnerElement($htmlContent, 'span', 'class');
91echo "\n";

PHP 8のDom\Attr::ownerElementプロパティは、HTMLやXML文書内の属性（Dom\Attrオブジェクト）がどの要素に所属しているかを確認するために使用されます。このプロパティは引数を取らず、戻り値としてDOMElementオブジェクト、またはnullを返します。

もし属性が既存の要素に紐付けられている場合、ownerElementプロパティはその属性が所属するDOMElementオブジェクトを返します。これにより、属性がどの要素の一部であるかをプログラム的に判断できます。例えば、サンプルコードでは、HTML内の<p>要素のmy-data属性に対してこのプロパティを使用し、所属する<p>要素の情報を取得しています。

一方、属性がどの要素にも紐付けられていない、つまり「独立した」属性ノードである場合、ownerElementプロパティはnullを返します。これは、DOMDocument::createAttribute()メソッドなどで新しく作成されたものの、まだ文書内の要素に追加されていない属性などで発生します。サンプルコードの最後の部分では、独立して作成された属性がnullを返すことを確認しています。このプロパティは、属性が特定の要素の一部として機能しているかどうかを判断する際に役立ちます。