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

Copy
1<?php
2
3/**
4 * SimpleXMLIterator::addAttribute の使用例
5 * XML要素に新しい属性を追加する方法を示します。
6 * システムエンジニアを目指す初心者の方にも理解しやすいよう、
7 * XMLの読み込みから属性の追加、結果の表示までを簡潔に示します。
8 */
9function demonstrateSimpleXMLIteratorAddAttribute(): void
10{
11    // 既存のXMLデータを文字列として定義します。
12    // SimpleXMLIterator は SimpleXMLElement を継承しており、
13    // XMLをオブジェクトとして直感的に扱えます。
14    $xmlString = <<<XML
15<?xml version="1.0" encoding="UTF-8"?>
16<products>
17    <product>
18        <name>Laptop</name>
19        <price>1200</price>
20    </product>
21    <product>
22        <name>Mouse</name>
23        <price>25</price>
24    </product>
25</products>
26XML;
27
28    echo "--- 属性追加前のXMLデータ ---\n";
29    echo $xmlString . "\n\n";
30
31    // XML文字列から SimpleXMLIterator オブジェクトを作成します。
32    // これにより、XML要素を反復処理（ループで一つずつ処理）できるようになります。
33    try {
34        $xmlIterator = new SimpleXMLIterator($xmlString);
35    } catch (Exception $e) {
36        echo "XMLの読み込みに失敗しました: " . $e->getMessage() . "\n";
37        return;
38    }
39
40    // 各 <product> 要素にアクセスし、新しい属性を追加します。
41    // SimpleXMLIterator はイテレータとして動作するため、
42    // foreach ループで子要素（ここでは <product>）に直接アクセスできます。
43    $productIdCounter = 1;
44    foreach ($xmlIterator->product as $product) {
45        // addAttribute メソッドを使用して、現在の <product> 要素に属性を追加します。
46        // 引数:
47        // 1. $qualifiedName (string): 追加する属性の名前（例: 'id'）
48        // 2. $value (string): 属性の値（例: 'P001'）
49        // 3. $namespace (string, optional): 属性の名前空間URI（今回は使用しないため null）
50        $product->addAttribute('id', 'P' . str_pad($productIdCounter, 3, '0', STR_PAD_LEFT));
51        $productIdCounter++;
52    }
53
54    echo "--- 属性追加後のXMLデータ ---\n";
55    // 変更が加えられたXML全体を文字列として出力します。
56    echo $xmlIterator->asXML() . "\n";
57}
58
59// 関数を実行して、SimpleXMLIterator::addAttribute の動作を確認します。
60demonstrateSimpleXMLIteratorAddAttribute();
61

このサンプルコードは、PHPのSimpleXMLIterator::addAttributeメソッドを使って、XML要素に新しい属性を追加する方法を示しています。まず、既存のXMLデータを文字列として定義し、それをSimpleXMLIteratorオブジェクトとして読み込んでいます。SimpleXMLIteratorは、XMLをオブジェクトとして直感的に扱え、その要素をループで反復処理できる点が特徴です。

コードでは、foreachループを使用して各<product>要素にアクセスし、addAttributeメソッドを呼び出しています。このメソッドは、第一引数に新しい属性の名前（例: 'id'）、第二引数にその属性に設定する値（例: 'P001'）を指定します。第三引数はオプションで属性の名前空間URIを指定できますが、今回の例では使用していません。addAttributeメソッドは戻り値を返しませんが、対象のXML要素に直接属性を追加する操作を行います。

属性が追加された後、$xmlIterator->asXML()メソッドを使って、変更が加えられたXML全体を文字列として出力し、結果を確認しています。このコードを通じて、XMLデータの特定要素にプログラムから属性を追加する一連の流れを、初心者の方にも分かりやすく簡潔に理解していただけるよう構成されています。