【PHP8.x】xmlwriter_start_dtd_entity関数の使い方
作成日: 更新日:
『xmlwriter_start_dtd_entity関数は、XML文書のDTD（文書型定義）内におけるエンティティ宣言を開始するために実行する関数です。エンティティとは、特定の文字列や外部ファイルなどを参照するための名前付きの入れ物のようなもので、DTD内で定義することで文書中で繰り返し利用できます。この関数は、第一引数にXMLWriterオブジェクト、第二引数にエンティティの名前を文字列で指定します。第三引数には、そのエンティティが一般エンティティかパラメータエンティティかを真偽値で指定します。trueを指定すると、DTD内部でのみ使用されるパラメータエンティティ（例: <!ENTITY % name ...）として、falseを指定するか省略すると、XML文書本体で使用される一般エンティティ（例: <!ENTITY name ...）として宣言が開始されます。この関数を呼び出した後、エンティティの内容を定義し、最後にxmlwriter_end_dtd_entity()関数を呼び出して宣言を完了させる必要があります。処理が成功した場合はtrueを、失敗した場合はfalseを返します。
基本的な使い方
構文(syntax)
1xmlwriter_start_dtd_entity(XMLWriter $writer, string $name, bool $is_parameter): bool
引数(parameters)
XMLWriter $writer, string $name, bool $isParam
- XMLWriter $writer: XML文書を構築するためのXMLWriterオブジェクト
- string $name: DTDエンティティの名前
- bool $isParam: TRUEを指定するとパラメータエンティティとして、FALSEを指定すると汎用エンティティとして扱います
戻り値(return)
bool
この関数は、DTDエンティティの開始をXMLライターに指示します。処理が成功した場合はTRUEを、失敗した場合はFALSEを返します。