【PHP8.x】XMLReader::prefixプロパティの使い方

Copy
1<?php
2
3/**
4 * XML文字列をパースし、プレフィックスを持つ要素ノードの情報を配列として抽出します。
5 *
6 * 各要素ノードについて、プレフィックスが存在する場合、そのプレフィックスとローカル名を結合した文字列を
7 * 配列のキーとし、その要素のローカル名を値として格納します。
8 *
9 * @param string $xmlString 処理するXMLデータを含む文字列。
10 * @return array プレフィックス付き要素の情報を格納した連想配列。
11 *               キーは "プレフィックス:ローカル名" 形式、値は "ローカル名"。
12 */
13function extractPrefixedElementKeys(string $xmlString): array
14{
15    $reader = new XMLReader();
16    // XML文字列をXMLReaderに読み込ませます
17    if (!$reader->xml($xmlString)) {
18        // XMLの読み込みに失敗した場合
19        return [];
20    }
21
22    $resultArray = [];
23
24    // XMLノードを一つずつ読み進めます
25    while ($reader->read()) {
26        // 現在のノードが要素ノード（例: <ns:tag>）であるかを確認します
27        if ($reader->nodeType === XMLReader::ELEMENT) {
28            // ノードに名前空間プレフィックスが存在するかを確認します
29            // XMLReader::prefix は現在のノードのプレフィックスを返します。
30            // プレフィックスがない場合は空文字列を返します。
31            if ($reader->prefix !== '') {
32                // プレフィックスとローカル名を結合して、配列のキーとして使用します。
33                // 例: "ns1:item"
34                $key = $reader->prefix . ':' . $reader->localName;
35                // 配列の値には、要素のローカル名（プレフィックスなしの名前）を格納します。
36                $resultArray[$key] = $reader->localName;
37            }
38        }
39    }
40
41    // XMLReaderを閉じ、リソースを解放します
42    $reader->close();
43
44    return $resultArray;
45}
46
47// サンプルXMLデータ
48// このXMLには、名前空間プレフィックス (ns1:, ns2:) を持つ要素が含まれています。
49$sampleXml = <<<XML
50<root xmlns:ns1="http://example.com/ns1" xmlns:ns2="http://example.com/ns2">
51    <ns1:item id="uniqueId1">
52        <ns2:subItem type="categoryA">Item content</ns2:subItem>
53    </ns1:item>
54    <itemWithoutPrefix>No prefix here</itemWithoutPrefix>
55    <ns1:anotherItem id="uniqueId2"/>
56</root>
57XML;
58
59// 関数を実行し、結果の配列を取得します。
60$prefixedKeysArray = extractPrefixedElementKeys($sampleXml);
61
62// 結果を表示します (例: array('ns1:item' => 'item', 'ns2:subItem' => 'subItem', 'ns1:anotherItem' => 'anotherItem'))
63print_r($prefixedKeysArray);

このサンプルコードは、PHPのXMLReaderクラスを用いてXML文字列を効率的に解析し、名前空間プレフィックスを持つ要素の情報を抽出する方法を示しています。特に、XMLReader::prefixプロパティの具体的な利用例が中心です。

extractPrefixedElementKeys関数は、引数として渡されたXMLデータを含む文字列 $xmlString をXMLReaderに読み込ませ、XMLノードを順番に処理します。各ノードについて、まずそれが要素ノードであるかを確認します。次に、XMLReader::prefixプロパティを利用して、現在の要素に名前空間プレフィックス（例: ns1）が存在するかどうかを判定します。このプロパティは、プレフィックスが存在すればその文字列を、存在しない場合は空文字列を返します。

もしプレフィックスが存在する場合、そのプレフィックスと要素のローカル名（プレフィックスを除いた名前）をコロンで結合した文字列（例: "ns1:item"）を結果の連想配列のキーとして使用し、要素のローカル名を値として配列に格納します。最終的に、この関数はプレフィックスを持つ全ての要素の情報を、指定された形式の連想配列として返します。これにより、大規模なXMLデータから特定の構造を持つ要素を抽出し、整理する作業が容易になります。

Copy
1<?php
2
3/**
4 * XMLからノードのプレフィックスを読み取り、数値部分があればゼロ埋めして表示します。
5 *
6 * この関数は、XMLReader::prefix プロパティの使用例を示しつつ、
7 * キーワード「php prefix number with 0」に関連する処理を組み合わせています。
8 * ここでは、XMLの名前空間プレフィックスに数値を含む特殊なケースを想定し、
9 * その数値部分を抽出して指定桁数にゼロ埋めするデモンストレーションを行います。
10 * `XMLReader::prefix` は、現在のノードの名前空間プレフィックス（例: <ns:element> の 'ns' 部分）を文字列で返します。
11 */
12function processXmlPrefixWithNumberPadding(): void
13{
14    // 処理対象のXMLデータ。プレフィックスに数値が含まれる例を含みます。
15    $xmlString = <<<XML
16<?xml version="1.0" encoding="UTF-8"?>
17<root xmlns:seq01="http://example.com/sequence/01"
18      xmlns:seq10="http://example.com/sequence/10"
19      xmlns:info="http://example.com/info">
20    <seq01:item id="data-1"/>
21    <seq10:item id="data-10"/>
22    <info:message content="Hello"/>
23</root>
24XML;
25
26    $reader = new XMLReader();
27
28    // XML文字列を読み込む
29    if (!$reader->xml($xmlString)) {
30        echo "エラー: XMLの読み込みに失敗しました。\n";
31        return;
32    }
33
34    echo "XMLノードのプレフィックスと、数値部分のゼロ埋め処理:\n";
35
36    // XMLをノードごとに読み進める
37    while ($reader->read()) {
38        // 要素ノードのみを対象とする
39        if ($reader->nodeType === XMLReader::ELEMENT) {
40            $currentPrefix = $reader->prefix;
41
42            // プレフィックスが存在する場合のみ処理を行う
43            if (!empty($currentPrefix)) {
44                echo "  元のプレフィックス: " . $currentPrefix;
45
46                // プレフィックス文字列から数値部分を正規表現で抽出します。
47                // 例: "seq01" から "01" を抽出
48                if (preg_match('/(\d+)/', $currentPrefix, $matches)) {
49                    $number = (int)$matches[1]; // 抽出された数値
50                    
51                    // 抽出した数値を2桁でゼロ埋めします（例: 1 -> "01", 10 -> "10"）
52                    $paddedNumber = sprintf('%02d', $number);
53                    echo ", ゼロ埋めされた数値部分: " . $paddedNumber;
54                }
55                echo "\n";
56            }
57        }
58    }
59
60    // リーダーを閉じる
61    $reader->close();
62}
63
64// 関数を実行して結果を表示します
65processXmlPrefixWithNumberPadding();

XMLReader::prefixプロパティは、XMLドキュメントを読み込む際に、現在処理しているノードの名前空間プレフィックスを取得する際に使用されます。このプロパティは引数を取らず、現在のノードのプレフィックスを文字列（string）で返します。例えば、<ns:item>のような要素があった場合、「ns」という文字列が取得されます。もしプレフィックスがないノードの場合は空文字列が返されます。

このサンプルコードは、XMLReader::prefixプロパティを用いてXMLノードのプレフィックスを読み取り、さらにプレフィックスに数値が含まれる場合に、その数値部分をゼロ埋めして表示する処理を示しています。具体的には、XMLReaderクラスでXMLデータを読み込みながら各ノードを巡回し、要素ノードのプレフィックスを取得します。取得したプレフィックスから正規表現を使って数値部分を抽出し、その数値をsprintf関数で2桁のゼロ埋め形式（例：1を「01」に、10を「10」に）に変換しています。これにより、XMLのプレフィックスに含まれる数値データを特定の書式で整形・表示する一連の流れを学ぶことができます。