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

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

作成日: 2025年09月11日更新日: 2025年12月14日

基本的な使い方

『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 オブジェクトを返します。

サンプルコード

DOMXPath::documentでDOMを取得する


1<?php
2
3/**
4 * DOMXPath::document プロパティの使用方法をデモンストレーションします。
5 * このプロパティは、DOMXPath オブジェクトが作成された元の DOMDocument オブジェクトを取得するために使用されます。
6 *
7 * このサンプルコードは、Webサーバーのドキュメントルート (DOCUMENT_ROOT) に存在する
8 * HTML ファイルを処理するシナリオを概念的に示しています。
9 * 実際には、`$_SERVER['DOCUMENT_ROOT']` を利用してファイルを読み込むことになりますが、
10 * ここでは独立して動作させるため、HTMLコンテンツを文字列として定義しています。
11 *
12 * @return void
13 */
14function demonstrateDomXPathDocumentProperty(): void
15{
16    // Webサーバーのドキュメントルートに配置されていると想定されるHTMLコンテンツを定義します。
17    // 例: $_SERVER['DOCUMENT_ROOT'] . '/index.html' から読み込まれた内容
18    $htmlContent = <<<HTML
19    <!DOCTYPE html>
20    <html lang="ja">
21    <head>
22        <meta charset="UTF-8">
23        <title>ドキュメントルートからのサンプルページ</title>
24    </head>
25    <body>
26        <h1>ようこそ！</h1>
27        <p>これは、HTMLドキュメントのサンプルコンテンツです。</p>
28        <div id="main-section">
29            <span class="highlight">重要な情報</span>
30        </div>
31    </body>
32    </html>
33    HTML;
34
35    // 新しい DOMDocument オブジェクトを作成し、HTMLコンテンツを読み込みます。
36    $dom = new DOMDocument();
37    
38    // HTMLの解析中に発生する可能性のある警告を抑制し、エラーをクリアします。
39    // これにより、不正なHTMLがあってもスクリプトが中断されにくくなります。
40    libxml_use_internal_errors(true);
41    $dom->loadHTML($htmlContent);
42    libxml_clear_errors();
43
44    echo "元の DOMDocument オブジェクトが正常にロードされました。\n";
45
46    // DOMDocument オブジェクトから DOMXPath オブジェクトを作成します。
47    // DOMXPath は、XPath クエリを使用して DOMDocument 内の要素を検索するために使用されます。
48    $xpath = new DOMXPath($dom);
49    echo "DOMXPath オブジェクトが作成されました。\n";
50
51    // DOMXPath::document プロパティにアクセスし、元の DOMDocument オブジェクトを取得します。
52    // このプロパティは、DOMXPath が関連付けられている DOMDocument インスタンスへの参照を返します。
53    $retrievedDom = $xpath->document;
54
55    echo "DOMXPath::document プロパティを使用して、元の DOMDocument を取得しようとしています...\n";
56
57    // 取得された DOMDocument オブジェクトが元のオブジェクトと同一であるかを確認します。
58    // オブジェクトが同一である場合、=== 演算子は true を返します。
59    if ($retrievedDom === $dom) {
60        echo "成功: DOMXPath::document プロパティは元の DOMDocument オブジェクトを返しました。\n";
61
62        // 取得した DOMDocument を使用して、さらに操作を行うことができます。
63        // 例: ドキュメントのタイトルを取得
64        $titles = $retrievedDom->getElementsByTagName('title');
65        if ($titles->length > 0) {
66            echo "取得した DOMDocument からのタイトル: " . $titles->item(0)->textContent . "\n";
67        }
68    } else {
69        echo "エラー: DOMXPath::document プロパティは予期された DOMDocument オブジェクトを返しませんでした。\n";
70    }
71}
72
73// デモンストレーション関数を実行します。
74demonstrateDomXPathDocumentProperty();
75

PHPのDOMXPath::documentプロパティは、DOMXPathオブジェクトが関連付けられている元のDOMDocumentオブジェクトを取得するために使用されます。このプロパティは、特定のDOMDocumentから作成されたDOMXPathインスタンスが、実際にはどのドキュメントを基にしているのかを確認したい場合に役立ちます。

このプロパティに引数はありません。呼び出すと、戻り値としてDOMDocument型のオブジェクトを返します。これにより、DOMXPathオブジェクトが生成された際の、その基となるHTMLやXMLドキュメント構造全体に再度アクセスすることが可能になります。

サンプルコードでは、まずHTMLコンテンツからDOMDocumentオブジェクトを作成し、次にそのDOMDocumentを基にDOMXPathオブジェクトを生成しています。その後、DOMXPath::documentプロパティを使用して、DOMXPathが参照している元のDOMDocumentを再取得しています。取得されたオブジェクトが、最初に作成したDOMDocumentと同一であることを確認することで、このプロパティの機能を示しています。これにより、XPathクエリを使って要素を検索するだけでなく、必要に応じて元のドキュメント自体に直接アクセスして操作を続けることができます。

このサンプルコードは、DOMXPath::documentプロパティが、DOMXPathオブジェクトが作成された元のDOMDocumentオブジェクトへの参照を返すことを示しています。このプロパティは新しいDOMDocumentオブジェクトを生成するのではなく、既存のオブジェクトを指すため、返されたオブジェクトを変更すると元のドキュメントにも影響します。

サンプルコードではHTMLコンテンツを文字列として扱っていますが、実際のWebアプリケーションでは$_SERVER['DOCUMENT_ROOT']などを利用し、サーバー上のHTMLファイルをDOMDocumentに読み込むことが一般的です。ファイルをロードする際は、正しいファイルパスの指定と、ファイルの存在確認が重要になります。

また、libxml_use_internal_errors(true)とlibxml_clear_errors()は、不完全または不正なHTMLを解析する際のエラー表示を抑制し、スクリプトの停止を防ぐために使用されます。実運用ではエラーを単に抑制するだけでなく、エラーの内容を適切にログに記録するなど、より堅牢なエラーハンドリングを検討してください。

PHP DOMXPath::documentでDOMDocumentを取得する


1<?php
2
3/**
4 * DOMXPath::document プロパティの使用例を示します。
5 * このプロパティは、DOMXPath オブジェクトが関連付けられている DOMDocument オブジェクトを返します。
6 *
7 * @return void
8 */
9function demonstrateDomXpathDocumentProperty(): void
10{
11    // 1. 新しい DOMDocument オブジェクトを作成します。
12    //    これはXMLドキュメント全体を表すコンテナです。
13    $dom = new DOMDocument();
14
15    // 2. XML文字列を DOMDocument にロードします。
16    //    簡単なXML構造を定義します。
17    $xmlString = <<<XML
18<?xml version="1.0" encoding="UTF-8"?>
19<root>
20    <item id="1">First Item</item>
21    <item id="2">Second Item</item>
22</root>
23XML;
24    $dom->loadXML($xmlString);
25
26    // 3. DOMXPath オブジェクトを作成し、上記の DOMDocument と関連付けます。
27    //    DOMXPath は、XMLドキュメント内でXPathクエリを実行するためのツールです。
28    $xpath = new DOMXPath($dom);
29
30    // 4. DOMXPath オブジェクトの 'document' プロパティにアクセスします。
31    //    これにより、この DOMXPath オブジェクトが操作している元の DOMDocument オブジェクトが取得できます。
32    $retrievedDocument = $xpath->document;
33
34    // 5. 取得した DOMDocument が元のものと同じインスタンスであることを確認します。
35    echo "--- 元の DOMDocument の内容 ---\n";
36    echo $dom->saveXML();
37    echo "\n";
38
39    echo "--- DOMXPath::document で取得した DOMDocument の内容 ---\n";
40    echo $retrievedDocument->saveXML();
41    echo "\n";
42
43    // オブジェクトが全く同じインスタンスであるかを確認します。
44    // (=== 演算子は、同じ型で同じ値、かつ同じオブジェクトインスタンスであるかをチェックします)
45    if ($dom === $retrievedDocument) {
46        echo "DOMXPath::document で取得された DOMDocument は、元の DOMDocument と同じインスタンスです。\n";
47    } else {
48        echo "DOMXPath::document で取得された DOMDocument は、元の DOMDocument と異なるインスタンスです。\n";
49    }
50
51    // 取得した DOMDocument を使って、元のドキュメントから情報を取得することもできます。
52    // 例: ドキュメントの要素数をカウント
53    $elements = $retrievedDocument->getElementsByTagName('item');
54    echo "取得した DOMDocument に含まれる 'item' 要素の数: " . $elements->count() . "\n";
55}
56
57// 関数の実行
58demonstrateDomXpathDocumentProperty();

PHPのDOMXPath::documentプロパティは、XPathクエリを実行するDOMXPathが、関連付けられているDOMDocumentオブジェクトを取得する際に利用します。このプロパティは引数を取らず、関連付けられたDOMDocumentオブジェクトそのものを戻り値として返します。

XMLを扱うPHPでは、まずDOMDocumentオブジェクトでXML全体を読み込み、それを基にDOMXPathを生成してXPathクエリを実行します。DOMXPath::documentにアクセスすることで、DOMXPathが基とするDOMDocumentオブジェクトへいつでも再アクセスできます。

サンプルコードでは、このプロパティが元のDOMDocumentオブジェクトと同一インスタンスを返すことを===演算子で確認しています。これにより、DOMXPathを介して元のドキュメント全体に容易にアクセスし、DOMDocumentの機能でXML操作や情報取得を継続できます。

DOMXPath::documentプロパティは、DOMXPathオブジェクトが初期化時に受け取ったDOMDocumentオブジェクトそのものを返します。これは新しいDOMDocumentを作成するわけではなく、元のオブジェクトへの参照である点に注意してください。したがって、このプロパティを通じて取得したDOMDocumentを変更すると、元のDOMDocumentにもその変更が直接反映されます。サンプルコードの===演算子による比較は、両者がメモリ上で同一のインスタンスであることを確認しています。XMLドキュメントの解析や操作において、DOMXPathでクエリを実行した後、元のドキュメント構造に再度アクセスしたい場合に活用できます。このプロパティは、元のドキュメントの状態を常に把握しておくための便利な手段です。