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

Copy
1<?php
2
3/**
4 * Dom\XPathクラスのコンストラクタを使用してXMLから要素を検索するサンプルクラスです。
5 */
6class XmlTitleFinder
7{
8    /**
9     * XML文字列からすべての書籍タイトルを検索し、表示します。
10     *
11     * @return void
12     */
13    public static function findTitles(): void
14    {
15        // 検索対象となるXMLデータを用意します。
16        $xmlString = <<<XML
17        <?xml version="1.0" encoding="UTF-8"?>
18        <bookshelf>
19            <book category="Programming">
20                <title lang="ja">独習PHP</title>
21                <author>山田 太郎</author>
22            </book>
23            <book category="Design">
24                <title lang="en">The Principles of Beautiful Web Design</title>
25                <author>Jason Beaird</author>
26            </book>
27        </bookshelf>
28        XML;
29
30        // 1. Dom\Documentオブジェクトを生成し、XMLデータを読み込みます。
31        // このオブジェクトがXPathで検索する対象のドキュメントとなります。
32        $document = new Dom\Document();
33        $document->loadXML($xmlString);
34
35        // 2. Dom\XPathのコンストラクタを呼び出し、インスタンスを生成します。
36        // 第1引数に検索対象のDom\Documentオブジェクトを渡します。
37        // これが、キーワード「php class constructor」に該当する部分です。
38        $xpath = new Dom\XPath($document);
39
40        // 3. XPathクエリを実行して、すべての<title>要素を取得します。
41        $titleNodes = $xpath->query('//book/title');
42
43        // 4. 取得した結果を画面に出力します。
44        echo "見つかった書籍のタイトル一覧:" . PHP_EOL;
45        foreach ($titleNodes as $node) {
46            // $node->nodeValue プロパティで要素のテキスト内容を取得できます。
47            echo "- " . $node->nodeValue . PHP_EOL;
48        }
49    }
50}
51
52// クラスのメソッドを実行します。
53XmlTitleFinder::findTitles();

Dom\XPath::__constructは、XMLドキュメントからXPathという問い合わせ言語を使って特定の要素を検索するための準備を行うコンストラクタです。コンストラクタとは、newキーワードを使ってクラスから新しいオブジェクトを生成する際に自動的に呼び出される特別なメソッドのことを指します。

このコンストラクタは、主に2つの引数を受け取ります。第1引数の$documentは必須で、検索対象となるXMLドキュメントを表すDom\Documentオブジェクトを指定します。サンプルコードでは、loadXMLメソッドでXML文字列を読み込んだ$documentオブジェクトを渡すことで、どのXMLを検索対象にするかを明確にしています。第2引数の$registerNodeNSは省略可能な引数で、XMLの名前空間を自動的に登録するかどうかを真偽値で指定します。通常はデフォルト値のtrueのままで問題ありません。

コンストラクタは新しいオブジェクトを生成することが役割のため、それ自体に特定の戻り値はありません。サンプルコードの$xpath = new Dom\XPath($document);という行が実行されると、指定された$documentを検索できるDom\XPathオブジェクトが新しく生成され、変数$xpathに代入されます。その後、この$xpathオブジェクトが持つqueryメソッドなどを利用して、実際にXML要素の検索を行います。

Copy
1<?php
2
3/**
4 * Dom\XPathクラスのコンストラクタを使用して、XMLデータから書籍のタイトルを抽出します。
5 *
6 * PHP 8から導入された Dom 名前空間を利用しています。
7 */
8function demonstrateDomXPathConstructor(): void
9{
10    // 1. 操作対象となるXMLデータを文字列として用意します。
11    $xmlString = <<<XML
12    <?xml version="1.0" encoding="UTF-8"?>
13    <books>
14        <book category="WEB">
15            <title lang="ja">PHP実践入門</title>
16            <author>山田 太郎</author>
17        </book>
18        <book category="DATA">
19            <title lang="ja">XPathのすべて</title>
20            <author>鈴木 花子</author>
21        </book>
22    </books>
23    XML;
24
25    // 2. XML文字列から Dom\Document オブジェクトを生成します。
26    // このオブジェクトがXPathの操作対象となります。
27    $document = new Dom\Document();
28    $document->loadXML($xmlString);
29
30    // 3. Dom\XPath のコンストラクタを呼び出し、インスタンスを生成します。
31    //    コンストラクタの第一引数に、操作対象の Dom\Document オブジェクトを渡します。
32    //    これが今回の主題となるコードです。
33    $xpath = new Dom\XPath($document);
34
35    // 4. XPathクエリを実行して、すべての<title>要素を取得します。
36    $query = '/books/book/title';
37    $nodes = $xpath->query($query);
38
39    // 5. 取得した要素（ノード）の内容を順番に出力します。
40    echo "書籍のタイトル一覧:\n";
41    foreach ($nodes as $node) {
42        // $node->nodeValue プロパティで要素のテキスト内容を取得できます。
43        echo "- " . $node->nodeValue . "\n";
44    }
45}
46
47// 関数を実行してサンプルコードの動作を確認します。
48demonstrateDomXPathConstructor();

Dom\XPath::__constructは、XMLドキュメントに対してXPathクエリを実行するためのDom\XPathオブジェクトを生成するコンストラクタです。コンストラクタとは、newキーワードを使ってクラスから新しいオブジェクトを作成する際に自動的に呼び出される特別なメソッドのことです。

このコンストラクタは、第一引数$documentに、操作対象となるXMLデータを読み込んだDom\Documentオブジェクトを指定します。これにより、どのXMLドキュメントに対してXPathクエリを実行するのかが決定されます。サンプルコードでは、XML文字列から生成した$documentオブジェクトが渡されています。

第二引数の$registerNodeNSは省略可能な引数で、XMLの名前空間を自動的に登録するかどうかを設定します。デフォルトはtrueであり、通常はこの設定のままで問題ありません。

コンストラクタ自体にreturn文による戻り値はありませんが、new Dom\XPath($document)という式を実行することで、新しく初期化されたDom\XPathオブジェクトが生成されます。この生成されたオブジェクトを通じてqueryメソッドなどを呼び出し、XMLデータの中から目的の要素を効率的に検索・抽出することが可能になります。