【PHP8.x】XMLWriter::writeElement()メソッドの使い方
writeElementメソッドの使い方について、初心者にもわかりやすく解説します。
作成日: 更新日:
基本的な使い方
writeElementメソッドは、XMLWriterクラスに属し、XML文書内に要素を書き出すことを実行するメソッドです。
このメソッドは、XML作成時、指定の名前の要素(開始タグと終了タグ)とその間に記述するテキスト内容をまとめて書き出します。第一引数には作成したい要素の名前(タグ名)を文字列で指定し、第二引数にはその要素に含めるテキスト内容を文字列でオプションとして指定します。内容が省略された場合、空の要素が出力されます。
writeElementメソッドを使用することで、XML要素の開始タグ、内容、終了タグを個別に記述する手間が省け、コードの記述量を削減し、XML生成処理の効率を高め、可読性を向上させます。属性を持たずテキストデータのみのシンプルなXML要素生成に特に有用です。処理が正常に完了した場合は true を、失敗した場合は false を返します。
構文(syntax)
1<?php 2 3$writer = new XMLWriter(); 4$writer->openMemory(); 5$writer->startDocument('1.0', 'UTF-8'); 6$writer->writeElement('elementName', 'elementContent'); 7$writer->endDocument(); 8echo $writer->outputMemory(); 9 10?>
引数(parameters)
string $name, ?string $content = null
- string $name: 作成するXML要素の名前を指定する文字列
- ?string $content = null: 要素のコンテンツとして含める文字列。省略可能で、省略した場合は空の要素が作成されます。
戻り値(return)
bool
XMLWriter::writeElementメソッドは、指定した名前でXML要素を書き込むことに成功した場合はTRUEを、失敗した場合はFALSEを返します。