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

Copy
1<?php
2
3/**
4 * 画像情報をXML属性として出力する関数。
5 *
6 * XMLWriter::writeAttribute メソッドを使用して、画像のメタデータを
7 * <image> 要素の属性として書き込みます。
8 *
9 * @param string $filename 画像のファイル名。
10 * @param string $format 画像のフォーマット (例: "jpeg", "png")。
11 * @param int $width 画像の幅 (ピクセル)。
12 * @param int $height 画像の高さ (ピクセル)。
13 * @return string 生成されたXML文字列。
14 */
15function generateImageXmlAttributes(string $filename, string $format, int $width, int $height): string
16{
17    // XMLWriterインスタンスを作成
18    $xmlWriter = new XMLWriter();
19
20    // 出力先をメモリに設定（ファイルに書き出す場合は openURI() を使用）
21    $xmlWriter->openMemory();
22
23    // XML宣言を開始 (バージョン1.0, エンコーディングUTF-8)
24    $xmlWriter->startDocument('1.0', 'UTF-8');
25
26    // 生成されるXMLを見やすくするためにインデントを有効にする
27    $xmlWriter->setIndent(true);
28    $xmlWriter->setIndentString('    '); // インデントに使うスペース数
29
30    // ルート要素 <image> を開始
31    $xmlWriter->startElement('image');
32
33    // XMLWriter::writeAttribute メソッドを使って属性を書き込む
34    // 引数は (属性名, 属性値) の形式です。属性値は文字列である必要があります。
35    $xmlWriter->writeAttribute('filename', $filename);
36    $xmlWriter->writeAttribute('format', $format);
37    // int型の幅と高さをstring型にキャストして渡す
38    $xmlWriter->writeAttribute('width', (string)$width);
39    $xmlWriter->writeAttribute('height', (string)$height);
40
41    // ルート要素 <image> を終了
42    $xmlWriter->endElement();
43
44    // XMLドキュメントを終了
45    $xmlWriter->endDocument();
46
47    // メモリバッファから生成されたXML文字列を取得して返す
48    return $xmlWriter->outputMemory();
49}
50
51// --- サンプルコードの実行 ---
52
53// 画像のサンプルデータ
54$imageFilename = 'beautiful_sunset.jpg';
55$imageFormat = 'jpeg';
56$imageWidth = 1920;
57$imageHeight = 1080;
58
59// 関数を呼び出してXMLを生成
60$generatedXml = generateImageXmlAttributes($imageFilename, $imageFormat, $imageWidth, $imageHeight);
61
62// 生成されたXMLを出力
63echo "--- Generated XML ---" . PHP_EOL;
64echo $generatedXml;
65echo "---------------------" . PHP_EOL;
66
67// 別の画像データで試す
68$anotherImageFilename = 'company_logo.png';
69$anotherImageFormat = 'png';
70$anotherImageWidth = 250;
71$anotherImageHeight = 100;
72
73$anotherGeneratedXml = generateImageXmlAttributes($anotherImageFilename, $anotherImageFormat, $anotherImageWidth, $anotherImageHeight);
74
75echo PHP_EOL . "--- Another Generated XML ---" . PHP_EOL;
76echo $anotherGeneratedXml;
77echo "-----------------------------" . PHP_EOL;
78
79?>

XMLWriter::writeAttributeは、PHPのXMLWriterクラスに属するメソッドで、XMLドキュメントの要素に属性を追加するために使用されます。このメソッドは、XMLファイルをプログラムで生成する際に、要素が持つ詳細な情報（メタデータなど）を属性として記述するのに役立ちます。

引数には、一つ目に属性の「名前」を文字列（string）で、二つ目に属性の「値」を文字列（string）で指定します。例えば、<image src="path/to/image.jpg"/>というXMLがあった場合、srcが属性の名前、path/to/image.jpgがその属性の値にあたります。属性値が数値型であっても、このメソッドに渡す際には必ず文字列に変換する必要があります。戻り値は、属性の書き込みが成功したかどうかを示す真偽値（bool）で、通常は成功時にtrueが返されます。

サンプルコードでは、画像ファイルのメタデータ（ファイル名、形式、幅、高さ）をXML形式で出力する例を通して、writeAttributeメソッドの具体的な使い方を示しています。XMLWriterインスタンスを作成し、startElementで<image>要素を開始した後、writeAttributeメソッドを複数回呼び出して、filename、format、width、heightといった属性とその値をimage要素に追加しています。特に、画像の幅や高さを示すwidthとheightは整数値ですが、writeAttributeメソッドの仕様に合わせて(string)と記述して文字列型にキャストしている点がポイントです。これにより、画像情報が属性として含まれたXML文字列が効率的に生成されます。

Copy
1<?php
2
3/**
4 * XMLWriter クラスを使用して、要素に属性を書き込むサンプル関数。
5 *
6 * この関数は、XMLWriter を使用してシンプルな XML ドキュメントを生成し、
7 * その中の要素に 'writeAttribute' メソッドで属性を追加する方法を示します。
8 *
9 * @return string 生成された XML 文字列。
10 */
11function createXmlWithAttributes(): string
12{
13    // XMLWriter オブジェクトを新規作成
14    $writer = new XMLWriter();
15
16    // 出力先をメモリに設定（ファイルに保存する場合は openURI() を使用）
17    $writer->openMemory();
18
19    // XML ドキュメントの開始宣言 (バージョンとエンコーディング)
20    $writer->startDocument('1.0', 'UTF-8');
21    
22    // ルート要素を開始
23    $writer->startElement('products');
24
25    // 'product' 要素を開始
26    $writer->startElement('product');
27    
28    // 'id' 属性を書き込む
29    // 引数1: 属性の名前, 引数2: 属性の値
30    if ($writer->writeAttribute('id', 'PROD001')) {
31        // 属性が正常に書き込まれた場合の処理（任意）
32    }
33
34    // 'category' 属性を書き込む
35    if ($writer->writeAttribute('category', 'Electronics')) {
36        // 属性が正常に書き込まれた場合の処理（任意）
37    }
38
39    // 要素の内容を書き込む
40    $writer->writeElement('name', 'Smartphone');
41    $writer->writeElement('price', '599.99');
42
43    // 'product' 要素を閉じる
44    $writer->endElement(); 
45
46    // 別の 'product' 要素と属性を追加する例
47    $writer->startElement('product');
48    $writer->writeAttribute('id', 'PROD002');
49    $writer->writeAttribute('category', 'Books');
50    $writer->writeElement('name', 'PHP Programming Guide');
51    $writer->writeElement('price', '34.50');
52    $writer->endElement();
53
54    // ルート要素を閉じる
55    $writer->endElement();
56
57    // XML ドキュメントの終了
58    $writer->endDocument();
59
60    // 生成された XML を文字列として取得して返す
61    return $writer->flush(true);
62}
63
64// 関数を実行し、生成された XML を出力
65echo createXmlWithAttributes();
66

このサンプルコードは、PHPのXMLWriterクラスを利用してXMLドキュメントを効率的に生成し、その中に要素の属性を書き込む方法を示しています。特に、XMLWriter::writeAttributeメソッドの具体的な使用例に焦点を当てています。

XMLWriterクラスは、XMLドキュメントをプログラム上で作成するためのツールで、メモリ上にXMLを構築できます。まずnew XMLWriter()でオブジェクトを生成し、openMemory()で出力先をメモリに設定します。その後、startDocument()でXMLの宣言を開始し、startElement()でXML要素を定義します。

writeAttributeメソッドは、現在開いている要素に対して属性を追加する際に用います。最初の引数$nameには追加したい属性の名前を文字列で指定し、二番目の引数$valueにはその属性の値を文字列で渡します。例えば、$writer->writeAttribute('id', 'PROD001')とすることで、要素にid="PROD001"という属性が付与されます。このメソッドは属性の書き込みが成功した場合はtrueを、失敗した場合はfalseをブール値として返します。

サンプルでは、product要素を開始した直後にwriteAttributeを呼び出すことで、idやcategoryといった属性を追加しています。要素の内容はwriteElement()で書き込み、endElement()で要素を閉じます。最終的にflush(true)を呼び出すことで、メモリ上に構築されたXMLドキュメント全体が文字列として取得され、出力されます。