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

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

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

作成日: 更新日:

基本的な使い方

『documentプロパティは、このDOMXPathオブジェクトが関連付けられているDOMDocumentオブジェクトを保持するプロパティです。DOMXPathクラスは、XMLやHTMLドキュメントの構造に対してXPathという問い合わせ言語を用いて要素を検索したり評価したりするために使用されます。その操作対象となるドキュメントは、DOMXPathオブジェクトを生成する際のコンストラクタにDOMDocumentオブジェクトとして渡され、このdocumentプロパティにその参照が格納されます。開発者はこのプロパティにアクセスすることで、DOMXPathオブジェクトが現在どのドキュメントを操作対象としているかを確認できます。また、このプロパティから取得したDOMDocumentオブジェクトを利用して、XPathによる検索だけでなく、要素の追加や削除といったDOM標準の操作を別途行うことも可能です。このプロパティは読み取り専用として定義されており、DOMXPathオブジェクトが一度生成された後に、関連付けられているドキュメントを外部から変更することはできません。

構文(syntax)

1<?php
2
3$dom = new DOMDocument();
4$dom->loadXML('<books><book>PHP Manual</book></books>');
5
6$xpath = new DOMXPath($dom);
7
8// DOMXPathオブジェクトに関連付けられているDOMDocumentオブジェクトを取得します
9$documentObject = $xpath->document;
10
11// 取得したDOMDocumentオブジェクトのルート要素名を出力します
12echo $documentObject->documentElement->tagName; // "books"
13
14?>

引数(parameters)

引数なし

引数はありません

戻り値(return)

DOMDocument

DOMXPath オブジェクトが紐づいている DOMDocument オブジェクトを返します。

関連コンテンツ

関連プログラミング言語