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

Copy
1<?php
2
3/**
4 * SimpleXMLElement オブジェクトを生成し、asXML() メソッドで XML 文字列を取得後、
5 * DOMDocument を使用して XML を整形（pretty print）して出力するサンプルコードです。
6 *
7 * SimpleXMLElement の asXML() メソッド自体には XML を整形する機能はありませんが、
8 * 一度取得した XML 文字列を DOMDocument で処理することで整形が可能です。
9 *
10 * @link https://www.php.net/manual/ja/simplexmlelement.asxml.php
11 */
12
13// 1. SimpleXMLElement オブジェクトを生成
14//    ここでは、簡単なXML構造を作成します。
15$xml = new SimpleXMLElement('<root/>');
16$item = $xml->addChild('item');
17$item->addAttribute('id', '123');
18$item->addChild('name', 'サンプル商品');
19$item->addChild('price', '99.99');
20$item->addChild('description', 'これはテスト用の商品説明です。長い文章が含まれるかもしれません。');
21
22// 2. SimpleXMLElement::asXML() を使って XML 文字列を取得
23//    引数を省略すると、XML オブジェクトの内容が文字列として返されます。
24//    この時点では、XML は整形されていません（改行やインデントがない一行形式）。
25$rawXmlString = $xml->asXML();
26
27// asXML() が失敗した場合の基本的なエラーハンドリング
28if ($rawXmlString === false) {
29    echo "エラー: XML 文字列の取得に失敗しました。\n";
30    exit(1); // スクリプトを終了
31}
32
33// 整形されていないXMLを参考として出力
34echo "--- 整形されていない XML (SimpleXMLElement::asXML() の直接出力) ---\n";
35echo $rawXmlString;
36echo "\n\n"; // 視認性向上のための改行
37
38// 3. DOMDocument を利用して XML を整形（pretty print）
39$dom = new DOMDocument('1.0', 'UTF-8');
40
41// formatOutput を true に設定することで、DOMDocument が出力時にXMLを整形します。
42$dom->formatOutput = true;
43// preserveWhiteSpace を false に設定すると、DOMDocument が自動的に空白を処理し、
44// formatOutput と組み合わせてより綺麗な整形結果が得られやすくなります。
45$dom->preserveWhiteSpace = false;
46
47// 4. asXML() で取得した XML 文字列を DOMDocument にロード
48//    ロードに成功すると true が返されます。
49if (!$dom->loadXML($rawXmlString)) {
50    echo "エラー: XML 文字列の DOMDocument へのロードに失敗しました。\n";
51    exit(1); // スクリプトを終了
52}
53
54// 5. DOMDocument::saveXML() を使って整形された XML 文字列を取得
55//    saveXML() は、整形されたXML文字列を返します。
56$prettyXmlString = $dom->saveXML();
57
58// saveXML() が失敗した場合の基本的なエラーハンドリング
59if ($prettyXmlString === false) {
60    echo "エラー: 整形された XML 文字列の取得に失敗しました。\n";
61    exit(1); // スクリプトを終了
62}
63
64// 6. 整形された XML を出力
65echo "--- 整形された XML (asXML() + DOMDocument::saveXML()) ---\n";
66echo $prettyXmlString;
67echo "\n";
68
69// 参考: asXML() を使って直接ファイルに保存する場合
70// この例では、pretty printの主要な目的から外れるためコメントアウトしますが、
71// ファイルに保存する基本的な使用例として利用できます。
72/*
73$filename = 'output.xml';
74if ($xml->asXML($filename)) {
75    echo "XMLがファイル '{$filename}' に保存されました。\n";
76} else {
77    echo "XMLのファイル保存に失敗しました。\n";
78}
79// 必要であれば、unlink($filename); でファイルを削除できます。
80*/
81
82?>

SimpleXMLElement::asXML()メソッドは、PHPでXMLデータを扱うSimpleXMLElementオブジェクトの現在の内容をXML文字列として取得したり、指定したファイルに保存したりするためのメソッドです。引数$filenameを省略した場合、XMLオブジェクトの内容が文字列として返され、成功時にはstring、失敗時にはfalseが戻り値となります。引数にファイルパスを指定すると、XMLがそのファイルに保存され、成功時にはtrue、失敗時にはfalseが返されます。

このサンプルコードでは、まずSimpleXMLElementで簡単なXML構造を構築します。次に、asXML()メソッドを使ってこのオブジェクトからXML文字列を取得しますが、この時点ではXMLは整形されていません。asXML()メソッド自体にはXMLを整形（pretty print）する機能がないため、通常は改行やインデントのない一行形式のXMLが生成されます。そこで、取得した整形されていないXML文字列をDOMDocumentオブジェクトにロードし、$dom->formatOutput = true;を設定することでXMLを整形します。最後に、DOMDocument::saveXML()メソッドを使用して、整形された読みやすい形式のXML文字列として出力しています。

Copy
1<?php
2
3/**
4 * SimpleXMLElement::asXML() メソッドの使用例を示します。
5 * このメソッドは、SimpleXMLElement オブジェクトを XML 文字列として取得したり、
6 * 指定したファイルに XML データを保存したりするために使用されます。
7 */
8function demonstrateSimpleXmlAsXml(): void
9{
10    // 1. 新しい SimpleXMLElement オブジェクトを作成します。
11    // ルート要素名 'bookstore' を持つXML構造を構築します。
12    $xml = new SimpleXMLElement('<bookstore></bookstore>');
13
14    // 2. XML 要素と属性を追加します。
15    // addChild() で子要素を追加し、addAttribute() で属性を追加します。
16    $book = $xml->addChild('book');
17    $book->addAttribute('category', 'cooking');
18    $book->addChild('title', 'Everyday Italian');
19    $book->addChild('author', 'Giada De Laurentiis');
20    $book->addChild('year', '2005');
21    $book->addChild('price', '30.00');
22
23    // 3. SimpleXMLElement オブジェクトから XML 文字列を取得します。
24    // asXML() メソッドを引数なしで呼び出すと、XML データが文字列として返されます。
25    // 失敗した場合は false が返されます。
26    $xmlString = $xml->asXML();
27
28    if ($xmlString !== false) {
29        echo "--- 生成されたXML文字列 ---\n";
30        // Webブラウザで表示する際に特殊文字が適切に表示されるようにエスケープします。
31        echo htmlspecialchars($xmlString);
32        echo "\n\n";
33    } else {
34        echo "XML文字列の生成に失敗しました。\n";
35    }
36
37    // 4. (オプション) XML データをファイルに保存します。
38    // asXML() メソッドにファイル名を指定すると、XML データがそのファイルに書き込まれます。
39    // 成功した場合は true、失敗した場合は false が返されます。
40    // (PHP 8 のリファレンスでは戻り値の型が string|false と記載されていますが、
41    // ファイル書き込み成功時は bool(true) が返されるのが一般的な動作です。)
42    $filename = 'output.xml';
43    $fileWrittenSuccessfully = $xml->asXML($filename);
44
45    if ($fileWrittenSuccessfully !== false) {
46        echo "--- XMLデータをファイルに保存 ---\n";
47        echo "XMLデータは '{$filename}' に正常に保存されました。\n";
48        // ファイルの内容を確認したい場合は、以下のコメントアウトを解除してください (開発環境でのみ推奨)。
49        // echo "\nファイル内容:\n";
50        // echo htmlspecialchars(file_get_contents($filename));
51
52        // サンプル実行後に作成されたファイルを削除します。
53        // 実運用ではファイルの削除は状況に応じて判断してください。
54        if (file_exists($filename)) {
55            unlink($filename);
56            echo "作成されたファイル '{$filename}' を削除しました。\n";
57        }
58    } else {
59        echo "XMLデータの '{$filename}' への保存に失敗しました。\n";
60    }
61}
62
63// 関数の実行
64demonstrateSimpleXmlAsXml();
65
66?>

PHP 8のSimpleXMLElement::asXML()メソッドは、SimpleXMLElementオブジェクトで表現されているXMLデータを、XML文字列として取得したり、ファイルに保存したりするためのメソッドです。

このメソッドを引数なしで呼び出すと、オブジェクト内のXMLデータが文字列として返されます。XML文字列の生成に失敗した場合はfalseが戻り値となります。サンプルコードでは、まず新しいSimpleXMLElementオブジェクトを作成し、addChild()やaddAttribute()を使って書籍情報をXML構造として追加しています。その後、引数なしのasXML()を呼び出すことで、構築したXMLデータを整形された文字列として画面に出力しています。

また、asXML()メソッドにファイル名を文字列として引数で指定すると、XMLデータはその指定されたファイルに保存されます。ファイルへの書き込みが成功した場合は、通常はファイル名などの文字列が返されるか、あるいはtrueと評価される値が返され、失敗した場合はfalseが戻り値となります。サンプルコードの後半では、output.xmlというファイル名を指定してXMLデータを保存し、その結果も確認しています。このメソッドを利用することで、PHPで動的に生成したXMLデータをアプリケーション内で利用したり、外部ファイルとして出力したりすることが容易になります。