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

Copy
1<?php
2
3/**
4 * XMLWriter を使用してインデントされたXML文字列を生成するサンプル関数。
5 *
6 * この関数は XMLWriter::setIndent() メソッドの動作を示します。
7 * setIndent(true) を使用すると、出力されるXMLが自動的に整形（インデント）され、
8 * 人間が読みやすくなります。これは、php-cs-fixer がPHPコードを整形するのと同様に、
9 * XMLの可読性を高める機能です。
10 *
11 * @param bool $enableIndent XML出力のインデントを有効にするかどうか。
12 * @return string 生成されたXML文字列。
13 */
14function createIndentedXml(bool $enableIndent): string
15{
16    $writer = new XMLWriter();
17    // メモリに出力するように設定。ファイルに出力する場合は openURI() を使用します。
18    $writer->openMemory();
19    
20    // setIndent() を使用してXMLのインデントを有効/無効にします。
21    // true を渡すと、要素の階層構造に応じて自動的にインデントと改行が追加されます。
22    // false を渡すと、インデントや改行は追加されず、XMLは一行で出力されます。
23    $writer->setIndent($enableIndent);
24    
25    // インデントを有効にした場合、setIndentString() でインデントに使う文字を指定できます。
26    // デフォルトはスペース2つです。
27    // $writer->setIndentString('    '); // スペース4つにする例
28
29    // XML ドキュメントを開始します (XML宣言: <?xml version="1.0" encoding="UTF-8"?>)
30    $writer->startDocument('1.0', 'UTF-8');
31
32    // ルート要素 '<data>' を開始します
33    $writer->startElement('data');
34    
35    // 最初の '<item>' 要素を追加します
36    $writer->startElement('item');
37    $writer->writeAttribute('id', '1'); // 属性 'id="1"' を追加
38    $writer->writeElement('name', 'Sample Item A'); // '<name>Sample Item A</name>' を追加
39    $writer->writeElement('value', '100'); // '<value>100</value>' を追加
40    $writer->endElement(); // '<item>' 要素を終了
41
42    // 2番目の '<item>' 要素を追加します
43    $writer->startElement('item');
44    $writer->writeAttribute('id', '2');
45    $writer->writeElement('name', 'Sample Item B');
46    $writer->writeElement('value', '200');
47    $writer->endElement(); // '<item>' 要素を終了
48
49    // ルート要素 '<data>' を終了します
50    $writer->endElement(); // data
51
52    // XML ドキュメントを終了します
53    $writer->endDocument();
54
55    // 生成されたXML文字列を取得して返します
56    return $writer->outputMemory();
57}
58
59// -----------------------------------------------------------------------------
60// サンプルコードの実行部分
61// -----------------------------------------------------------------------------
62
63echo "--- インデントが有効なXML ---" . PHP_EOL;
64// インデントを有効にしてXMLを生成します
65$indentedXml = createIndentedXml(true);
66echo $indentedXml . PHP_EOL . PHP_EOL;
67
68echo "--- インデントが無効なXML ---" . PHP_EOL;
69// インデントを無効にしてXMLを生成します
70$nonIndentedXml = createIndentedXml(false);
71echo $nonIndentedXml . PHP_EOL;
72

XMLWriter::setIndentメソッドは、PHPでXML文書を作成する際に、出力されるXMLの可読性を高めるためにインデント（字下げ）と改行を自動的に追加するかどうかを設定します。

このメソッドの引数であるbool $enableには、インデントを有効にする場合はtrueを、無効にする場合はfalseを指定します。trueを設定すると、生成されるXMLは要素の階層構造に応じて自動的に整形され、人間が読みやすい形式になります。これは、php-cs-fixerがPHPコードを整形して可読性を向上させるのと同様に、XMLの視覚的な整理を助ける機能です。falseを設定すると、インデントや改行は追加されず、XMLはスペースを削減したコンパクトな一行形式で出力されます。

戻り値はbool型で、通常は設定が成功したことを示すtrueが返されます。

サンプルコードでは、createIndentedXml関数内でsetIndent()メソッドを使用し、trueを渡した場合とfalseを渡した場合のXML出力の違いを具体的に示しています。これにより、開発時やデバッグ時には整形された読みやすいXMLを、通信時などサイズが重要な場合にはコンパクトなXMLを出力するといった使い分けが可能です。