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

Copy
1<?php
2
3/**
4 * XMLReader::fromString メソッドを使用してXML文字列を読み込むサンプルコードです。
5 * システムエンジニアを目指す初心者向けに、XMLデータの基本的な読み込み方法を示します。
6 *
7 * XMLReader は、大規模なXMLドキュメントをメモリにすべて読み込まずに、
8 * ストリーム形式で読み込む（SAXパーサーに似た）ためのクラスです。
9 */
10function readXmlFromStringExample(): void
11{
12    // 読み込むXML文字列を定義します。
13    // ここでは、いくつかの商品情報を含むシンプルなXML構造を例として使用します。
14    $xmlString = <<<XML
15<?xml version="1.0" encoding="UTF-8"?>
16<products>
17    <product id="P001" status="available">
18        <name>Super Laptop 2000</name>
19        <price currency="USD">1200.00</price>
20        <description>High performance laptop for professionals.</description>
21    </product>
22    <product id="P002" status="out_of_stock">
23        <name>Ergonomic Mouse</name>
24        <price currency="USD">35.99</price>
25    </product>
26</products>
27XML;
28
29    // XMLReader オブジェクトを新しく作成します。
30    $reader = new XMLReader();
31
32    // fromString メソッドを使って、定義したXML文字列を読み込みます。
33    // このメソッドは、XMLデータがファイルパスではなく、直接PHPの文字列として渡される場合に非常に便利です。
34    // 成功した場合は XMLReader オブジェクトを返し、失敗した場合は false を返します。
35    if (!$reader->fromString($xmlString)) {
36        echo "エラー: XML文字列の読み込みに失敗しました。\n";
37        return; // 読み込み失敗時は処理を中断します。
38    }
39
40    echo "XML文字列からデータを読み込み中...\n\n";
41
42    // read() メソッドを使って、XMLドキュメント内の各ノードを順番に読み進めます。
43    // ループはドキュメントの最後まで達すると false を返し、終了します。
44    while ($reader->read()) {
45        // 各ノードのタイプに基づいて異なる処理を行います。
46        // XMLReader::ELEMENT は要素の開始タグ (<product>, <name> など) を示します。
47        // XMLReader::TEXT は要素内のテキストコンテンツを示します。
48        // XMLReader::END_ELEMENT は要素の終了タグ (</product>, </name> など) を示します。
49        switch ($reader->nodeType) {
50            case XMLReader::ELEMENT:
51                echo "  要素開始: <" . $reader->name;
52                // 特定の要素 (例: 'product') に属性があるかチェックし、取得します。
53                if ($reader->name === 'product' && $reader->hasAttributes) {
54                    $productId = $reader->getAttribute('id');
55                    $productStatus = $reader->getAttribute('status');
56                    echo " id=\"" . $productId . "\" status=\"" . $productStatus . "\"";
57                }
58                // 'price' 要素には 'currency' 属性があるかもしれません。
59                if ($reader->name === 'price' && $reader->hasAttributes) {
60                    $currency = $reader->getAttribute('currency');
61                    echo " currency=\"" . $currency . "\"";
62                }
63                echo ">\n";
64                break;
65            case XMLReader::TEXT:
66                // テキストノードの値が存在し、それが空白文字でない場合に表示します。
67                if (trim($reader->value) !== '') {
68                    echo "    テキスト値: \"" . $reader->value . "\"\n";
69                }
70                break;
71            case XMLReader::END_ELEMENT:
72                echo "  要素終了: </" . $reader->name . ">\n";
73                break;
74            // その他のノードタイプ（コメント、CDATAセクションなど）はここでは省略します。
75        }
76    }
77
78    // 全てのノードの読み込みが完了したら、XMLReaderリソースを閉じます。
79    // これは、開かれたリソースを解放し、メモリリークを防ぐために重要です。
80    $reader->close();
81    echo "\nXML文字列からの読み込みが完了しました。\n";
82}
83
84// 定義した関数を実行して、XMLReader::fromString の動作を確認します。
85readXmlFromStringExample();
86

PHPのXMLReaderクラスは、XMLドキュメントをメモリ全体に読み込まず、ストリーム形式で効率的に処理するためのクラスです。特に大規模なXMLファイルを扱う際に有用です。このクラスに所属するfromStringメソッドは、ファイルパスではなく、直接PHPの文字列として与えられたXMLデータを読み込む際に利用されます。

fromStringメソッドは、最初の引数$sourceに読み込みたいXML文字列を指定します。オプションでエンコーディング（$encoding）や処理フラグ（$flags）を設定できますが、通常は省略可能です。このメソッドは、XMLの読み込みに成功した場合にXMLReaderオブジェクト自体を返し、読み込みに失敗した場合はfalseを返します。そのため、戻り値をチェックしてエラー処理を行うことが重要です。

サンプルコードでは、まずシンプルな商品情報を含むXML文字列を定義し、新しいXMLReaderオブジェクトを作成しています。その後、fromStringメソッドを使ってこのXML文字列をロードします。読み込みが成功すると、while ($reader->read())ループを使用してXML内の各ノードを順に処理します。nodeTypeプロパティを使ってノードの種類を判別し、nameプロパティで要素名を取得したり、getAttributeメソッドで属性値を抽出したりして、データを読み進めます。最後に、closeメソッドを呼び出して、使用したリソースを適切に解放することで処理を終えます。