Webエンジニア向けプログラミング解説動画をYouTubeで配信中!
▶ チャンネル登録はこちら

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

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

作成日: 更新日:

基本的な使い方

『documentプロパティは、XPathクエリの実行対象となるDom\Documentオブジェクトを保持するプロパティです。Dom\XPathクラスのインスタンスは、特定のXMLやHTMLドキュメントに対してXPath式を評価するために作成されます。このdocumentプロパティには、そのインスタンスが関連付けられているドキュメントオブジェクトそのものが格納されています。具体的には、Dom\XPathのコンストラクタに渡されたDom\Documentオブジェクトと同じものを参照します。このプロパティを利用することで、XPathクエリを実行した後でも、どのドキュメントを操作しているかを常に確認でき、元のドキュメントオブジェクトにアクセスして、さらに別の操作を行うことが可能になります。このプロパティは読み取り専用(readonly)であるため、一度Dom\XPathオブジェクトが生成されると、後から別のドキュメントに差し替えることはできません。この仕様は、処理の途中で対象ドキュメントが意図せず変更されることを防ぎ、コードの安定性と予測可能性を高めるのに役立ちます。したがって、documentプロパティは、Dom\XPathオブジェクトとそれが操作するドキュメントとの間の明確な関連付けを管理するための重要な役割を担っています。』

構文(syntax)

1<?php
2
3$document = new \DOMDocument();
4$document->loadXML('<users><user>Alice</user></users>');
5
6$xpath = new \Dom\XPath($document);
7
8// DOMXPathオブジェクトに関連付けられているDOMDocumentオブジェクトを取得します。
9$retrievedDocument = $xpath->document;
10
11// 取得したドキュメントのルート要素のタグ名を出力します。
12echo $retrievedDocument->documentElement->tagName;
13
14?>

引数(parameters)

引数なし

引数はありません

戻り値(return)

Dom\Document

この document プロパティは、XPath クエリを実行する対象となる DOMDocument オブジェクトを返します。

関連コンテンツ

関連プログラミング言語

【PHP8.x】Dom\XPath::documentプロパティの使い方 | いっしー@Webエンジニア