【PHP8.x】xmlwriter_write_dtd_entity関数の使い方
『xmlwriter_write_dtd_entity関数は…を実行する関数です』
xmlwriter_write_dtd_entity関数は、XML文書のDTD(文書型定義)内に、完全なエンティティタグを書き込む処理を実行する関数です。DTDにおけるエンティティとは、頻繁に使用する文字列や外部ファイルの内容などに短い名前を付けて、文書内で繰り返し利用可能にするための仕組みです。この関数を使用することで、プログラムによって動的にDTDを生成する際に、様々な種類のエンティティ宣言を追加できます。
関数の引数には、対象となるXMLWriterリソース、エンティティの名前、そしてエンティティの内容を指定します。内容を指定した場合は内部エンティティが定義されます。さらに、オプションの引数を用いることで、パラメータエンティティ(DTD内でのみ使用されるエンティティ)として定義したり、公開識別子やシステム識別子を指定して外部ファイルを参照する外部エンティティを定義したりすることも可能です。
この関数は、xmlwriter_start_dtd
関数とxmlwriter_end_dtd
関数の間で呼び出す必要があります。処理が成功した場合はtrue
を、失敗した場合はfalse
を返します。
基本的な使い方
構文(syntax)
1xmlwriter_write_dtd_entity($writer, "name", "content", false, "publicId", "systemId", "notationData");
引数(parameters)
XMLWriter $writer, string $name, string $content, bool $isParam = false, ?string $publicId = null, ?string $systemId = null, ?string $notationData = null
- XMLWriter $writer: 出力対象となるXMLWriterオブジェクト
- string $name: エンティティ名を指定する文字列
- string $content: エンティティの値を指定する文字列
- bool $isParam = false: パラメータエンティティの場合はtrueを指定するブール値
- ?string $publicId = null: 公開識別子を指定する文字列。未指定の場合はnull
- ?string $systemId = null: システム識別子を指定する文字列。未指定の場合はnull
- ?string $notationData = null: NOTATION宣言の場合のデータ部分を指定する文字列。未指定の場合はnull
戻り値(return)
bool
この関数は、XML文書にDTDエンティティを書き込むことに成功したかどうかを示す真偽値(trueまたはfalse)を返します。