【PHP8.x】DOMEntityReference::parentElementプロパティの使い方

Copy
1<?php
2
3// DOMDocumentオブジェクトを作成
4$dom = new DOMDocument();
5
6// エンティティ参照を解決せずにDOMツリーに残す設定を行います。
7// これにより、XML内のエンティティ参照 (&myentity; など) が
8// DOMEntityReferenceオブジェクトとして扱われるようになります。
9$dom->substituteEntities = false;
10
11// XML文字列を定義します。
12// <!DOCTYPE>宣言内でカスタムエンティティ 'myentity' を定義し、
13// それを <message> 要素内で参照しています。
14$xmlString = '<?xml version="1.0" encoding="UTF-8"?>
15<!DOCTYPE root [
16  <!ENTITY myentity "Hello from custom entity!">
17]>
18<root>
19  <message>This is a test: &myentity;</message>
20</root>';
21
22// XML文字列をDOMDocumentにロードします。
23// substituteEntitiesがfalseに設定されているため、&myentity; がDOMEntityReferenceとしてパースされます。
24$dom->loadXML($xmlString);
25
26// DOMツリーを走査し、DOMEntityReferenceオブジェクトを見つけます。
27// このループは、DOMツリー内のすべての要素とその子ノードをチェックします。
28$entityReferenceNode = null;
29foreach ($dom->getElementsByTagName('*') as $element) {
30    foreach ($element->childNodes as $childNode) {
31        if ($childNode instanceof DOMEntityReference) {
32            $entityReferenceNode = $childNode;
33            break 2; // DOMEntityReferenceが見つかったら、外側のループも含めて抜けます
34        }
35    }
36}
37
38// DOMEntityReferenceが見つかった場合の処理
39if ($entityReferenceNode !== null) {
40    echo "DOMEntityReferenceノードが見つかりました。\n";
41    echo "  ノード名 (エンティティ名): " . $entityReferenceNode->nodeName . "\n";
42
43    // DOMEntityReference::parentElement プロパティを使用して、その親要素を取得します。
44    // このプロパティは、DOMElementオブジェクトまたは親要素がない場合は null を返します。
45    $parentElement = $entityReferenceNode->parentElement;
46
47    if ($parentElement !== null) {
48        echo "  親要素のノード名: " . $parentElement->nodeName . "\n";
49        echo "  親要素のテキストコンテンツ: " . $parentElement->textContent . "\n";
50        // 親要素のXMLを整形して出力します。
51        echo "  親要素のXML: " . $dom->saveXML($parentElement) . "\n";
52    } else {
53        echo "  DOMEntityReferenceの親要素が見つかりませんでした (parentElementはnullです)。\n";
54    }
55} else {
56    // この例では、設定によりDOMEntityReferenceが見つかることを想定していますが、
57    // 万一見つからなかった場合のメッセージです。
58    echo "DOMEntityReferenceノードが見つかりませんでした。\n";
59    echo "  (通常、XMLのエンティティ参照は自動的に解決されテキストノードに変換されます。\n";
60    echo "  このコードでは `substituteEntities = false` で解決を抑制しています。)\n";
61}
62

PHP 8のDOMEntityReference::parentElementプロパティは、XMLドキュメントのDOM（Document Object Model）ツリー内で、特定のエンティティ参照ノードの親要素を取得するために使用されます。このプロパティは引数を持ちません。

XMLドキュメントをPHPのDOM拡張機能で処理する際、通常エンティティ参照（例: &entity_name;）は自動的に解決され、その内容が直接テキストとして展開されます。しかし、$dom->substituteEntities = false;を設定することで、エンティティ参照自体をDOMEntityReferenceオブジェクトとしてDOMツリーに残すことができます。

このプロパティにアクセスすると、該当するDOMEntityReferenceオブジェクトが配置されている親のDOMElementオブジェクトが返されます。もし、親要素が存在しない場合や、DOMEntityReferenceがドキュメントのルート直下など要素の子ではない位置にある場合は、nullが返されます。

サンプルコードでは、substituteEntities = falseを設定した上で、カスタムエンティティ&myentity;を含むXMLをロードしています。これにより、<message>要素内の&myentity;がDOMEntityReferenceオブジェクトとしてDOMツリーに保持されます。その後、コードはこのDOMEntityReferenceノードを検索し、$entityReferenceNode->parentElementを使ってその親要素である<message>を取得し、その名前やテキストコンテンツを出力しています。

「php parentとは」という文脈では、DOMツリーにおける親ノードや親要素を指し、このプロパティはその情報を提供するものです。これにより、エンティティ参照がXMLのどの部分に挿入されているかを容易に特定できます。

Copy
1<?php
2
3/**
4 * DOMEntityReference::parentElement プロパティの使用例。
5 *
6 * この関数は、XMLドキュメント内で定義されたエンティティ参照の親要素を取得する方法を示します。
7 * DOMDocument::substituteEntities を false に設定することで、
8 * エンティティ参照が DOMEntityReference オブジェクトとして保持されます。
9 */
10function demonstrateDomEntityReferenceParent(): void
11{
12    // DOMDocumentのインスタンスを作成
13    $dom = new DOMDocument();
14
15    // エンティティ参照をDOMEntityReferenceオブジェクトとして保持する設定
16    $dom->substituteEntities = false;
17
18    // 内部DTDでカスタムエンティティ 'customEnt' を定義し、
19    // それを <message> 要素内で参照するXML文字列
20    $xmlString = <<<XML
21<!DOCTYPE root [
22  <!ENTITY customEnt "World">
23]>
24<root>
25  <message>Hello, &customEnt;!</message>
26</root>
27XML;
28
29    // XML文字列をロード
30    if (!$dom->loadXML($xmlString)) {
31        echo "XMLのロードに失敗しました。\n";
32        return;
33    }
34
35    $entityReference = null;
36    // <message> 要素の子ノードを走査し、DOMEntityReference ノードを探す
37    foreach ($dom->getElementsByTagName('message') as $messageElement) {
38        foreach ($messageElement->childNodes as $node) {
39            if ($node instanceof DOMEntityReference) {
40                $entityReference = $node;
41                break 2; // エンティティ参照が見つかったらループを抜ける
42            }
43        }
44    }
45
46    if ($entityReference) {
47        echo "DOMEntityReference ノードが見つかりました: '{$entityReference->nodeName}'\n";
48
49        // parentElement プロパティを使って親要素を取得
50        // 戻り値は DOMElement または null
51        $parentElement = $entityReference->parentElement;
52
53        if ($parentElement) {
54            echo "親要素の名前: '{$parentElement->nodeName}'\n";
55            echo "親要素のテキストコンテンツ: '{$parentElement->textContent}'\n";
56        } else {
57            echo "このDOMEntityReferenceには親要素がありません。\n";
58        }
59    } else {
60        echo "DOMEntityReference ノードが見つかりませんでした。\n";
61        echo "substituteEntities = false の設定とXML構造を確認してください。\n";
62    }
63}
64
65// 関数を実行
66demonstrateDomEntityReferenceParent();

PHP 8のDOMEntityReference::parentElementは、XMLドキュメント内で定義されたエンティティ参照（DOMEntityReferenceオブジェクト）の親要素を取得するためのプロパティです。このプロパティは引数を取らずに呼び出され、親要素が存在する場合はDOMElementオブジェクトを、存在しない場合はnullを返します。

PHPのDOM処理では、通常エンティティ参照が自動的に展開されてしまいますが、DOMDocument::substituteEntitiesプロパティをfalseに設定することで、エンティティ参照をDOMEntityReferenceオブジェクトとして扱えるようになります。サンプルコードではこの設定を行い、<message>要素内で参照されている&customEnt;がDOMEntityReferenceとして保持されるようにしています。

XMLをロードした後、コードは<message>要素の子ノードを走査してDOMEntityReferenceオブジェクトを見つけ出します。そのDOMEntityReferenceオブジェクトに対してparentElementプロパティを使用することで、エンティティ参照が記述されている親要素（この例では<message>要素）を正確に取得できます。取得した親要素からは、その名前やテキストコンテンツなどを確認することが可能です。このプロパティは、XML構造内で特定のエンティティ参照がどの要素に含まれているかをプログラム的に特定する際に役立ちます。