php-doc-en/reference/xmlwriter/functions/xmlwriter-write-dtd-entity.xml
Christoph Michael Becker 44d5d33cee Generate xmlwriter methodsynopses based on stubs
Based on a patch contributed by Máté Kocsis <kocsismate@woohoolabs.com>.


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@351471 c90b9560-bf6c-de11-be94-00142212c4b1
2020-11-21 16:50:36 +00:00

123 lines
4.3 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. -->
<refentry xml:id="function.xmlwriter-write-dtd-entity" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>XMLWriter::writeDtdEntity</refname>
<refname>xmlwriter_write_dtd_entity</refname>
<refpurpose>Write full DTD Entity tag</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>&style.oop;</para>
<methodsynopsis role="oop">
<modifier>public</modifier> <type>bool</type><methodname>XMLWriter::writeDtdEntity</methodname>
<methodparam><type>string</type><parameter>name</parameter></methodparam>
<methodparam><type>string</type><parameter>content</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>isParam</parameter><initializer>&false;</initializer></methodparam>
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>publicId</parameter><initializer>&null;</initializer></methodparam>
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>systemId</parameter><initializer>&null;</initializer></methodparam>
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>notationData</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>&style.procedural;</para>
<methodsynopsis role="procedural">
<type>bool</type><methodname>xmlwriter_write_dtd_entity</methodname>
<methodparam><type>XMLWriter</type><parameter>writer</parameter></methodparam>
<methodparam><type>string</type><parameter>name</parameter></methodparam>
<methodparam><type>string</type><parameter>content</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>isParam</parameter><initializer>&false;</initializer></methodparam>
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>publicId</parameter><initializer>&null;</initializer></methodparam>
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>systemId</parameter><initializer>&null;</initializer></methodparam>
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>notationData</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
Writes a full DTD entity.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
&xmlwriter.xmlwriter.description;
<varlistentry>
<term><parameter>name</parameter></term>
<listitem>
<para>
The name of the entity.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>content</parameter></term>
<listitem>
<para>
The content of the entity.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
&xmlwriter.changelog.writer-param;
<row>
<entry>8.0.0</entry>
<entry>
<parameter>publicId</parameter>, <parameter>systemId</parameter> and
<parameter>notationData</parameter> are nullable now.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>XMLWriter::startDtdEntity</methodname></member>
<member><methodname>XMLWriter::endDtdEntity</methodname></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->