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

Copy
1<?php
2
3/**
4 * SimpleXMLIterator::addChild メソッドの使用例を示します。
5 * この関数は、既存のXML要素に新しい子要素を追加する方法を初心者向けに解説します。
6 *
7 * SimpleXMLIterator は SimpleXMLElement を継承しており、addChild メソッドの挙動は SimpleXMLElement と同じです。
8 */
9function exampleAddChildToXml(): void
10{
11    // 1. ルート要素を持つ SimpleXMLIterator オブジェクトを作成します。
12    // SimpleXMLIterator はイテレーション機能を提供しますが、addChild は SimpleXMLElement の機能です。
13    $xmlIterator = new SimpleXMLIterator('<library/>');
14
15    // 2. ルート要素に最初のレベルの子要素 'book' を追加します。
16    // addChild(string $qualifiedName, ?string $value = null, ?string $namespace = null)
17    // addChild メソッドは、追加された子要素を表す SimpleXMLElement インスタンスを返します。
18    $book1 = $xmlIterator->addChild('book');
19
20    // 3. 追加された子要素 ($book1) に、さらに子要素を追加します。
21    $book1->addChild('title', 'PHP Basics for SE Beginners');
22    $book1->addChild('author', 'John Doe');
23    $book1->addChild('year', '2023');
24
25    // 4. 別の 'book' 要素を追加し、その中にさらに子要素を追加します。
26    $book2 = $xmlIterator->addChild('book');
27    $book2->addChild('title', 'Advanced PHP Techniques');
28    $book2->addChild('author', 'Jane Smith');
29    $book2->addChild('year', '2024');
30
31    // 5. 更新されたXMLを出力します。
32    // SimpleXMLIterator オブジェクトは直接 asXML() メソッドを持ちません。
33    // そのため、DOMDocument に変換してから整形して出力します。
34    $dom = dom_import_simplexml($xmlIterator)->ownerDocument;
35    $dom->formatOutput = true; // 出力を読みやすく整形します
36    echo $dom->saveXML();
37}
38
39// 上記の関数を実行して、生成されたXMLを確認します。
40exampleAddChildToXml();
41

PHPのSimpleXMLIterator::addChildメソッドは、既存のXML要素に新しい子要素を追加するために使用します。このメソッドは、SimpleXMLElementクラスが提供する機能と同じであり、指定した名前の子要素を追加できます。

第一引数には追加する子要素の名前を文字列で指定し、第二引数にはその子要素のテキスト値をオプションで指定できます。必要に応じて、第三引数で名前空間も指定可能です。このメソッドは、新しく追加された子要素を表すSimpleXMLElementのインスタンスを返します。この戻り値を利用することで、追加した子要素に対してさらにaddChildメソッドを呼び出し、階層的なXML構造を容易に構築できます。

サンプルコードでは、まず<library/>というルート要素を持つXMLを初期化し、addChildメソッドを使って<book>要素を追加しています。戻り値として得られた<book>要素に対して、さらにaddChildを使用し、<title>、<author>、<year>といった子要素を追加することで、XMLの構造を深くしていきます。このように、addChildメソッドを繰り返し使うことで、柔軟にXMLデータを構築できます。最終的に構築されたXMLは、SimpleXMLIteratorオブジェクトからDOMDocumentオブジェクトへ変換し、formatOutputオプションを有効にした上で、整形された形で出力されます。

Copy
1<?php
2
3/**
4 * SimpleXMLIterator クラスを使用して XML ドキュメントを構築し、
5 * 子要素を追加する基本的な例を示します。
6 *
7 * SimpleXMLIterator は SimpleXMLElement を継承しており、XML構造を
8 * イテレート（繰り返し処理）する機能に加え、SimpleXMLElement と同じ
9 * メソッド（addChild など）を提供します。
10 */
11function createXmlWithChildren(): void
12{
13    // <root/> という名前の空のルート要素を持つ SimpleXMLIterator インスタンスを作成します。
14    // SimpleXMLIterator は、XML文字列またはファイルパスから直接インスタンス化できます。
15    $xmlIterator = new SimpleXMLIterator('<root/>');
16
17    // 'item' という名前の子要素を 'root' 要素に追加します。
18    // addChild メソッドは、新しく追加された子要素の SimpleXMLElement インスタンスを返します。
19    // このインスタンスを使って、さらに子要素や属性を追加できます。
20    $item1 = $xmlIterator->addChild('item');
21
22    // 'item1' の中に 'name' と 'price' という子要素を追加します。
23    // 第二引数で要素の値を指定できます。
24    $item1->addChild('name', 'Apple');
25    $item1->addChild('price', '1.00');
26
27    // 別の 'item' 子要素を追加します。
28    $item2 = $xmlIterator->addChild('item');
29    $item2->addChild('name', 'Banana');
30    $item2->addChild('price', '0.75');
31
32    // 名前空間を指定して子要素を追加する例。
33    // 第三引数で名前空間URIを指定します。
34    // ここでは、'info' という名前の子要素を 'root' に追加し、特定のアドレスを名前空間とします。
35    $infoElement = $xmlIterator->addChild('info', null, 'http://example.com/ns/product');
36    $infoElement->addChild('version', '1.0', 'http://example.com/ns/product');
37    $infoElement->addChild('date', date('Y-m-d'), 'http://example.com/ns/product');
38
39    // 生成されたXMLドキュメントを文字列として出力します。
40    // SimpleXMLIterator は SimpleXMLElement を継承しているため、asXML() メソッドを使用できます。
41    echo $xmlIterator->asXML();
42}
43
44// 関数を実行してサンプルコードの出力を確認します。
45createXmlWithChildren();

PHPのSimpleXMLIteratorクラスが提供するaddChildメソッドは、既存のXML要素に新しい子要素を追加するために使用されます。SimpleXMLIteratorはSimpleXMLElementを継承しているため、XML構造を操作する強力な機能と、XMLを繰り返し処理する機能を兼ね備えています。

このメソッドは主に3つの引数を取ります。最初の$qualifiedNameは、追加する子要素の名前を文字列で指定する必須の引数です。二番目の$valueは、新しく追加する子要素のテキスト内容を文字列で指定します。これは省略可能で、指定しない場合はテキスト内容が空の要素が作成されます。三番目の$namespaceは、子要素に適用する名前空間のURIを文字列で指定します。これも省略可能で、特定のアドレスを名前空間として明示的に指定したい場合に利用します。

addChildメソッドの戻り値は、新しく追加された子要素自身を表すSimpleXMLElementのインスタンスです。この戻り値を利用することで、さらにその子要素に対してaddChildを呼び出したり、属性を追加したりすることが可能になり、効率的に階層的なXML構造を構築できます。

サンプルコードでは、まず<root/>要素を持つSimpleXMLIteratorインスタンスを作成し、$xmlIterator->addChild('item')のように呼び出してroot要素の下にitem子要素を追加しています。このとき返される$item1などの変数を通じて、さらにnameやpriceといった子要素を追加しています。また、$xmlIterator->addChild('info', null, 'http://example.com/ns/product')のように第三引数にURIを指定することで、名前空間を持つ子要素を追加する方法も示されています。このようにして構築されたXMLドキュメントは、最終的にasXML()メソッドで文字列として出力されます。