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

Copy
1<?php
2
3/**
4 * SimpleXMLElement::xpath() メソッドの使用例。
5 * XMLデータからXPathクエリを使って特定の要素を検索します。
6 */
7
8// サンプルとなるXMLデータを用意
9$xmlString = <<<XML
10<books>
11    <book id="1">
12        <title>PHP for Beginners</title>
13        <author>John Doe</author>
14        <price>29.99</price>
15        <category>Programming</category>
16    </book>
17    <book id="2">
18        <title>Advanced PHP Concepts</title>
19        <author>Jane Smith</author>
20        <price>49.99</price>
21        <category>Programming</category>
22    </book>
23    <book id="3">
24        <title>Learning XML Basics</title>
25        <author>Peter Jones</author>
26        <price>39.99</price>
27        <category>Data</category>
28    </book>
29</books>
30XML;
31
32// XML文字列からSimpleXMLElementオブジェクトを作成
33// 失敗する可能性があるため、チェックを行う
34libxml_use_internal_errors(true); // XMLパースエラーを内部で処理
35$xml = simplexml_load_string($xmlString);
36
37if ($xml === false) {
38    echo "XMLのパースに失敗しました。\n";
39    foreach (libxml_get_errors() as $error) {
40        echo "  - " . trim($error->message) . "\n";
41    }
42    libxml_clear_errors(); // 処理後エラー情報をクリア
43    exit(1);
44}
45
46echo "--- 1. 全ての書籍のタイトルを取得 ---\n";
47// XPathクエリ「//book/title」は、全ての<book>要素の子である<title>要素を選択します。
48// xpath()メソッドはSimpleXMLElementオブジェクトの配列、または失敗時にfalseを返します。
49$titles = $xml->xpath('//book/title');
50
51if ($titles !== false) {
52    if (count($titles) > 0) {
53        foreach ($titles as $title) {
54            // SimpleXMLElementオブジェクトを文字列にキャストして表示
55            echo "タイトル: " . (string)$title . "\n";
56        }
57    } else {
58        echo "該当するタイトルは見つかりませんでした。\n";
59    }
60} else {
61    echo "XPathクエリの実行に失敗しました。\n";
62}
63
64echo "\n--- 2. 価格が40より高い書籍のタイトルと著者を取得 ---\n";
65// XPathクエリ「//book[price > 40]」は、<price>要素の値が40より大きい<book>要素を選択します。
66$expensiveBooks = $xml->xpath('//book[price > 40]');
67
68if ($expensiveBooks !== false) {
69    if (count($expensiveBooks) > 0) {
70        foreach ($expensiveBooks as $book) {
71            // 見つかった<book>要素から、子要素にアクセス
72            echo "タイトル: " . (string)$book->title . ", 著者: " . (string)$book->author . ", 価格: " . (string)$book->price . "\n";
73        }
74    } else {
75        echo "該当する高価な書籍は見つかりませんでした。\n";
76    }
77} else {
78    echo "XPathクエリの実行に失敗しました。\n";
79}
80
81echo "\n--- 3. 特定の属性を持つ書籍を取得 ---\n";
82// XPathクエリ「//book[@id="1"]」は、id属性が"1"である<book>要素を選択します。
83$bookWithId1 = $xml->xpath('//book[@id="1"]');
84
85if ($bookWithId1 !== false) {
86    if (count($bookWithId1) > 0) {
87        echo "IDが1の書籍のタイトル: " . (string)$bookWithId1[0]->title . "\n";
88    } else {
89        echo "IDが1の書籍は見つかりませんでした。\n";
90    }
91} else {
92    echo "XPathクエリの実行に失敗しました。\n";
93}
94
95echo "\n--- 4. 存在しない要素をクエリした場合 ---\n";
96// 存在しないXPath式の場合、xpath()は空の配列を返します。
97$nonExistentElements = $xml->xpath('//nonExistentElement');
98
99if ($nonExistentElements !== false) {
100    if (count($nonExistentElements) === 0) {
101        echo "存在しない要素をクエリしました。結果は空の配列です。\n";
102    } else {
103        echo "存在しないはずの要素が見つかりました。\n";
104    }
105} else {
106    echo "XPathクエリの実行に失敗しました。（通常、文法的に誤ったXPath式の場合にfalseが返されます）\n";
107}
108

PHPのSimpleXMLElement::xpath()メソッドは、XMLデータからXPathクエリを使って特定の要素を検索・抽出するための機能を提供します。このメソッドは、引数として検索条件となるXPath式を文字列（string $expression）で受け取ります。

成功した場合、条件に一致するSimpleXMLElementオブジェクトの配列を返します。もし該当する要素が見つからなかった場合は空の配列を返し、XPath式が文法的に不正であるなど、メソッドの実行中にエラーが発生した場合にはfalseを返します。

サンプルコードでは、まずXML文字列をSimpleXMLElementオブジェクトに変換し、エラーハンドリングを行っています。その後、xpath()メソッドを使用して、具体的な検索例を示しています。例えば、//book/titleというXPath式で全ての書籍タイトルを取得したり、//book[price > 40]のように価格で条件を絞り込んだり、//book[@id="1"]のように特定の属性値を持つ要素を抽出したりしています。取得された結果はSimpleXMLElementオブジェクトの配列として扱われ、foreachループで反復処理し、必要に応じて(string)で文字列にキャストして内容を表示しています。メソッドの戻り値を適切にチェックすることで、検索の成否や結果の有無を確認する重要性も示しています。

Copy
1<?php
2
3/**
4 * PHPのSimpleXMLElement::xpath()メソッドの基本的な使い方を示すサンプルコードです。
5 * システムエンジニアを目指す初心者の方向けに、XPathクエリでのXMLデータ抽出方法を簡潔に紹介します。
6 */
7function demonstrateSimpleXpathUsage(): void
8{
9    // サンプルとなるXMLデータ文字列を定義します。
10    // このXMLには、複数の製品(product)とその詳細情報(name, price, category, specsなど)が含まれています。
11    $xmlString = <<<XML
12<products>
13    <product id="1" status="available">
14        <name>Laptop</name>
15        <price currency="USD">1200.00</price>
16        <category>Electronics</category>
17        <specs>
18            <weight>2kg</weight>
19            <color>Silver</color>
20        </specs>
21    </product>
22    <product id="2" status="out_of_stock">
23        <name>Mouse</name>
24        <price currency="USD">25.00</price>
25        <category>Electronics</category>
26        <specs>
27            <weight>0.1kg</weight>
28            <color>Black</color>
29        </specs>
30    </product>
31    <product id="3" status="available">
32        <name>Keyboard</name>
33        <price currency="USD">75.00</price>
34        <category>Peripherals</category>
35        <specs>
36            <weight>0.5kg</weight>
37            <color>Black</color>
38        </specs>
39    </product>
40</products>
41XML;
42
43    // XML文字列をSimpleXMLElementオブジェクトとしてロードします。
44    // simplexml_load_string() は成功した場合 SimpleXMLElement オブジェクトを、失敗した場合 false を返します。
45    $xml = simplexml_load_string($xmlString);
46
47    // XMLのパースに失敗した場合の処理
48    if ($xml === false) {
49        echo "エラー: XMLのパースに失敗しました。\n";
50        // libxml_get_errors() は、パースエラーの詳細情報を提供します。
51        foreach (libxml_get_errors() as $error) {
52            echo "- " . $error->message;
53        }
54        return; // 関数を終了
55    }
56
57    echo "--- SimpleXMLElement::xpath() の基本的な使用例 ---\n\n";
58
59    // 例1: すべての製品名を取得する
60    // '//product/name' は、XMLドキュメント内の任意の場所にある 'product' 要素の子である 'name' 要素をすべて選択します。
61    echo "1. すべての製品名:\n";
62    $productNames = $xml->xpath('//product/name');
63    // SimpleXMLElement::xpath() は結果が array|false となるため、両方のケースを考慮します。
64    // PHP 7.1以降では、マッチする要素がない場合でも通常は空の配列が返されます。
65    if ($productNames === false) { 
66        echo "  - エラー: XPathクエリの実行に失敗しました。\n";
67    } elseif (empty($productNames)) {
68        echo "  - 該当する製品名はありませんでした。\n";
69    } else {
70        foreach ($productNames as $name) {
71            echo "  - " . $name . "\n"; // SimpleXMLElement オブジェクトを文字列として出力すると、そのテキスト値が表示されます。
72        }
73    }
74    echo "\n";
75
76    // 例2: IDが"1"の製品を取得する
77    // '//product[@id="1"]' は、'id' 属性が "1" である 'product' 要素をすべて選択します。
78    echo "2. IDが '1' の製品:\n";
79    $productById1 = $xml->xpath('//product[@id="1"]');
80    if ($productById1 === false) {
81        echo "  - エラー: XPathクエリの実行に失敗しました。\n";
82    } elseif (empty($productById1)) {
83        echo "  - 該当する製品は見つかりませんでした。\n";
84    } else {
85        foreach ($productById1 as $product) {
86            // 見つかった製品の要素 (SimpleXMLElementオブジェクト) から、子要素や属性にアクセスできます。
87            echo "  - 製品名: " . $product->name . ", 価格: " . $product->price . " " . $product->price['currency'] . "\n";
88        }
89    }
90    echo "\n";
91
92    // 例3: カテゴリが"Electronics"の製品の価格を取得する
93    // '//product[category="Electronics"]/price' は、子要素 'category' の値が "Electronics" である 'product' の子である 'price' 要素を選択します。
94    echo "3. カテゴリが 'Electronics' の製品の価格:\n";
95    $electronicsPrices = $xml->xpath('//product[category="Electronics"]/price');
96    if ($electronicsPrices === false) {
97        echo "  - エラー: XPathクエリの実行に失敗しました。\n";
98    } elseif (empty($electronicsPrices)) {
99        echo "  - 該当する製品価格は見つかりませんでした。\n";
100    } else {
101        foreach ($electronicsPrices as $price) {
102            echo "  - " . $price . " " . $price['currency'] . "\n";
103        }
104    }
105    echo "\n";
106
107    // 例4: 'available' ステータスの製品のID属性値を取得する
108    // '//product[@status="available"]/@id' は、'status' 属性が "available" である 'product' 要素の 'id' 属性の値をすべて選択します。
109    // 属性を選択した場合、結果は文字列のSimpleXMLElementオブジェクトとして返されます。
110    echo "4. ステータスが 'available' の製品のID:\n";
111    $availableProductIds = $xml->xpath('//product[@status="available"]/@id');
112    if ($availableProductIds === false) {
113        echo "  - エラー: XPathクエリの実行に失敗しました。\n";
114    } elseif (empty($availableProductIds)) {
115        echo "  - 該当する製品IDは見つかりませんでした。\n";
116    } else {
117        foreach ($availableProductIds as $id) {
118            echo "  - " . $id . "\n"; // SimpleXMLElement オブジェクトの属性値を文字列として出力
119        }
120    }
121    echo "\n";
122
123    // 例5: 存在しないパスを検索する
124    // この場合、xpath() メソッドは通常、空の配列を返します (PHP 7.1以降)。
125    echo "5. 存在しないパスを検索:\n";
126    $nonExistentPath = $xml->xpath('//nonexistent/element');
127    if ($nonExistentPath === false) {
128        echo "  - エラー: XPathクエリの実行に失敗しました。(通常このケースは発生しません)\n";
129    } elseif (empty($nonExistentPath)) {
130        echo "  - 該当する要素は見つかりませんでした。(空の配列が返されました)\n";
131    } else {
132        echo "  - 結果が見つかりました。(予期しない結果)\n";
133        foreach ($nonExistentPath as $element) {
134            echo "  - " . $element->asXML() . "\n";
135        }
136    }
137    echo "\n";
138}
139
140// demonstrateSimpleXpathUsage() 関数を実行して、上記の使用例を表示します。
141demonstrateSimpleXpathUsage();
142

PHP 8のSimpleXMLElement::xpath()メソッドは、XMLデータから特定の情報を効率的に抽出するための強力な機能です。このメソッドはSimpleXMLElementオブジェクトに属しており、XMLドキュメント内の要素や属性をXPathというクエリ言語を使って検索します。

引数には$expressionとしてXPathクエリ文字列を渡します。このクエリは、XML構造の中でどの要素や属性を選択するかを記述するもので、特定の名前の要素、特定の属性値を持つ要素、あるいは特定の子要素を持つ要素などを指定できます。

メソッドの戻り値はarrayまたはfalseです。XPathクエリにマッチする要素や属性が見つかった場合、それらはSimpleXMLElementオブジェクトの配列として返されます。マッチするものが一つもなかった場合でも、通常は空の配列が返されます（PHP 7.1以降）。ただし、XPathクエリの実行に失敗するなど、何らかのシステムエラーが発生した場合にはfalseが返されるため、この戻り値の確認は重要です。

提供されたサンプルコードでは、製品情報を含むXML文字列をSimpleXMLElementオブジェクトとしてロードし、エラーハンドリングを行った上でxpath()メソッドの様々な使い方を紹介しています。「すべての製品名を取得する」、「IDが"1"の製品を取得する」、「カテゴリが"Electronics"の製品の価格を取得する」、「ステータスが"available"の製品のID属性値を取得する」といった具体的な検索例を通して、XPathクエリがXMLデータから必要な情報を柔軟に抽出できることを示しています。これにより、XMLデータ処理の効率が大幅に向上します。