いっしー@Webエンジニア
Webツールプログラミング言語プログラミング学習ITニュースIT用語辞典ポートフォリオ
Webエンジニア向けプログラミング解説動画をYouTubeで配信中！
▶ チャンネル登録はこちら

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

previousSiblingプロパティの使い方について、初心者にもわかりやすく解説します。

作成日: 更新日:

基本的な使い方

previousSiblingプロパティは、PHPのDOM拡張機能において、Dom\Entityオブジェクトが自身の直前に位置する兄弟ノードを保持するプロパティです。DOM（Document Object Model）とは、HTMLやXMLのようなドキュメントの構造を木のような形式（ツリー構造）で表現し、プログラムからアクセス・操作できるようにするモデルを指します。

Dom\Entityクラスは、XMLドキュメント内で定義される実体（エンティティ）ノードを表します。このプロパティを利用することで、あるDom\Entityノードの親ノードが持つ子ノードのリストにおいて、当該Dom\Entityノードのすぐ前に存在するノードにアクセスすることが可能になります。例えば、複数の要素が並んでいる場合、このプロパティを使って直前の要素やテキストノードなどを取得できます。

もし、現在のDom\Entityノードが親ノードの最初の子ノードであり、直前に兄弟ノードが存在しない場合は、このプロパティはnullを返します。それ以外の場合は、直前の兄弟ノードを表すDom\Node型のオブジェクトが返されます。

このプロパティは、XMLドキュメントのツリー構造を後ろ向きに（あるいは双方向に）たどり、特定ノードの前後関係を調査したり、隣接するノードの情報を取得して処理を行ったりする際に非常に有用です。初心者の方でも、ドキュメントの構造を理解し、その中から特定の情報を効率的に取得するための基本的な手段として活用できます。

構文(syntax)

1<?php
2
3// XML ドキュメントを定義し、DTD内でエンティティを宣言します。
4$xml = <<<XML
5<!DOCTYPE root [
6  <!ENTITY first "最初のエンティティ">
7  <!ENTITY second "二番目のエンティティ">
8]>
9<root>
10  <child/>
11</root>
12XML;
13
14$dom = new DOMDocument();
15$dom->loadXML($xml);
16
17// ドキュメントタイプ (DOCTYPE) を取得します。
18$doctype = $dom->doctype;
19
20if ($doctype && $doctype->entities) {
21    // Dom\NamedNodeMap から "second" という名前のエンティティを取得します。
22    // Dom\NamedNodeMap は順序を保証しないため、previousSiblingは通常nullを返します。
23    $entity = $doctype->entities->getNamedItem('second');
24
25    if ($entity instanceof DOM\Entity) {
26        // Dom\Entity クラスの previousSibling プロパティにアクセスします。
27        // これは、現在のエンティティの直前の兄弟ノード (Dom\Nodeオブジェクト) を返します。
28        // 直前の兄弟ノードが存在しない場合は null を返します。
29        $previousSibling = $entity->previousSibling;
30
31        if ($previousSibling) {
32            echo "エンティティ ('second') の直前の兄弟ノードの名前: " . $previousSibling->nodeName . "\n";
33        } else {
34            echo "エンティティ ('second') には直前の兄弟ノードが存在しません。\n";
35        }
36    } else {
37        echo "指定されたエンティティが見つからないか、Dom\\Entity型ではありません。\n";
38    }
39} else {
40    echo "DOCTYPEまたはエンティティが定義されていません。\n";
41}
42
43?>

引数(parameters)

引数なし

引数はありません

戻り値(return)

?Dom\Node

現在のノードの直前の兄弟ノードを返します。兄弟ノードが存在しない場合は null を返します。

サンプルコード

PHP Dom previousSibling で前の要素を取得する

1<?php
2
3/**
4 * Demonstrates the use of the `previousSibling` property to find the preceding node.
5 *
6 * This function creates a simple HTML document, selects a target element,
7 * and then retrieves its immediate previous sibling node.
8 *
9 * The `previousSibling` property is available on any class that inherits from `Dom\Node`,
10 * including `Dom\Element`, `Dom\Text`, `Dom\Comment`, and also `Dom\Entity`.
11 * For `Dom\Entity` objects (which represent DTD entity definitions), this property
12 * will typically be null, as entities are not part of the main document tree's
13 * structural hierarchy in the same way elements are.
14 *
15 * This example focuses on demonstrating the general behavior of `previousSibling`
16 * using `Dom\Element` nodes for clearer illustration for beginners.
17 */
18function demonstratePreviousSibling(): void
19{
20    // 1. Create a new DOM Document object.
21    $document = new Dom\Document();
22
23    // Set options to ignore whitespace text nodes between elements,
24    // which simplifies finding element siblings for beginners.
25    $document->preserveWhiteSpace = false;
26    $document->formatOutput = true; // For pretty printing (not critical for logic)
27
28    // 2. Load simple HTML content into the document.
29    //    We create multiple <item> elements as siblings within a <div>.
30    $htmlContent = <<<HTML
31    <div>
32        <item id="item1">First Item</item>
33        <item id="item2">Second Item</item>
34        <item id="item3">Third Item</item>
35        <item id="item4">Fourth Item</item>
36    </div>
37    HTML;
38    $document->loadHTML($htmlContent);
39
40    // 3. Get the parent <div> element, which contains our <item> siblings.
41    $parentDiv = $document->getElementsByTagName('div')->item(0);
42
43    if (!$parentDiv) {
44        echo "Error: Parent <div> element not found.\n";
45        return;
46    }
47
48    // 4. Select a target node. Let's pick "<item id="item3">Third Item</item>".
49    //    The `getElementsByTagName` method returns a `Dom\HTMLCollection` (or `Dom\NodeList`).
50    //    It is 0-indexed, so the third <item> is at index 2.
51    $targetNode = $parentDiv->getElementsByTagName('item')->item(2); // This is <item id="item3">
52
53    if ($targetNode instanceof Dom\Element) {
54        echo "Target Node: <{$targetNode->tagName} id=\"{$targetNode->getAttribute('id')}\"> ('{$targetNode->textContent}')\n";
55
56        // 5. Access the `previousSibling` property of the target node.
57        //    This property returns the node immediately preceding the target node
58        //    in the list of children of their common parent.
59        $previousSibling = $targetNode->previousSibling;
60
61        if ($previousSibling instanceof Dom\Element) {
62            // If the previous sibling is an element, we can access its properties like tag name and attributes.
63            echo "Previous Sibling Found:\n";
64            echo "  Node Name: <{$previousSibling->tagName}>\n";
65            echo "  Node Value (textContent): '{$previousSibling->textContent}'\n";
66            echo "  ID: '{$previousSibling->getAttribute('id')}'\n";
67        } elseif ($previousSibling instanceof Dom\Node) {
68            // Handle other types of nodes like text nodes or comment nodes if they existed.
69            echo "Previous Sibling Found (non-element node):\n";
70            echo "  Node Name: '{$previousSibling->nodeName}'\n";
71            echo "  Node Type: " . $previousSibling->nodeType . " (e.g., " . DOM_TEXT_NODE . " for text, " . DOM_COMMENT_NODE . " for comment)\n";
72            echo "  Node Value: '{$previousSibling->nodeValue}'\n";
73        } else {
74            // If `previousSibling` is null, it means there is no preceding sibling node.
75            echo "Target Node has no previous sibling.\n";
76        }
77
78        echo "\n--- Example: Checking the very first item (which has no previous sibling) ---\n";
79        // Let's get the first <item> node: "<item id="item1">First Item</item>"
80        $firstItem = $parentDiv->getElementsByTagName('item')->item(0);
81
82        if ($firstItem instanceof Dom\Element) {
83            echo "First Item Node: <{$firstItem->tagName} id=\"{$firstItem->getAttribute('id')}\">\n";
84            $prevOfFirst = $firstItem->previousSibling;
85            if ($prevOfFirst !== null) {
86                echo "Previous Sibling of first item: '{$prevOfFirst->nodeName}'\n";
87            } else {
88                // This is the expected outcome for the first child.
89                echo "First Item Node correctly has no previous sibling (returns null).\n";
90            }
91        }
92    } else {
93        echo "Error: Target node 'item3' not found or is not an element.\n";
94    }
95}
96
97// Execute the demonstration function
98demonstratePreviousSibling();

PHPのDom\Entityクラスに属するpreviousSiblingプロパティは、DOMツリー内において、現在のノードの直前にある兄弟ノードを取得するために使用されます。このプロパティは引数を取らず、戻り値として?Dom\Node型を返します。これは、直前の兄弟ノードが存在すればそのノードをDom\Nodeオブジェクトとして返し、存在しない場合にはnullを返すことを意味します。

previousSiblingはDom\Entityクラスの一部ですが、実際にはDom\Nodeを継承するDom\ElementやDom\Textなど、様々なノードタイプで共通して利用できる非常に便利なプロパティです。

提供されたサンプルコードでは、Dom\Elementを使用してpreviousSiblingプロパティの具体的な動作を示しています。まず簡単なHTML構造を持つDOMドキュメントを作成し、複数の<item>要素を兄弟関係として配置します。次に、<item id="item3">という特定の要素を対象として選択し、そのpreviousSiblingプロパティにアクセスしています。これにより、対象要素の直前にある兄弟ノードである<item id="item2">要素が取得され、そのタグ名やテキストコンテンツなどの情報が表示されます。また、親要素内で最初の位置にあるノード（例: <item id="item1">）には直前の兄弟ノードが存在しないため、previousSiblingがnullを返すケースも示されており、プロパティの挙動が明確に理解できます。

なお、Dom\EntityオブジェクトはDTD（文書型定義）のエンティティ定義を表すものであり、一般的なHTML要素のようなDOMツリー内の兄弟関係を持たないことが多いため、このプロパティは通常nullを返す傾向があります。そのため、サンプルコードでは初心者の方にも分かりやすく、より一般的な要素ノードの例を用いて解説しています。

previousSiblingは、現在のノードの直前にある兄弟ノードを取得するプロパティです。戻り値はDom\Nodeオブジェクト、または存在しない場合はnullとなります。そのため、取得した結果がnullでないかを常に確認し、さらにDom\Elementなどの特定のノード型であるかを確認してから操作を行うようにしてください。特に、親要素の最初の子ノードには前の兄弟ノードが存在しないため、このプロパティはnullを返します。

サンプルコードは主にDom\Elementでの利用を示していますが、Dom\Nodeを継承する様々なオブジェクトで利用可能です。ただし、Dom\Entityオブジェクトでは、通常、このプロパティはnullを返しますのでご注意ください。

また、Dom\DocumentにHTMLを読み込む際、$document->preserveWhiteSpace = falseを設定しない場合、HTMLソース内の改行やスペースがテキストノードとして認識され、意図しないテキストノードが兄弟として返される可能性があります。要素ノードのみを対象としたい場合は、この設定を有効にすることをお勧めします。

Dom\EntityのpreviousSiblingを調べる

1<?php
2
3/**
4 * Dom\Entity::previousSibling プロパティの使用例を示します。
5 *
6 * Dom\Entity はXMLのDTD (Document Type Definition) 内で定義されるエンティティを表すノードです。
7 * これらのノードは、通常DOMツリーの本体ではなく、DTDの定義の一部として存在します。
8 * そのため、previousSibling プロパティはほとんどの場合 null を返します。
9 * この関数は、その振る舞いを具体的に示します。
10 */
11function demonstrateDomEntityPreviousSibling(): void
12{
13    // DTD (Document Type Definition) を含むXML文字列を定義します。
14    // ここでは '<!ENTITY myentity ... >' という形で 'myentity' を定義しています。
15    $xmlString = <<<'XML'
16<!DOCTYPE root [
17  <!ENTITY myentity "これはカスタムエンティティの値です。">
18  <!ENTITY anotherEntity "別のカスタムエンティティ。">
19]>
20<root>
21  <!-- ルート要素はエンティティの定義とは直接関連しません -->
22</root>
23XML;
24
25    // DOMDocument オブジェクトを作成し、XMLを読み込みます。
26    $dom = new DOMDocument();
27    $dom->loadXML($xmlString);
28
29    // ドキュメントタイプ (DTD) ノードを取得します。
30    // Dom\Entity ノードは、通常この DTD 内に定義されています。
31    $doctype = $dom->doctype;
32
33    // DTD が存在しない場合はエラーメッセージを表示して終了します。
34    if ($doctype === null) {
35        echo "エラー: DTD が見つかりませんでした。Dom\Entity は DTD 内に定義されます。\n";
36        return;
37    }
38
39    // DTD 内に定義されているエンティティのコレクション (Dom\NamedNodeMap) を取得します。
40    $entities = $doctype->entities;
41
42    // エンティティが見つからない場合はメッセージを表示して終了します。
43    if ($entities === null || $entities->count() === 0) {
44        echo "DTD内にエンティティが見つかりませんでした。\n";
45        return;
46    }
47
48    // 定義した 'myentity' という名前の Dom\Entity ノードを取得します。
49    // このオブジェクトは、DTD のエンティティ定義そのものを表します。
50    $myEntity = $entities->getNamedItem('myentity');
51
52    // Dom\Entity オブジェクトが取得できたか確認します。
53    if ($myEntity instanceof Dom\Entity) {
54        echo "Dom\\Entity '{$myEntity->nodeName}' が見つかりました。\n";
55        echo "ノードタイプ: {$myEntity->nodeType} (XML_ENTITY_NODE)\n";
56
57        // previousSibling プロパティにアクセスします。
58        // Dom\Entity ノードは DTD の定義内に存在し、DOMツリーの通常のノードとは異なる文脈にあります。
59        // そのため、このプロパティは通常 null を返します。
60        $previousSibling = $myEntity->previousSibling;
61
62        // previousSibling が存在するかどうかを確認し、結果を出力します。
63        if ($previousSibling instanceof Dom\Node) {
64            echo "previousSibling が見つかりました: {$previousSibling->nodeName} (タイプ: {$previousSibling->nodeType})\n";
65        } else {
66            echo "Dom\\Entity '{$myEntity->nodeName}' の previousSibling は見つかりませんでした (null)。\n";
67            echo "これは予想される動作です。Dom\\Entity ノードは通常 DTD の定義の一部であり、\n";
68            echo "DOMツリー内で他のノードと直接的な兄弟関係を持つことが稀なためです。\n";
69        }
70    } else {
71        echo "指定された Dom\\Entity 'myentity' が見つかりませんでした。\n";
72    }
73}
74
75// 関数を実行します。
76demonstrateDomEntityPreviousSibling();

PHP 8のDom\Entity::previousSiblingプロパティは、現在のDom\Entityノードの直前にある兄弟ノード、つまり同じ親を持つ直前のノードを取得するために使用されます。Dom\Entityノードは、XML文書のDTD（Document Type Definition）内で定義されるエンティティを表す特殊なノードです。このプロパティは引数を取らず、兄弟ノードが存在すればDom\Nodeオブジェクトを、存在しない場合はnullを返します。

Dom\Entityノードは、通常のDOMツリーの要素やテキストノードとは異なり、DTDの定義の一部として存在します。そのため、DOMツリーの要素構造内で他のノードと直接的な兄弟関係を持つことは非常に稀です。この特性から、Dom\EntityのpreviousSiblingプロパティはほとんどの場合nullを返します。サンプルコードでは、DTD内に定義されたエンティティを取得し、そのpreviousSiblingプロパティがnullを返す一般的な振る舞いを示しています。これはDom\Entityノードの特性によるものであり、想定された動作です。

Dom\Entityは、XMLのDTD（Document Type Definition）内で定義される特殊なノードであり、通常のDOMツリーの要素やテキストノードとは異なる文脈に存在します。そのため、Dom\EntityのpreviousSiblingプロパティは、ほとんどの場合nullを返します。これは、Dom\EntityノードがDTDの定義の一部として存在し、DOMツリー内で他のノードと直接的な兄弟関係を持つことが稀であるため、期待される動作です。したがって、previousSiblingが常に兄弟ノードを返すとは限らず、nullを返す可能性があることを考慮し、結果を適切に処理するコードを書くことが重要です。サンプルコードのように、DTDやエンティティの存在を事前に確認する処理は、エラーを防ぎ、より安全なプログラムを作成するために役立ちます。

関連コンテンツ

関連IT用語

関連プログラミング言語