【PHP8.x】DOMXPath::__construct()メソッドの使い方

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * DOMXPathクラスのコンストラクタを使用して、XMLドキュメントから特定の要素を検索するサンプルクラスです。
7 */
8class XmlTitleFinder
9{
10    /**
11     * XMLドキュメントからすべての書籍タイトルを検索して表示します。
12     *
13     * このメソッド内でDOMXPathクラスのインスタンスを生成しており、
14     * その際にコンストラクタ (__construct) が呼び出されます。
15     */
16    public function findTitles(): void
17    {
18        // 1. 操作対象となるXMLデータを文字列として用意します。
19        $xmlString = <<<XML
20        <?xml version="1.0" encoding="UTF-8"?>
21        <books>
22            <book>
23                <title>PHP for Beginners</title>
24                <author>John Doe</author>
25            </book>
26            <book>
27                <title>Advanced PHP</title>
28                <author>Jane Smith</author>
29            </book>
30        </books>
31        XML;
32
33        // 2. DOMDocumentクラスのインスタンスを作成し、XMLを読み込みます。
34        // このオブジェクトが、DOMXPathコンストラクタの第1引数になります。
35        $document = new DOMDocument();
36        $document->loadXML($xmlString);
37
38        // 3. DOMXPathクラスのコンストラクタを呼び出し、インスタンスを生成します。
39        // これにより、指定したXMLドキュメントに対してXPathクエリを実行する準備が整います。
40        // new DOMXPath(DOMDocument $document, bool $registerNodeNS = true)
41        $xpath = new DOMXPath($document);
42
43        // 4. XPathクエリを実行して、すべての<title>要素を取得します。
44        $query = '//book/title';
45        $entries = $xpath->query($query);
46
47        // 5. 取得した結果をループで処理し、各要素のテキスト内容を出力します。
48        echo "Found Titles:" . PHP_EOL;
49        if ($entries) {
50            foreach ($entries as $entry) {
51                echo "- " . $entry->nodeValue . PHP_EOL;
52            }
53        }
54    }
55}
56
57// クラスのインスタンスを生成し、メソッドを実行します。
58$finder = new XmlTitleFinder();
59$finder->findTitles();
60
61?>

DOMXPathクラスのコンストラクタ__constructは、new DOMXPath()のようにして、新しいDOMXPathオブジェクトを作成する際に自動的に呼び出される特別なメソッドです。このコンストラクタの主な役割は、XPathという問い合わせ言語を使ってXMLドキュメント内の要素を検索・操作するための準備を整えることです。

第一引数の$documentには、検索対象となるXMLデータが読み込まれたDOMDocumentオブジェクトを渡します。サンプルコードでは、XML文字列を読み込んだ$document変数がこれに該当します。この引数によって、どのXMLドキュメントに対して処理を行うのかを指定します。

第二引数の$registerNodeNSは省略可能な引数で、デフォルト値はtrueです。trueに設定すると、XMLドキュメント内で定義されている名前空間を自動的に登録し、クエリで利用できるようにします。通常はデフォルトのままで問題ありません。

コンストラクタはインスタンスを生成することが目的のため、特定の値を返すわけではなく、戻り値はありません。生成されたDOMXPathオブジェクトは、サンプルコードの$xpath変数のように変数に代入され、後続のquery()メソッドなどを呼び出して実際にXMLデータを検索するために使用されます。

Copy
1<?php
2
3// サンプル用のXML文字列を定義します。
4$xmlString = <<<XML
5<?xml version="1.0" encoding="UTF-8"?>
6<books>
7    <book>
8        <title>PHP入門</title>
9        <author>山田 太郎</author>
10    </book>
11    <book>
12        <title>実践PHP</title>
13        <author>鈴木 花子</author>
14    </book>
15</books>
16XML;
17
18// 1. DOMDocumentオブジェクトを作成し、XMLを読み込みます。
19// このオブジェクトがXPathで検索する対象となります。
20$dom = new DOMDocument();
21$dom->loadXML($xmlString);
22
23// 2. DOMXPathクラスのコンストラクタを使用して、新しいインスタンスを生成します。
24// 第1引数に検索対象のDOMDocumentオブジェクトを渡します。
25// ここで DOMXPath::__construct($dom) が内部的に呼び出されます。
26$xpath = new DOMXPath($dom);
27
28// 3. 作成したDOMXPathオブジェクトを使い、XPathクエリでtitle要素をすべて検索します。
29$query = '/books/book/title';
30$entries = $xpath->query($query);
31
32// 4. 検索結果を出力します。
33echo "見つかった書籍のタイトル:" . PHP_EOL;
34foreach ($entries as $entry) {
35    // nodeValueプロパティで要素のテキスト内容を取得します。
36    echo "- " . $entry->nodeValue . PHP_EOL;
37}
38
39?>

DOMXPath::__constructは、XMLドキュメントに対してXPathクエリを実行するためのDOMXPathオブジェクトを新しく作成する際に呼び出される、特別な初期化メソッド（コンストラクタ）です。new DOMXPath()のように記述することで、このメソッドが実行されます。

このコンストラクタには、必須の引数が1つあります。第1引数の$documentには、検索対象となるXML文書を読み込んだDOMDocumentオブジェクトを渡します。これにより、どのXMLドキュメントに対して検索を行うかをDOMXPathオブジェクトに設定します。サンプルコードでは、$dom変数がこの引数に該当します。第2引数$registerNodeNSは省略可能で、XMLの名前空間を自動で登録するかどうかを指定します。

コンストラクタ自体に定められた戻り値はありませんが、その役割はDOMXPathクラスの新しいインスタンス（オブジェクト）を生成して返すことです。サンプルコードでは、$xpath = new DOMXPath($dom);という記述で新しいオブジェクトが生成され、変数$xpathに代入されています。この$xpathオブジェクトを通じてquery()などのメソッドを呼び出すことで、実際にXMLドキュメント内の要素を検索できます。