【PHP8.x】xml_parse_into_struct関数の使い方

Copy
1<?php
2
3/**
4 * xml_parse_into_struct関数の基本的な使用例を示します。
5 * この関数はXML文字列をパースし、構造化された配列として要素の情報を格納します。
6 * システムエンジニアを目指す初心者向けに、簡潔かつ分かりやすく解説しています。
7 */
8function parseSimpleXml(): void
9{
10    // 1. パースするXMLデータを定義します。
11    // 非常にシンプルなXMLで、複数の要素とその値、属性を含みます。
12    $xmlData = <<<XML
13<?xml version="1.0" encoding="UTF-8"?>
14<items>
15    <item id="1">
16        <name>Apple</name>
17        <price>100</price>
18    </item>
19    <item id="2" type="fruit">
20        <name>Banana</name>
21        <price>50</price>
22    </item>
23</items>
24XML;
25
26    // 2. XMLパーサーを作成します。
27    // このパーサーを使ってXMLデータを解析します。
28    $parser = xml_parser_create();
29    if ($parser === false) {
30        echo "エラー: XMLパーサーの作成に失敗しました。\n";
31        return;
32    }
33
34    // 3. xml_parse_into_struct関数を使用してXMLをパースします。
35    // $values にはパースされた要素の詳細情報が、
36    // $index には要素名から$valuesのインデックスへのマッピング情報が格納されます。
37    $values = []; // パース結果の要素データを格納する配列
38    $index = [];  // 要素名のインデックス情報を格納する配列
39
40    // xml_parse_into_structは成功した場合に1を、失敗した場合に0またはfalseを返します。
41    $result = xml_parse_into_struct($parser, $xmlData, $values, $index);
42
43    if ($result === 0 || $result === false) {
44        // パースエラーが発生した場合、エラー情報を取得して表示します。
45        $errorCode = xml_get_error_code($parser);
46        $errorMessage = xml_error_string($errorCode);
47        $line = xml_get_current_line_number($parser);
48        $column = xml_get_current_column_number($parser);
49        echo "エラー: XMLのパースに失敗しました。\n";
50        echo "コード: {$errorCode}, メッセージ: {$errorMessage}\n";
51        echo "行: {$line}, 列: {$column}\n";
52    } else {
53        // 4. パース結果を表示して確認します。
54        echo "--- パースされた要素の値 (\$values) ---\n";
55        print_r($values);
56
57        echo "\n--- 要素のインデックス (\$index) ---\n";
58        print_r($index);
59
60        // 例: 特定の要素から情報を取得する方法
61        // $values配列の構造を理解すると、このようにデータにアクセスできます。
62        // ここでは、最初のITEM要素のnameとpriceを例として取得します。
63        echo "\n--- 具体的なデータへのアクセス例 ---\n";
64        foreach ($values as $element) {
65            if ($element['tag'] === 'NAME' && $element['type'] === 'complete') {
66                echo "商品名: " . $element['value'] . "\n";
67            }
68            if ($element['tag'] === 'PRICE' && $element['type'] === 'complete') {
69                echo "価格: " . $element['value'] . "\n";
70            }
71        }
72    }
73
74    // 5. XMLパーサーを解放します。
75    // リソースリークを防ぐために、使用後は必ず解放しましょう。
76    xml_parser_free($parser);
77}
78
79// 関数を実行してサンプルコードの動作を確認します。
80parseSimpleXml();

PHP 8のxml_parse_into_struct関数は、XML文字列を解析し、その内容を構造化された配列に変換する際に使用されます。この関数は、事前に作成したXMLParser $parser を使って$dataで指定されたXML文字列をパースします。パースが成功すると、XMLの各要素の詳細情報が&$values配列に参照渡しで格納され、要素名から$valuesのインデックスへのマッピング情報が&$index配列に参照渡しで格納されます。$values配列には、要素のタグ名、種類（開始、終了、完全）、値、属性などが含まれます。&$indexは、特定のタグを持つ要素を効率的に見つけるのに役立ちます。関数の戻り値は、パースが成功した場合は整数値の1、失敗した場合は0またはfalseです。これにより、パース処理の成否を判断できます。XMLのパース後には、xml_parser_free()関数でパーサーリソースを解放することが推奨されます。この関数は、XMLデータを配列として簡単に扱いたい場合に非常に便利です。