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

Copy
1<?php
2
3/**
4 * XMLデータを読み取り専用で処理するクラスの例です。
5 * XMLReaderインスタンスをreadonlyプロパティとして持ち、
6 * そのreadStringメソッドを使用してXMLコンテンツを抽出します。
7 *
8 * システムエンジニアを目指す初心者の方へ:
9 * - XMLReaderはXMLファイルを効率的に読み込むためのPHPの組み込みクラスです。
10 * - readonlyプロパティはPHP 8.1で導入され、一度初期化されると変更できないプロパティを宣言します。
11 *   これにより、このクラスがXMLデータを「読み取り専用」で扱うという意図を明確にできます。
12 * - readString()メソッドは、現在のXMLノード（要素やテキストノード）のコンテンツを文字列として取得します。
13 */
14class ReadonlyXmlProcessor
15{
16    /**
17     * XMLReaderインスタンスを読み取り専用プロパティとして保持します。
18     * このプロパティは、コンストラクタで一度設定されると、その後は変更できません。
19     * 外部からの誤った変更を防ぎ、データが読み取り専用であることを保証します。
20     *
21     * @param readonly XMLReader $reader XMLReaderのインスタンス
22     */
23    public function __construct(
24        private readonly XMLReader $reader
25    ) {}
26
27    /**
28     * 指定されたXML文字列から特定の要素の内容を読み取り、抽出します。
29     *
30     * @param string $xmlString 処理するXMLデータ文字列
31     * @return array<string> 抽出された文字列の配列、またはエラーの場合は空の配列
32     */
33    public function processXml(string $xmlString): array
34    {
35        // XMLReaderにXML文字列をロードします。失敗した場合は処理を中断します。
36        if (!$this->reader->xml($xmlString)) {
37            // エラーが発生した場合、メッセージを出力し、空の配列を返します。
38            echo "エラー: XMLデータのロードに失敗しました。\n";
39            return [];
40        }
41
42        $extractedContents = [];
43
44        // XMLドキュメントの各ノードを順に読み進めます。
45        // read()メソッドは、次のノードに移動し、成功すればtrueを返します。
46        while ($this->reader->read()) {
47            // 現在のノードが要素（例: <tag>）であるかをチェックします。
48            if ($this->reader->nodeType === XMLReader::ELEMENT) {
49                // 特定の要素名（例: "item"）の要素を見つけた場合、その内容を読み取ります。
50                if ($this->reader->name === 'item') {
51                    // readString()メソッドは、現在の要素の開始タグから終了タグまでの内容を文字列として読み取ります。
52                    // 例えば、<item>Hello</item>であれば "Hello" が返されます。
53                    // このメソッドを呼び出すと、XMLReaderの内部ポインタは自動的に現在の要素の終了タグの次へ進みます。
54                    $content = $this->reader->readString();
55
56                    // readString()がfalseを返さない限り（読み取り成功）、結果に追加します。
57                    if ($content !== false) {
58                        $extractedContents[] = $content;
59                    }
60                }
61            }
62        }
63
64        // XMLReaderリソースを閉じ、メモリを解放します。
65        $this->reader->close();
66
67        return $extractedContents;
68    }
69}
70
71// --- サンプルコードの実行部分 ---
72
73// 処理対象となるXMLデータを用意します。
74$xmlData = <<<XML
75<root>
76    <item>PHP</item>
77    <item>XMLReader</item>
78    <data>
79        <value>バージョン8</value>
80    </data>
81    <item>readonlyプロパティ</item>
82</root>
83XML;
84
85// ReadonlyXmlProcessorのインスタンスを作成します。
86// コンストラクタで新しいXMLReaderインスタンスを渡し、readonlyプロパティとして設定します。
87$processor = new ReadonlyXmlProcessor(new XMLReader());
88
89// XMLデータを処理し、結果を取得します。
90$results = $processor->processXml($xmlData);
91
92// 抽出された文字列を表示します。
93if (!empty($results)) {
94    echo "XMLから抽出された 'item' 要素の内容:\n";
95    foreach ($results as $string) {
96        echo "- " . $string . "\n";
97    }
98} else {
99    echo "指定されたXMLデータから 'item' 要素の内容は抽出されませんでした。\n";
100}
101
102?>

このPHPコードは、XMLReaderクラスとPHP 8.1以降で利用可能なreadonlyプロパティを活用し、XMLデータから特定の要素の内容を効率的に読み取る方法を解説しています。XMLReaderは、XMLファイルをストリーム形式で読み込むための組み込みクラスで、大規模なXMLデータでもメモリを節約しながら処理できるのが特徴です。

サンプルコードでは、ReadonlyXmlProcessorクラスがXMLReaderのインスタンスをreadonlyプロパティとして保持しています。このreadonlyキーワードは、一度コンストラクタで設定されたXMLReaderインスタンスが、その後は変更されず、常に読み取り専用の目的で使用されることを保証し、プログラムの信頼性を高めます。

特に重要なXMLReader::readString()メソッドは、現在のXMLノードのコンテンツを文字列として取得する役割を担っています。このメソッドは引数なしで呼び出され、成功した場合はノードの文字列コンテンツを、失敗した場合はfalseを返します。例えば、<tag>内容</tag>という要素の開始タグでこのメソッドを呼び出すと、「内容」という文字列が取得され、同時にXMLReaderの内部ポインタは自動的にこの要素の終了タグの次へと移動します。これにより、サンプルコードでは<item>要素の中身だけを抽出し、配列として収集しています。この仕組みは、特定のXMLコンテンツを安全かつ効率的に抽出する際に非常に役立ちます。

Copy
1<?php
2
3/**
4 * XMLReaderクラスのreadStringメソッドの使用例を示します。
5 * readStringは、現在のノード（特に要素ノード）のテキストコンテンツを読み取り、文字列として返します。
6 * これは、大きなXMLドキュメントから必要な情報を効率的に抽出する際に役立ちます。
7 *
8 * @param string $xmlContent 処理するXML文字列。
9 */
10function demonstrateXmlReaderReadString(string $xmlContent): void
11{
12    // XMLReaderのインスタンスを作成します。
13    // これは、XMLドキュメントを順次（ストリームとして）読み込むためのオブジェクトです。
14    $reader = new XMLReader();
15
16    // XML文字列をロードします。
17    // ファイルから読み込む場合は $reader->open('ファイルパス'); を使用します。
18    if (!$reader->XML($xmlContent)) {
19        echo "エラー: XML文字列のロードに失敗しました。\n";
20        return;
21    }
22
23    echo "XMLコンテンツから書籍情報（タイトルと著者）を読み取ります。\n\n";
24
25    // ドキュメント内の各ノードを順に読み進めます。
26    // read() メソッドは次のノードに移動し、成功すれば true、ドキュメントの終わりに達すれば false を返します。
27    while ($reader->read()) {
28        // 現在のノードが要素（開始タグ、例: <title>）である場合に注目します。
29        if ($reader->nodeType === XMLReader::ELEMENT) {
30            // ノード名が 'title' または 'author' の場合に処理します。
31            if ($reader->name === 'title') {
32                // readString() メソッドを呼び出すと、現在の要素（<title>）のテキストコンテンツを読み込みます。
33                // 例えば、<title>Everyday Italian</title> から "Everyday Italian" を取得します。
34                // 読み取り後、リーダーは自動的にこの要素の終了タグを越えて次のノードに進みます。
35                // これにより、手動でテキストノードや終了タグを処理する必要がなくなります。
36                $title = $reader->readString();
37                if ($title !== false && $title !== '') {
38                    echo "  タイトル: " . $title . "\n";
39                }
40            } elseif ($reader->name === 'author') {
41                $author = $reader->readString();
42                if ($author !== false && $author !== '') {
43                    echo "  著者: " . $author . "\n";
44                }
45            }
46        }
47    }
48
49    // XMLReaderを使い終わったら、close() メソッドでリソースを解放します。
50    $reader->close();
51    echo "\nXMLコンテンツの読み取りが完了しました。\n";
52}
53
54// サンプルXMLデータ。書籍のタイトルや著者名などのテキストコンテンツが含まれています。
55$sampleXml = <<<XML
56<bookstore>
57    <book category="cooking">
58        <title lang="en">Everyday Italian</title>
59        <author>Giada De Laurentiis</author>
60        <year>2005</year>
61        <price>30.00</price>
62    </book>
63    <book category="web">
64        <title lang="en">Learning XML</title>
65        <author>Erik T. Ray</author>
66        <year>2003</year>
67        <price>39.95</price>
68        <description>A comprehensive guide to XML basics.</description>
69    </book>
70    <book category="fiction">
71        <title lang="jp">風の歌を聴け</title>
72        <author>村上春樹</author>
73        <year>1979</year>
74        <price>800</price>
75    </book>
76</bookstore>
77XML;
78
79// 定義した関数を実行し、XMLコンテンツから文字列（書籍のタイトルと著者）を読み取ります。
80demonstrateXmlReaderReadString($sampleXml);

PHP 8のXMLReaderクラスが提供するreadStringメソッドは、XMLドキュメント内の現在のノードからテキストコンテンツを効率的に読み取るためのメソッドです。このメソッドは引数を取りません。

サンプルコードでは、XML形式の書籍情報からタイトルや著者名といったテキストデータを抽出する例を示しています。XMLReaderはXMLドキュメントを順次（ストリームとして）読み進めるためのオブジェクトで、read()メソッドで次のノードに移動します。現在のノードが特定の要素（例えば<title>や<author>）である場合に、その要素の開始タグと終了タグの間に含まれるテキストコンテンツをreadString()メソッドで取得します。例えば、<title>Everyday Italian</title>から「Everyday Italian」という文字列を抽出できます。

readStringメソッドはテキストを読み取った後、自動的に現在の要素の終了タグを越えて次のノードに進むため、手動でテキストノードや終了タグを処理する手間を省き、コードを簡潔に保つことができます。メソッドの戻り値は、読み取ったテキストコンテンツが文字列として返されるか、読み取るべきテキストがない場合はfalseが返されます。これにより、大きなXMLファイルから必要な情報だけを効率的に抽出し、メモリ使用量を抑えながらデータ処理を進めることが可能になります。