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

Copy
1<?php
2
3/**
4 * 指定されたXMLデータからアイテム情報を抽出し、配列として返します。
5 *
6 * この関数はXMLReaderクラスを利用してXML文書をストリーム形式で解析します。
7 * メモリ効率が良く、大規模なXMLファイルを処理するのに適しています。
8 *
9 * @param string $xmlContent 読み込むXMLデータの文字列。
10 * @return array 抽出されたアイテム情報の配列。エラー発生時は空の配列。
11 */
12function extractItemsFromXml(string $xmlContent): array
13{
14    // XMLReaderオブジェクトを初期化します。
15    $reader = new XMLReader();
16
17    // XML文字列からリーダーを開きます。
18    // ファイルから読み込む場合は $reader->open('ファイルパス.xml') を使用します。
19    if (!$reader->XML($xmlContent)) {
20        // リーダーのオープンに失敗した場合、エラーメッセージを出力して終了します。
21        error_log("XMLリーダーを開けませんでした。");
22        return [];
23    }
24
25    $items = [];        // 抽出されたアイテムを格納する配列。
26    $currentItem = [];  // 現在処理中のアイテム情報を一時的に保持する配列。
27
28    // XMLドキュメントのノードを一つずつ読み進めます。
29    // read() メソッドは次のノードに移動し、成功した場合は true、ドキュメントの終わりに達した場合は false を返します。
30    while ($reader->read()) {
31        // 現在のノードが要素の開始タグであるかを確認します。
32        if ($reader->nodeType === XMLReader::ELEMENT) {
33            switch ($reader->name) {
34                case 'item':
35                    // 'item'要素の開始時、新しいアイテムの処理を開始します。
36                    $currentItem = [];
37                    break;
38                case 'name':
39                    // 'name'要素のテキスト内容を読み込みます。
40                    // readString() は現在のノードのテキスト内容を取得し、リーダーを次のノードに進めます。
41                    $currentItem['name'] = $reader->readString();
42                    break;
43                case 'price':
44                    // 'price'要素のテキスト内容を読み込み、浮動小数点数に変換します。
45                    $currentItem['price'] = (float)$reader->readString();
46                    break;
47            }
48        } elseif ($reader->nodeType === XMLReader::END_ELEMENT) {
49            // 現在のノードが要素の終了タグであるかを確認します。
50            if ($reader->name === 'item' && !empty($currentItem)) {
51                // 'item'要素の終了時、現在のアイテム情報を最終的な配列に追加します。
52                $items[] = $currentItem;
53                $currentItem = []; // 次のアイテムのために一時配列をリセットします。
54            }
55        }
56    }
57
58    // XMLReaderをクローズし、使用したリソースを解放します。
59    $reader->close();
60
61    return $items;
62}
63
64// 単体で動作させるためのサンプルXMLデータ文字列
65$sampleXmlData = <<<XML
66<?xml version="1.0" encoding="UTF-8"?>
67<catalog>
68    <item>
69        <name>PHP Programming Book</name>
70        <price>35.50</price>
71    </item>
72    <item>
73        <name>Database Management Guide</name>
74        <price>48.25</price>
75    </item>
76    <item>
77        <name>Web Development Basics</name>
78        <price>22.99</price>
79    </item>
80</catalog>
81XML;
82
83// 関数を呼び出し、XMLデータからアイテム情報を抽出します。
84$extractedItems = extractItemsFromXml($sampleXmlData);
85
86// 抽出されたデータを表示します。
87if (!empty($extractedItems)) {
88    echo "--- 抽出されたアイテム情報 ---\n";
89    foreach ($extractedItems as $item) {
90        echo "名前: " . ($item['name'] ?? 'N/A') . ", 価格: " . ($item['price'] ?? 'N/A') . "\n";
91    }
92} else {
93    echo "抽出されたアイテムはありませんでした。\n";
94}

このサンプルコードは、PHPのXMLReaderクラスを使ってXMLデータから特定の情報（ここではアイテムの名前と価格）を効率的に抽出する処理を示しています。XMLReaderは、XML文書を最初から最後まで順番に読み込む「ストリームパーサー」であり、大規模なXMLファイルを扱う際にメモリ消費を抑えられる点が特徴です。

コードの中心となるのは、while ($reader->read())というループです。ここで使用されているreadメソッドは、引数を取らずに、XMLドキュメント内の次のノードへ移動する役割を果たします。このメソッドは、次のノードが正常に読み込まれた場合はtrueを返し、ドキュメントの終わりに達してこれ以上読み込むノードがなくなった場合はfalseを返します。この戻り値を利用して、XMLドキュメント全体を順番に処理するループを制御しています。

ループの中では、readメソッドで読み進めた現在のノードが要素の開始タグなのか、終了タグなのか、あるいはそのノードの名前が何であるかを$reader->nodeTypeや$reader->nameといったプロパティで判断しています。例えば、<item>タグの開始時には新しいアイテム情報の準備をし、<name>や<price>タグの開始時にはその内容をreadString()メソッドで読み取っています。そして、</item>タグの終了時に、集めた情報を最終的な配列に追加しています。このようにreadメソッドで一つずつノードを進めることで、必要なデータだけを選び出し、配列として整形して返す一連の処理を実現しています。

Copy
1<?php
2
3/**
4 * 商品データを表現するクラス。
5 * readonly プロパティは、一度設定されるとその後変更できないことを保証します (PHP 8.1以降)。
6 * これは、システムエンジニアとしてデータの不変性を保証したい場合に特に有用です。
7 */
8class Product
9{
10    /**
11     * コンストラクタでプロパティを初期化します。
12     * public readonly を使用することで、プロパティが読み取り専用であることを宣言し、
13     * コンストラクタ引数から直接プロパティへの代入を行います (コンストラクタプロパティプロモーション)。
14     *
15     * @param int $id 商品のユニークなID
16     * @param string $name 商品名
17     * @param float $price 商品価格
18     */
19    public function __construct(
20        public readonly int $id,
21        public readonly string $name,
22        public readonly float $price
23    ) {}
24}
25
26/**
27 * XMLReader を使用してXMLファイルから商品データを読み込み、Productオブジェクトの配列として返します。
28 * XMLReader は、大規模なXML文書でもメモリ効率良く処理できるストリームパーサです。
29 *
30 * @param string $xmlFilePath 読み込むXMLファイルのパス。
31 * @return Product[] 読み込んだProductオブジェクトの配列。
32 * @throws RuntimeException XMLファイルのオープンに失敗した場合。
33 */
34function readProductsFromXml(string $xmlFilePath): array
35{
36    // XMLReader オブジェクトを初期化します。
37    $reader = new XMLReader();
38
39    // XMLファイルをオープンします。ファイルが存在しない、または読み取り権限がない場合は失敗します。
40    if (!$reader->open($xmlFilePath)) {
41        throw new RuntimeException("Failed to open XML file: " . $xmlFilePath);
42    }
43
44    $products = []; // 最終的に返されるProductオブジェクトの配列
45    $currentProductData = []; // 現在処理中の<item>要素のデータを一時的に保持
46
47    // XML文書をノードごとに読み進めます。
48    // XMLReader::read() は次のノードに移動し、成功した場合は true、それ以上ノードがない場合は false を返します。
49    while ($reader->read()) {
50        switch ($reader->nodeType) {
51            case XMLReader::ELEMENT: // 開始タグ（例: <item>、<name>、<price>）の場合
52                if ($reader->name === 'item') {
53                    // <item>要素に到達した場合、その'id'属性を読み込みます。
54                    $currentProductData = ['id' => (int)$reader->getAttribute('id')];
55                } elseif ($reader->name === 'name' && !empty($currentProductData)) {
56                    // <name>要素に到達した場合、そのテキストコンテンツを読み込むために次のノードへ進みます。
57                    $reader->read(); // 次のノード（テキストノード）へ移動
58                    if ($reader->nodeType === XMLReader::TEXT) {
59                        $currentProductData['name'] = $reader->value;
60                    }
61                } elseif ($reader->name === 'price' && !empty($currentProductData)) {
62                    // <price>要素に到達した場合、そのテキストコンテンツを読み込むために次のノードへ進みます。
63                    $reader->read(); // 次のノード（テキストノード）へ移動
64                    if ($reader->nodeType === XMLReader::TEXT) {
65                        $currentProductData['price'] = (float)$reader->value;
66                    }
67                }
68                break;
69
70            case XMLReader::END_ELEMENT: // 終了タグ（例: </item>）の場合
71                if ($reader->name === 'item' &&
72                    isset($currentProductData['id'], $currentProductData['name'], $currentProductData['price'])) {
73                    // </item>要素に到達し、必要なすべてのデータが揃っている場合、Productオブジェクトを生成します。
74                    // ここで生成されるProductインスタンスのプロパティはreadonlyなので、後から変更されることはありません。
75                    $products[] = new Product(
76                        $currentProductData['id'],
77                        $currentProductData['name'],
78                        $currentProductData['price']
79                    );
80                    $currentProductData = []; // 次のアイテムのために一時データをリセット
81                }
82                break;
83        }
84    }
85
86    // XMLReaderリソースを解放します。
87    $reader->close();
88
89    return $products;
90}
91
92// -----------------------------------------------------------------------------
93// サンプルコードの実行
94// -----------------------------------------------------------------------------
95
96// 読み込むXMLコンテンツを定義します。
97$xmlContent = <<<XML
98<data>
99    <item id="1">
100        <name>Widget A</name>
101        <price>19.99</price>
102    </item>
103    <item id="2">
104        <name>Gadget B</name>
105        <price>45.50</price>
106    </item>
107    <item id="3">
108        <name>Doodad C</name>
109        <price>12.00</price>
110    </item>
111</data>
112XML;
113
114// 一時ファイルにXMLコンテンツを書き込みます。
115$tempXmlFile = tempnam(sys_get_temp_dir(), 'xml_example');
116file_put_contents($tempXmlFile, $xmlContent);
117
118try {
119    echo "XMLファイルから商品データを読み込み中...\n";
120
121    // 定義した関数を使用してXMLファイルから商品を読み込みます。
122    $products = readProductsFromXml($tempXmlFile);
123
124    echo "読み込まれた商品:\n";
125    foreach ($products as $product) {
126        // Productオブジェクトのreadonlyプロパティにアクセスします。
127        // これらのプロパティは一度設定されると変更できないため、データの整合性が保たれます。
128        echo "  ID: {$product->id}, Name: {$product->name}, Price: {$product->price}\n";
129    }
130
131    // readonlyプロパティは変更できません。以下のコードは致命的なエラーになります。
132    // echo "\nreadonlyプロパティの変更を試みます (これはエラーになります):\n";
133    // $products[0]->id = 999;
134
135} catch (RuntimeException $e) {
136    echo "エラーが発生しました: " . $e->getMessage() . "\n";
137} finally {
138    // 使用した一時ファイルを削除し、クリーンアップします。
139    if (file_exists($tempXmlFile)) {
140        unlink($tempXmlFile);
141        echo "\n一時ファイルをクリーンアップしました。\n";
142    }
143}
144
145?>

このPHPサンプルコードは、XMLReaderクラスとreadonlyプロパティを活用し、XMLファイルから商品データを安全に読み込む方法を示します。XMLReaderは、特に大規模なXMLファイルをメモリ効率良く処理するためのストリームパーサです。

コードの中心となるXMLReader::read()メソッドは、XML文書を次のノードに移動させ、読み込みが成功した場合はtrueを、文書の終わりに達した場合はfalseを返します。このメソッドは引数を取らず、whileループと組み合わせることでXML文書全体をノード単位で効率的に処理できます。

また、ProductクラスではPHP 8.1以降で導入されたreadonlyプロパティが使用されています。readonlyプロパティは、一度コンストラクタで初期化されると、その後の値の変更を一切許可しない「読み取り専用」のプロパティを定義します。これにより、商品のID、名前、価格といった重要なデータが読み込み後に誤って変更されることを防ぎ、システム全体のデータの不変性と信頼性を保証します。システムエンジニアとして、データの整合性を維持し、予期せぬ変更を防ぎたい場合に非常に役立つ機能です。サンプルでは、XMLReader::read()で抽出したデータをreadonlyプロパティを持つProductオブジェクトとして格納しています。