【PHP8.x】DOMEntity::previousSiblingプロパティの使い方

Copy
1<?php
2
3/**
4 * DOMEntity クラスの previousSibling プロパティの動作を示すサンプルコード。
5 *
6 * DOMEntity オブジェクトは、XMLのDTD（Document Type Definition）で定義されるエンティティを
7 * 表す特別なノードです。DOMツリーの通常の要素やテキストノードとは異なり、
8 * DOMEntityノードは通常、DOMツリー内で親ノードや兄弟ノードを持ちません。
9 * そのため、DOMEntity::previousSibling プロパティは、ほとんどの場合 null を返します。
10 *
11 * このコードでは、DTDでいくつかのエンティティを定義したXMLドキュメントを読み込み、
12 * 各DOMEntityオブジェクトの previousSibling プロパティの値を確認します。
13 * システムエンジニアを目指す初心者の方にも理解しやすいよう、コメントで補足しています。
14 */
15function demonstrateDomEntityPreviousSibling(): void
16{
17    // DTD内でエンティティが定義されたXMLドキュメントの文字列を用意します。
18    $xmlString = <<<XML
19<?xml version="1.0" encoding="UTF-8"?>
20<!DOCTYPE root [
21  <!ENTITY entityOne "最初のエンティティ">
22  <!ENTITY entityTwo "二番目のエンティティ">
23  <!ENTITY entityThree "三番目のエンティティ">
24]>
25<root>
26  <item>&entityOne;</item>
27</root>
28XML;
29
30    $dom = new DOMDocument();
31    // XML文字列をDOMDocumentオブジェクトにロードします。
32    $dom->loadXML($xmlString);
33
34    // ドキュメントタイプ (DOCTYPE) オブジェクトを取得します。
35    $doctype = $dom->doctype;
36
37    // ドキュメントタイプが存在し、かつエンティティが定義されているかを確認します。
38    if ($doctype && $doctype->entities) {
39        echo "XMLのDOCTYPE内にエンティティが定義されています。\n\n";
40
41        // DOMDocumentType::entities は DOMNamedNodeMap を返し、
42        // そこから各 DOMEntity オブジェクトを取得できます。
43        foreach ($doctype->entities as $entity) {
44            // 取得したオブジェクトが DOMEntity のインスタンスであることを確認します。
45            if ($entity instanceof DOMEntity) {
46                echo "----------------------------------------\n";
47                echo "エンティティ名: " . $entity->nodeName . "\n";
48                echo "ノードタイプ: " . $entity->nodeType . " (DOM_ENTITY_NODE)\n";
49
50                // DOMEntity の previousSibling プロパティにアクセスします。
51                // DOMEntityノードはDOMツリーの通常の階層構造には含まれないため、
52                // 通常は兄弟ノードを持たず、結果は null になります。
53                $previousSibling = $entity->previousSibling;
54
55                if ($previousSibling === null) {
56                    echo "previousSibling: null\n";
57                    echo "  (DOMEntityノードはDOMツリー内で兄弟ノードを持たないため、nullが返されます。)\n";
58                } else {
59                    // もし previousSibling が存在した場合の情報を表示します (このケースは稀です)。
60                    echo "previousSibling のノード名: " . $previousSibling->nodeName . "\n";
61                    echo "previousSibling のノードタイプ: " . $previousSibling->nodeType . "\n";
62                }
63                echo "\n";
64            }
65        }
66    } else {
67        echo "XMLドキュメントにDOCTYPEまたはエンティティが定義されていません。\n";
68    }
69}
70
71// 上記のサンプルコードを実行します。
72demonstrateDomEntityPreviousSibling();

PHPのDOMEntity::previousSiblingプロパティは、XMLのDTD（Document Type Definition）で定義されるエンティティを表すDOMEntityオブジェクトにアクセスする際に使用します。このプロパティは、DOMツリー内で「前の兄弟ノード」を取得する役割を持っていますが、DOMEntityノードは通常のDOM要素やテキストノードとは異なる性質を持つため、その挙動には注意が必要です。

具体的には、DOMEntityノードはXMLドキュメントのDTD内で定義されるメタ情報のような存在であり、一般的なDOMツリーの階層構造に直接組み込まれることは稀です。そのため、DOMEntityオブジェクトは通常、親ノードや兄弟ノードを持っていません。この特性から、DOMEntity::previousSiblingプロパティにアクセスしても、ほとんどの場合、前の兄弟ノードが存在しないことを示すnullが戻り値として返されます。

サンプルコードでは、DTD内に複数のエンティティを定義したXMLドキュメントを読み込み、各DOMEntityオブジェクトについてpreviousSiblingプロパティの値を確認しています。実行結果からもわかるように、それぞれのエンティティに対するpreviousSiblingはnullとなります。このプロパティは引数をとりません。戻り値はDOMNodeオブジェクトか、兄弟ノードが存在しない場合はnullとなりますが、DOMEntityの場合には後者のnullが返されることが一般的です。

Copy
1<?php
2
3// XML ドキュメントを作成します。DOCTYPE にエンティティを一つだけ定義します。
4// DOMEntity は XML の DOCTYPE 宣言内で定義される特殊なノードです。
5$xmlString = <<<XML
6<?xml version="1.0"?>
7<!DOCTYPE root [
8  <!ENTITY example "This is an example entity.">
9]>
10<root/>
11XML;
12
13$dom = new DOMDocument();
14// XML 文字列をロードします。DOMDocument::loadXML は成功時に true を返します。
15if (!$dom->loadXML($xmlString)) {
16    echo "Failed to load XML.\n";
17    exit(1);
18}
19
20// ドキュメントの DOMDocumentType オブジェクトを取得します。
21// DOMDocumentType は XML の DOCTYPE 宣言全体を表します。
22$doctype = $dom->doctype;
23
24if ($doctype instanceof DOMDocumentType) {
25    echo "DOCTYPE found.\n";
26    
27    // DOCTYPE 内で定義されているエンティティのマップ (DOMNamedNodeMap) を取得します。
28    // このマップには、各エンティティの名前をキーとして DOMEntity オブジェクトが格納されています。
29    $entities = $doctype->entities;
30
31    // 'example' という名前の DOMEntity オブジェクトを取得します。
32    $entity = $entities->getNamedItem('example');
33
34    if ($entity instanceof DOMEntity) {
35        echo "Found DOMEntity with name: " . $entity->nodeName . "\n";
36        echo "Entity value: " . $entity->nodeValue . "\n";
37
38        // DOMEntity の previousSibling プロパティにアクセスします。
39        // previousSibling は、現在のノードの直前の兄弟ノードを返します。
40        // エンティティは DOCTYPE 宣言内で順序を持つ可能性がありますが、
41        // この例のように単一のエンティティしかない場合、通常は null を返します。
42        $previousSibling = $entity->previousSibling;
43
44        if ($previousSibling instanceof DOMNode) {
45            // previousSibling が DOMNode のインスタンスである場合、直前の兄弟ノードが存在します。
46            echo "Previous sibling found:\n";
47            echo "  Node name: " . $previousSibling->nodeName . "\n";
48            // PHP 8 で追加された nodeTypeToString メソッドでノードタイプを分かりやすく表示します。
49            echo "  Node type: " . DOMNode::nodeTypeToString($previousSibling->nodeType) . "\n";
50            echo "  Node value: " . $previousSibling->nodeValue . "\n";
51        } else {
52            // previousSibling が null の場合、直前の兄弟ノードは存在しません。
53            echo "No previous sibling found for this DOMEntity (returns null).\n";
54        }
55    } else {
56        echo "DOMEntity 'example' not found in DOCTYPE.\n";
57    }
58} else {
59    echo "No DOCTYPE found in the document.\n";
60}
61
62?>

PHPのDOM拡張機能を利用したこのコードは、XMLドキュメント内のエンティティとその兄弟ノードの取得方法を示しています。まず、DOCTYPE宣言内にexampleというエンティティが定義されたXML文字列を作成し、DOMDocumentにロードします。DOMEntityはXMLのDOCTYPE宣言内で定義される特殊なノードであり、この例ではexampleというエンティティが定義されています。

次に、ロードしたXMLドキュメントからDOCTYPEオブジェクトを取得し、その中に定義されているエンティティのマップからgetNamedItem('example')メソッドを使って特定のDOMEntityオブジェクト（$entity）を取得します。

$entity->previousSiblingプロパティは、現在のDOMEntityノードの直前にある兄弟ノードを取得するために使用されます。このプロパティは引数を取りません。戻り値は、直前の兄弟ノードが存在すればDOMNodeオブジェクトを返しますが、存在しない場合はnullを返します。

このサンプルコードでは、DOCTYPE内にexampleエンティティが一つしか定義されていないため、$entityの直前に位置する兄弟ノードは存在しません。したがって、$previousSiblingにはnullが格納され、「このDOMEntityの直前の兄弟ノードは見つかりません（nullを返します）。」というメッセージが出力されます。previousSiblingプロパティは、XMLドキュメントのノード構造を走査する際に、現在のノードの直前にある要素やテキストなどのノードにアクセスするために利用できます。