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

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * Dom\EntityのparentNodeプロパティを使用して親ノードを取得するサンプルコード
7 *
8 * この関数は、DTD(文書型定義)内に宣言されたエンティティを取得し、
9 * その親ノードが文書型定義自身であることを示します。
10 */
11function getEntityParentNodeExample(): void
12{
13    // DTD (文書型定義) を含むXML文字列を定義します。
14    // <!ENTITY> タグで 'author_name' という名前のエンティティを宣言しています。
15    $xmlString = <<<XML
16<?xml version="1.0" encoding="UTF-8"?>
17<!DOCTYPE book [
18    <!ENTITY author_name "Taro Yamada">
19]>
20<book>
21    <title>PHP Manual</title>
22    <author>&author_name;</author>
23</book>
24XML;
25
26    // DOMDocumentオブジェクトを生成し、XML文字列を読み込みます。
27    $dom = new \DOMDocument();
28    // エラーを抑制し、内部で処理します。
29    @$dom->loadXML($xmlString);
30
31    // 文書型定義 (<!DOCTYPE ...> の部分) を表す DOMDocumentType オブジェクトを取得します。
32    $docType = $dom->doctype;
33
34    // 文書型定義が存在する場合のみ処理を続行します。
35    if ($docType instanceof \DOMDocumentType) {
36        // 文書型定義内のエンティティのリストから 'author_name' という名前のエンティティを取得します。
37        // このノードの型は Dom\Entity です。
38        $entityNode = $docType->entities->getNamedItem('author_name');
39
40        if ($entityNode instanceof \DOMEntity) {
41            // Dom\Entity オブジェクトの parentNode プロパティにアクセスして親ノードを取得します。
42            $parentNode = $entityNode->parentNode;
43
44            // 親ノードが取得できたか確認します。
45            if ($parentNode instanceof \DOMNode) {
46                // エンティティとその親ノードの情報を出力します。
47                // Dom\Entity の親ノードは、通常、それを含む DOMDocumentType ノードになります。
48                echo "エンティティ名: " . $entityNode->nodeName . "\n";
49                echo "親ノードのクラス名: " . get_class($parentNode) . "\n";
50                echo "親ノードのノード名: " . $parentNode->nodeName . "\n";
51            } else {
52                echo "エンティティ '{$entityNode->nodeName}' の親ノードが見つかりませんでした。\n";
53            }
54        } else {
55            echo "エンティティ 'author_name' が見つかりませんでした。\n";
56        }
57    } else {
58        echo "文書型定義 (DOCTYPE) が見つかりませんでした。\n";
59    }
60}
61
62// 関数を実行して結果を表示します。
63getEntityParentNodeExample();
64

このサンプルコードは、PHPのDOM拡張機能において、XML文書内のエンティティ(Dom\Entity)の親ノードを取得する方法を示しています。ここではparentNodeプロパティを使用します。

parentNodeプロパティは、現在のノードがどのノードに属しているか、つまり親ノードを取得するためのものです。このプロパティは引数を取らず、戻り値として親ノードを表すDom\Nodeオブジェクトを返します。もし親ノードが存在しない場合にはnullが返されます。

コードの中では、まずDTD（文書型定義）内でauthor_nameというエンティティを宣言したXML文字列を準備します。次に、このXML文字列をDOMDocumentオブジェクトとして読み込み、DOMツリーという階層構造のデータに変換します。そして、文書型定義ノード(DOMDocumentType)の中からauthor_nameエンティティノード(DOMEntity)を取得し、そのparentNodeプロパティにアクセスします。エンティティは文書型定義の中で宣言されているため、parentNodeは文書型定義ノード自身を指します。

最終的に、エンティティ名と、取得した親ノードのクラス名やノード名を出力することで、親子関係を正しく取得できていることを確認しています。