【PHP8.x】XMLReader::ATTRIBUTE定数の使い方

Copy
1<?php
2
3/**
4 * XMLReader を使用してXMLドキュメントから属性を取得し表示する関数。
5 *
6 * この関数は、XML ドキュメントを順次読み込み、
7 * ノードタイプが XMLReader::ATTRIBUTE である場合に、
8 * その属性の名前と値を「getter」のように取得して出力します。
9 */
10function getAndDisplayXmlAttributes(): void
11{
12    // サンプルとなるXMLデータ
13    $xmlString = <<<XML
14<bookstore>
15    <book category="cooking" id="bk101">
16        <title lang="en">Everyday Italian</title>
17        <author>Giada De Laurentiis</author>
18        <year>2005</year>
19        <price>30.00</price>
20    </book>
21    <book category="children" id="bk102">
22        <title lang="en">Harry Potter</title>
23        <author>J.K. Rowling</author>
24        <year>2005</year>
25        <price>29.99</price>
26    </book>
27</bookstore>
28XML;
29
30    // XMLReader オブジェクトを作成
31    $reader = new XMLReader();
32
33    // XML文字列を読み込む
34    if (!$reader->XML($xmlString)) {
35        echo "Error: Failed to load XML string.\n";
36        return;
37    }
38
39    echo "--- XML Attributes Found ---\n";
40
41    // XMLドキュメントをノードごとに読み進める
42    while ($reader->read()) {
43        // 現在のノードが属性ノードであるかチェックする
44        // XMLReader::ATTRIBUTE 定数は属性ノードのタイプを表す整数値です
45        if ($reader->nodeType === XMLReader::ATTRIBUTE) {
46            // 属性ノードの場合、その名前と値を取得して表示
47            // これは実質的に属性値の「getter」として機能します
48            echo "Attribute Name: " . $reader->name . ", Value: " . $reader->value . "\n";
49        }
50    }
51
52    // XMLReader を閉じる
53    $reader->close();
54
55    echo "--------------------------\n";
56}
57
58// 関数を実行して属性を取得・表示
59getAndDisplayXmlAttributes();
60

このサンプルコードは、PHPのXMLReader拡張機能を利用し、XMLドキュメントの中から属性情報（アトリビュート）を効率的に抽出し、その内容を表示する関数です。XMLReaderは、XMLデータをノード単位で順次読み込むことで、メモリ負荷を抑えながら大きなXMLファイルも処理できる点が特徴です。

コードでは、まずサンプルXMLデータを定義し、XMLReaderオブジェクトを作成してそのデータを読み込みます。次に、while ($reader->read())ループを使ってXMLドキュメント内の各ノードを一つずつ読み進めます。

ループ内で重要なのが、if ($reader->nodeType === XMLReader::ATTRIBUTE)という条件分岐です。ここで使用されているXMLReader::ATTRIBUTEは、XMLReaderクラスが持つ定数であり、現在のノードが「属性ノード」であることを示す特定の整数値です。この定数自体は引数を取らず、戻り値として属性ノードのタイプを表す整数型（int）の値を返します。これにより、XML中の様々なノードの中から、目的の属性ノードだけを正確に識別することができます。

属性ノードが検出された場合、$reader->nameと$reader->valueというプロパティを通じて、その属性の名前と値をそれぞれ取得し、表示しています。これらのプロパティは、オブジェクトの内部情報である属性値を外部から読み取る「getter」のような役割を果たし、XMLドキュメントに含まれる属性情報を手軽に取得・利用することを可能にします。

Copy
1<?php
2
3/**
4 * XMLファイルから属性ノードを読み取り、その情報を表示する関数。
5 *
6 * この関数は、XMLReaderを使用してXMLドキュメントを順次読み込み、
7 * 読み込んだノードが属性ノードである場合に、その名前と値を表示します。
8 *
9 * @param string $xmlFilePath 読み込むXMLファイルのパス。
10 */
11function readXmlAttributes(string $xmlFilePath): void
12{
13    // XMLReader オブジェクトを初期化します。
14    $reader = new XMLReader();
15
16    // 指定されたXMLファイルをオープンします。
17    if (!$reader->open($xmlFilePath)) {
18        echo "エラー: XMLファイル '{$xmlFilePath}' を開けませんでした。" . PHP_EOL;
19        return;
20    }
21
22    echo "XMLファイル '{$xmlFilePath}' から属性ノードを探索します..." . PHP_EOL;
23
24    // ファイルの最後までノードを順に読み進めます。
25    while ($reader->read()) {
26        // 現在のノードが属性ノードであるかチェックします。
27        // XMLReader::ATTRIBUTE は、ノードタイプがXML_ATTRIBUTE_NODE（属性）であることを示す定数です。
28        // 補足: これはPHP 8で導入された言語機能の「Attributes (アトリビュート)」とは異なります。
29        // XMLReader::ATTRIBUTE はXMLドキュメント内の要素に付随する「属性」を指します。
30        if ($reader->nodeType === XMLReader::ATTRIBUTE) {
31            echo "属性ノードが見つかりました:" . PHP_EOL;
32            echo "  名前: " . $reader->name . PHP_EOL;  // 属性の名前（例: "category", "id"）
33            echo "  値: " . $reader->value . PHP_EOL; // 属性の値（例: "cooking", "bk101"）
34        }
35    }
36
37    // リーダーをクローズし、リソースを解放します。
38    $reader->close();
39    echo "XMLファイルの読み取りが完了しました。" . PHP_EOL;
40}
41
42// サンプルとして使用するXMLファイルの内容を定義します。
43$xmlContent = <<<XML
44<?xml version="1.0" encoding="UTF-8"?>
45<bookstore>
46    <book category="cooking" id="bk101">
47        <title lang="en">Everyday Italian</title>
48        <author>Giada De Laurentiis</author>
49        <year>2005</year>
50        <price>30.00</price>
51    </book>
52    <book category="children" id="bk102">
53        <title lang="en">Harry Potter</title>
54        <author>J.K. Rowling</author>
55        <year>2005</year>
56        <price>29.99</price>
57    </book>
58</bookstore>
59XML;
60
61// 一時的なXMLファイルを作成します。
62$tempXmlFile = 'example_attributes.xml';
63if (file_put_contents($tempXmlFile, $xmlContent) === false) {
64    echo "エラー: 一時XMLファイルの作成に失敗しました。" . PHP_EOL;
65    exit(1);
66}
67
68// 作成した一時XMLファイルを使用して関数を実行します。
69readXmlAttributes($tempXmlFile);
70
71// 処理完了後、一時ファイルを削除します（オプション）。
72if (file_exists($tempXmlFile)) {
73    unlink($tempXmlFile);
74}

このPHPサンプルコードは、XMLReaderクラスを利用してXMLファイルの中から「属性ノード」を読み取り、その情報を表示する手順を解説しています。

readXmlAttributes関数は、読み込むXMLファイルのパスを引数$xmlFilePathとして受け取ります。この引数は、処理対象となるXMLファイルを指定する文字列です。関数内部では、XMLReaderオブジェクトが指定されたXMLファイルをオープンし、ファイルを順次読み進めます。

while ($reader->read())ループの中で、各ノードのタイプがXMLReader::ATTRIBUTE定数と一致するかどうかをチェックします。XMLReader::ATTRIBUTEは、現在処理しているノードがXMLドキュメント内の要素に付随する「属性」であることを示す定数です。例えば、<item id="123">というXML要素の場合、id="123"の部分が属性に該当します。この定数は、PHP 8で導入された言語機能としての「Attributes（アトリビュート）」とは異なり、XMLのデータ構造における属性を指します。

属性ノードが検出されると、$reader->nameで属性の名前を、$reader->valueで属性の値をそれぞれ取得し、画面に表示します。この関数は、処理結果を画面に出力する役割を果たし、特定の値を返さないため、戻り値はvoidと宣言されています。コードの後半では、一時的なXMLファイルを作成し、この関数を実行後、ファイルを削除する一連の動作例が示されています。