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

Copy
1<?php
2
3/**
4 * Demonstrates how to use XMLReader::fromStream() with a PHP memory stream.
5 *
6 * A "PHP stream" is a resource that provides a generic interface to a variety
7 * of I/O operations, such as file access, network connections, data compression,
8 * or in-memory buffers. This allows different sources of data to be handled
9 * consistently.
10 *
11 * This function processes an XML string by first writing it into a 'php://memory'
12 * stream (an in-memory buffer treated like a file), and then uses
13 * XMLReader::fromStream() to parse the XML directly from this stream.
14 * This illustrates how XMLReader can consume XML data from any PHP stream,
15 * not just physical files.
16 */
17function processXmlFromMemoryStream(): void
18{
19    // 1. Define a sample XML string.
20    $xmlString = <<<XML
21<?xml version="1.0" encoding="UTF-8"?>
22<products>
23    <product id="P001">
24        <name>Laptop</name>
25        <price>1200.00</price>
26    </product>
27    <product id="P002">
28        <name>Mouse</name>
29        <price>25.50</price>
30    </product>
31</products>
32XML;
33
34    // 2. Open a 'php://memory' stream. This creates a temporary, in-memory file-like resource.
35    // The 'r+' mode allows both reading and writing to the stream.
36    $stream = fopen('php://memory', 'r+');
37
38    if ($stream === false) {
39        echo "Error: Could not open memory stream.\n";
40        return;
41    }
42
43    // 3. Write the XML string into the memory stream.
44    fwrite($stream, $xmlString);
45
46    // 4. Rewind the stream pointer to the beginning for reading.
47    // This is crucial because writing advances the pointer to the end of the stream.
48    fseek($stream, 0);
49
50    // 5. Create a new XMLReader instance from the stream.
51    // This demonstrates XMLReader::fromStream(), taking a PHP stream resource as its source.
52    $reader = XMLReader::fromStream($stream);
53
54    if ($reader === false) {
55        echo "Error: Could not create XMLReader from stream.\n";
56        fclose($stream); // Ensure the stream is closed even if XMLReader fails
57        return;
58    }
59
60    echo "Processing XML from memory stream:\n";
61
62    // 6. Read through the XML document node by node.
63    while ($reader->read()) {
64        // Only process element nodes for this example.
65        if ($reader->nodeType === XMLReader::ELEMENT) {
66            echo "  Element: <" . $reader->name;
67
68            // Check if the element has attributes and display them.
69            if ($reader->hasAttributes) {
70                echo " (Attributes: ";
71                // Iterate through attributes
72                while ($reader->moveToNextAttribute()) {
73                    echo "{$reader->name}=\"{$reader->value}\" ";
74                }
75                $reader->moveToElement(); // Move cursor back to the element node
76                echo ")";
77            }
78
79            // If the element is not empty, attempt to read its value (e.g., text content).
80            if (!$reader->isEmptyElement) {
81                // Moving to the next node might get us to the text content.
82                // This is a simplified way to extract direct text content.
83                if ($reader->read() && $reader->nodeType === XMLReader::TEXT) {
84                    echo " Value: " . $reader->value;
85                }
86            }
87            echo ">\n";
88        }
89    }
90
91    // 7. Close the XMLReader object to release resources.
92    $reader->close();
93    echo "XMLReader closed.\n";
94
95    // 8. Close the PHP stream resource.
96    fclose($stream);
97    echo "Memory stream closed.\n";
98}
99
100// Execute the demonstration function.
101processXmlFromMemoryStream();

PHPのXMLReader::fromStream()は、指定されたPHPストリームリソースからXMLデータを読み込み、解析するためのメソッドです。PHPストリームとは、ファイルアクセス、ネットワーク接続、インメモリバッファなど、様々な入出力操作を統一的に扱うための仕組みを指します。このメソッドは、ファイルに限らず、どのようなPHPストリームからでもXMLデータを取り扱える点が特徴です。

引数resource $streamには、XMLデータを含むストリームリソースを渡します。オプションでエンコーディングやパーサーのフラグなども指定可能です。処理が成功するとXMLReaderオブジェクトを返し、失敗した場合はfalseを返します。

提供されたサンプルコードでは、まずXML文字列をphp://memoryというメモリ上に存在する仮想的なファイルに書き込みます。fopen()でこのメモリストリームを開き、fwrite()でXMLデータを書き込んだ後、fseek()で読み込みのためにストリームのポインタを先頭に戻すことが重要です。その後、XMLReader::fromStream()にこのメモリストリームリソースを渡すことで、XMLReaderはメモリ上のXMLデータを直接解析できるようになります。read()メソッドでXMLドキュメントのノードを順に読み進め、要素名や属性などを取得して表示しています。処理後は、XMLReaderオブジェクトとストリームリソースの両方を忘れずに閉じる必要があります。これにより、メモリやその他のリソースが適切に解放されます。

Copy
1<?php
2
3/**
4 * Reads XML data from a stream using XMLReader and extracts specific element values as strings.
5 *
6 * This function demonstrates how to use XMLReader::fromStream() to parse XML
7 * from a resource stream incrementally without loading the entire document into memory.
8 * It also illustrates how to extract the text content of elements into PHP strings,
9 * which directly addresses the "php stream to string" concept in the context of XML parsing.
10 *
11 * @return array An array of extracted product names, or an empty array on failure.
12 */
13function readProductNamesFromXmlStream(): array
14{
15    // 1. Prepare sample XML data as a string.
16    // In a real-world scenario, this XML would come from a file (e.g., fopen('data.xml', 'r')),
17    // a network socket, or another resource.
18    $xmlData = <<<XML
19<?xml version="1.0" encoding="UTF-8"?>
20<products>
21    <product id="P001">
22        <name>Laptop Pro</name>
23        <price>1200.00</price>
24        <currency>USD</currency>
25    </product>
26    <product id="P002">
27        <name>Wireless Mouse</name>
28        <price>25.50</price>
29        <currency>USD</currency>
30    </product>
31    <product id="P003">
32        <name>USB-C Hub</name>
33        <price>45.00</price>
34        <currency>USD</currency>
35    </product>
36</products>
37XML;
38
39    // 2. Create an in-memory stream from the XML string.
40    // 'php://memory' is a convenient wrapper for creating a temporary stream in RAM.
41    $stream = fopen('php://memory', 'r+');
42    if ($stream === false) {
43        error_log('Failed to create in-memory stream.');
44        return [];
45    }
46
47    // Write the XML data to the stream and then rewind it to the beginning for reading.
48    fwrite($stream, $xmlData);
49    fseek($stream, 0);
50
51    $reader = new XMLReader();
52    $productNames = [];
53
54    try {
55        // 3. Initialize XMLReader from the stream resource.
56        // XMLReader::fromStream() allows parsing without loading the entire document,
57        // which is efficient for large XML files.
58        if (!$reader->fromStream($stream)) {
59            error_log('Failed to open XML stream with XMLReader.');
60            return [];
61        }
62
63        // 4. Iterate through the XML document node by node.
64        while ($reader->read()) {
65            // Check if the current node is an element and has the name 'name'.
66            if ($reader->nodeType === XMLReader::ELEMENT && $reader->name === 'name') {
67                // Use readString() to extract the entire text content of the current element
68                // as a PHP string. This directly demonstrates converting XML content from
69                // the stream into a usable string.
70                $productNames[] = $reader->readString();
71            }
72        }
73    } finally {
74        // 5. Ensure XMLReader and the stream are closed to release resources.
75        $reader->close();
76        fclose($stream);
77    }
78
79    return $productNames;
80}
81
82// 6. Demonstrate the function usage.
83$names = readProductNamesFromXmlStream();
84
85if (!empty($names)) {
86    echo "Successfully extracted product names:\n";
87    foreach ($names as $name) {
88        echo "- " . $name . "\n";
89    }
90} else {
91    echo "Could not extract any product names.\n";
92}

このPHPサンプルコードは、XMLReaderクラスのfromStreamメソッドを使って、ストリーム（連続したデータ源）からXMLデータを効率的に読み込み、特定の要素の値をPHPの文字列として抽出する方法を示しています。

XMLReader::fromStreamメソッドは、ファイルやネットワーク接続などのリソースストリームからXMLドキュメントを読み込む際に使用されます。これは、特に巨大なXMLファイルを扱う場合に、ドキュメント全体をメモリにロードせずに段階的に処理できるため、メモリ使用量を抑えることができる利点があります。引数としてXMLデータを含むresource $streamを受け取り、XMLの読み込みに成功すればXMLReaderインスタンスを、失敗すればfalseを返します。

サンプルコードでは、まずPHPのメモリ上に一時的なストリームを作成し、そこにサンプルXMLデータを書き込んでいます。次に、XMLReaderの新しいインスタンスを作成し、fromStreamメソッドを使ってこのメモリ上のストリームからXMLを読み込み始めます。while ($reader->read())ループでXMLノードを一つずつ進み、nodeTypeとnameプロパティでnameという要素ノードを検出します。その際、$reader->readString()メソッドを使用することで、XMLストリーム内にあるname要素のテキストコンテンツをPHPの文字列として直接抽出し、配列に格納しています。これにより、「php stream to string」という概念が、XML解析の文脈でどのように実現されるかが具体的に示されています。最後に、XMLReaderとストリームを閉じ、リソースを解放することが重要です。この手順により、メモリ効率の良いXML解析とデータ抽出が実現されます。