【PHP8.x】xmlwriter_write_dtd_attlist関数の使い方
作成日: 更新日:
『xmlwriter_write_dtd_attlist関数は、XML文書の構造を定義するDTD(文書型定義)の一部である、属性リスト宣言(ATTLIST)を書き込む処理を実行する関数です。この関数は、XMLWriter拡張機能を用いてプログラム的にXMLを生成する過程で使用されます。DTDにおける属性リスト宣言とは、特定のXML要素がどのような属性を持つことができるかを定義するためのルールです。この関数を使用することで、指定した要素に対して、属性の名前、型、デフォルト値などを定義する<!ATTLIST ...>
という宣言文を現在のXML出力ストリームに追加します。関数の第1引数には操作対象のXMLWriterオブジェクトを、第2引数には属性を定義したい要素の名前を文字列で指定します。第3引数には、属性の定義内容そのものを文字列として渡します。この関数は、DTDの定義ブロック内、つまりxmlwriter_start_dtd
関数とxmlwriter_end_dtd
関数の間で呼び出す必要があります。処理が成功した場合にはtrue
を、失敗した場合にはfalse
を返します。
基本的な使い方
構文(syntax)
1<?php 2 3$writer = xmlwriter_open_memory(); 4xmlwriter_set_indent($writer, true); 5 6xmlwriter_start_document($writer, '1.0', 'UTF-8'); 7xmlwriter_start_dtd($writer, 'myroot', null, 'example.dtd'); 8 9xmlwriter_write_dtd_attlist($writer, 'myroot', 'id CDATA #REQUIRED'); 10 11xmlwriter_end_dtd($writer); 12xmlwriter_end_document($writer); 13 14echo xmlwriter_output_memory($writer); 15 16?>
引数(parameters)
XMLWriter $writer, string $name, string $content
- XMLWriter $writer: XML文書を書き込むためのXMLWriterオブジェクト
- string $name: DTDの属性リストが関連付けられる要素の名前
- string $content: DTDの属性リストの内容
戻り値(return)
bool
XML文書にDOCTYPE宣言のattlist情報を書き込むことに成功した場合はTRUEを、失敗した場合はFALSEを返します。