sigmasternchen/php-doc-en
1
0
Fork 0
mirror of https://github.com/sigmasternchen/php-doc-en synced 2025-03-16 00:48:54 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Document XMLWriter

Browse source 
# review appreciated :)


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@226186 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Mehdi Achour 2007-01-01 15:23:53 +00:00
parent 94f320d2db
commit 3a4c466537
43 changed files with 1100 additions and 3773 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

109
reference/xmlwriter/functions/xmlwriter-end-attribute.xml
View file

@ -1,122 +1,57 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. -->
<refentry id="function.xmlwriter-end-attribute">
<refnamediv>
<refname>xmlwriter_end_attribute</refname>
<refpurpose>End attribute - returns FALSE on error</refpurpose>
<refname>XMLWriter->endAttribute()</refname>
<refpurpose>End attribute</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>Object oriented style:</para>
<classsynopsis>
<ooclass><classname>XMLWriter</classname></ooclass>
<methodsynopsis>
<type>bool</type><methodname>endAttribute</methodname>
<void/>
</methodsynopsis>
</classsynopsis>
<para>Procedural style:</para>
<methodsynopsis>
<type>bool</type><methodname>xmlwriter_end_attribute</methodname>
<methodparam><type>resource</type><parameter>xmlwriter</parameter></methodparam>
</methodsynopsis>
&warn.undocumented.func;
<para>
Ends the current attribute.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>xmlwriter</parameter></term>
<listitem>
<para>
Its description
</para>
</listitem>
</varlistentry>
&xmlwriter.xmlwriter.description;
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
What the function returns, first on success, then on failure. See
also the &amp;return.success; entity
&return.success;
</para>
</refsect1>
<!-- Use when ERRORS exist
<refsect1 role="errors">
&reftitle.errors;
<para>
When does this function throw E_* level errors, or exceptions?
</para>
</refsect1>
-->
<!-- Use when a CHANGELOG exists
<refsect1 role="changelog">
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>Enter the PHP version of change here</entry>
<entry>Description of change</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
-->
<!-- Use when examples exist
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>A <function>xmlwriter_end_attribute</function> example</title>
<para>
Any text that describes the purpose of the example, or
what goes on in the example should go here (inside the
<example> tag, not out
</para>
<programlisting role="php">
<![CDATA[
<?php
if ($anexample === true) {
echo 'Use the PEAR Coding Standards';
}
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
Use the PEAR Coding Standards
]]>
</screen>
</example>
</para>
</refsect1>
-->
<!-- Use when adding See Also links
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function></function></member>
<member>Or <link linkend="somethingelse">something else</link></member>
<member><xref linkend="function.xmlwriter-start-attribute" /></member>
<member><xref linkend="function.xmlwriter-start-attribute-ns" /></member>
<member><xref linkend="function.xmlwriter-write-attribute" /></member>
<member><xref linkend="function.xmlwriter-write-attribute-ns" /></member>
</simplelist>
</para>
</refsect1>
-->
</refentry>

108
reference/xmlwriter/functions/xmlwriter-end-cdata.xml
View file

@ -1,123 +1,55 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. -->
<refentry id="function.xmlwriter-end-cdata">
<refnamediv>
<refname>xmlwriter_end_cdata</refname>
<refpurpose>End current CDATA - returns FALSE on error</refpurpose>
<refname>XMLWriter->endCData()</refname>
<refpurpose>End current CDATA</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>Object oriented style:</para>
<classsynopsis>
<ooclass><classname>XMLWriter</classname></ooclass>
<methodsynopsis>
<type>bool</type><methodname>endCData</methodname>
<void/>
</methodsynopsis>
</classsynopsis>
<para>Procedural style:</para>
<methodsynopsis>
<type>bool</type><methodname>xmlwriter_end_cdata</methodname>
<methodparam><type>resource</type><parameter>xmlwriter</parameter></methodparam>
</methodsynopsis>
&warn.undocumented.func;
<para>
Ends the current CDATA section.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>xmlwriter</parameter></term>
<listitem>
<para>
Its description
</para>
</listitem>
</varlistentry>
&xmlwriter.xmlwriter.description;
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
What the function returns, first on success, then on failure. See
also the &amp;return.success; entity
&return.success;
</para>
</refsect1>
<!-- Use when ERRORS exist
<refsect1 role="errors">
&reftitle.errors;
<para>
When does this function throw E_* level errors, or exceptions?
</para>
</refsect1>
-->
<!-- Use when a CHANGELOG exists
<refsect1 role="changelog">
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>Enter the PHP version of change here</entry>
<entry>Description of change</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
-->
<!-- Use when examples exist
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>A <function>xmlwriter_end_cdata</function> example</title>
<para>
Any text that describes the purpose of the example, or
what goes on in the example should go here (inside the
<example> tag, not out
</para>
<programlisting role="php">
<![CDATA[
<?php
if ($anexample === true) {
echo 'Use the PEAR Coding Standards';
}
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
Use the PEAR Coding Standards
]]>
</screen>
</example>
</para>
</refsect1>
-->
<!-- Use when adding See Also links
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function></function></member>
<member>Or <link linkend="somethingelse">something else</link></member>
<member><xref linkend="function.xmlwriter-start-cdata" /></member>
<member><xref linkend="function.xmlwriter-write-cdata" /></member>
</simplelist>
</para>
</refsect1>
-->
</refentry>

108
reference/xmlwriter/functions/xmlwriter-end-comment.xml
View file

@ -1,123 +1,55 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. -->
<refentry id="function.xmlwriter-end-comment">
<refnamediv>
<refname>xmlwriter_end_comment</refname>
<refpurpose>Create end comment - returns FALSE on error</refpurpose>
<refname>XMLWriter->endComment()</refname>
<refpurpose>Create end comment</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>Object oriented style:</para>
<classsynopsis>
<ooclass><classname>XMLWriter</classname></ooclass>
<methodsynopsis>
<type>bool</type><methodname>endComment</methodname>
<void/>
</methodsynopsis>
</classsynopsis>
<para>Procedural style:</para>
<methodsynopsis>
<type>bool</type><methodname>xmlwriter_end_comment</methodname>
<methodparam><type>resource</type><parameter>xmlwriter</parameter></methodparam>
</methodsynopsis>
&warn.undocumented.func;
<para>
Ends the current comment.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>xmlwriter</parameter></term>
<listitem>
<para>
Its description
</para>
</listitem>
</varlistentry>
&xmlwriter.xmlwriter.description;
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
What the function returns, first on success, then on failure. See
also the &amp;return.success; entity
&return.success;
</para>
</refsect1>
<!-- Use when ERRORS exist
<refsect1 role="errors">
&reftitle.errors;
<para>
When does this function throw E_* level errors, or exceptions?
</para>
</refsect1>
-->
<!-- Use when a CHANGELOG exists
<refsect1 role="changelog">
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>Enter the PHP version of change here</entry>
<entry>Description of change</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
-->
<!-- Use when examples exist
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>A <function>xmlwriter_end_comment</function> example</title>
<para>
Any text that describes the purpose of the example, or
what goes on in the example should go here (inside the
<example> tag, not out
</para>
<programlisting role="php">
<![CDATA[
<?php
if ($anexample === true) {
echo 'Use the PEAR Coding Standards';
}
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
Use the PEAR Coding Standards
]]>
</screen>
</example>
</para>
</refsect1>
-->
<!-- Use when adding See Also links
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function></function></member>
<member>Or <link linkend="somethingelse">something else</link></member>
<member><xref linkend="function.xmlwriter-start-comment" /></member>
<member><xref linkend="function.xmlwriter-write-comment" /></member>
</simplelist>
</para>
</refsect1>
-->
</refentry>

107
reference/xmlwriter/functions/xmlwriter-end-document.xml
View file

@ -1,123 +1,54 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. -->
<refentry id="function.xmlwriter-end-document">
<refnamediv>
<refname>xmlwriter_end_document</refname>
<refpurpose>End current document - returns FALSE on error</refpurpose>
<refname>XMLWriter->endDocument()</refname>
<refpurpose>End current document</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>Object oriented style:</para>
<classsynopsis>
<ooclass><classname>XMLWriter</classname></ooclass>
<methodsynopsis>
<type>bool</type><methodname>endDocument</methodname>
<void/>
</methodsynopsis>
</classsynopsis>
<para>Procedural style:</para>
<methodsynopsis>
<type>bool</type><methodname>xmlwriter_end_document</methodname>
<methodparam><type>resource</type><parameter>xmlwriter</parameter></methodparam>
</methodsynopsis>
&warn.undocumented.func;
<para>
Ends the current document.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>xmlwriter</parameter></term>
<listitem>
<para>
Its description
</para>
</listitem>
</varlistentry>
&xmlwriter.xmlwriter.description;
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
What the function returns, first on success, then on failure. See
also the &amp;return.success; entity
&return.success;
</para>
</refsect1>
<!-- Use when ERRORS exist
<refsect1 role="errors">
&reftitle.errors;
<para>
When does this function throw E_* level errors, or exceptions?
</para>
</refsect1>
-->
<!-- Use when a CHANGELOG exists
<refsect1 role="changelog">
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>Enter the PHP version of change here</entry>
<entry>Description of change</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
-->
<!-- Use when examples exist
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>A <function>xmlwriter_end_document</function> example</title>
<para>
Any text that describes the purpose of the example, or
what goes on in the example should go here (inside the
<example> tag, not out
</para>
<programlisting role="php">
<![CDATA[
<?php
if ($anexample === true) {
echo 'Use the PEAR Coding Standards';
}
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
Use the PEAR Coding Standards
]]>
</screen>
</example>
</para>
</refsect1>
-->
<!-- Use when adding See Also links
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function></function></member>
<member>Or <link linkend="somethingelse">something else</link></member>
<member><xref linkend="function.xmlwriter-start-document" /></member>
</simplelist>
</para>
</refsect1>
-->
</refentry>

108
reference/xmlwriter/functions/xmlwriter-end-dtd-attlist.xml
View file

@ -1,123 +1,55 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. -->
<refentry id="function.xmlwriter-end-dtd-attlist">
<refnamediv>
<refname>xmlwriter_end_dtd_attlist</refname>
<refpurpose>End current DTD AttList - returns FALSE on error</refpurpose>
<refname>XMLWriter->endDTDAttlist()</refname>
<refpurpose>End current DTD AttList</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>Object oriented style:</para>
<classsynopsis>
<ooclass><classname>XMLWriter</classname></ooclass>
<methodsynopsis>
<type>bool</type><methodname>endDTDAttlist</methodname>
<void/>
</methodsynopsis>
</classsynopsis>
<para>Procedural style:</para>
<methodsynopsis>
<type>bool</type><methodname>xmlwriter_end_dtd_attlist</methodname>
<methodparam><type>resource</type><parameter>xmlwriter</parameter></methodparam>
</methodsynopsis>
&warn.undocumented.func;
<para>
Ends the current DTD attribute list.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>xmlwriter</parameter></term>
<listitem>
<para>
Its description
</para>
</listitem>
</varlistentry>
&xmlwriter.xmlwriter.description;
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
What the function returns, first on success, then on failure. See
also the &amp;return.success; entity
&return.success;
</para>
</refsect1>
<!-- Use when ERRORS exist
<refsect1 role="errors">
&reftitle.errors;
<para>
When does this function throw E_* level errors, or exceptions?
</para>
</refsect1>
-->
<!-- Use when a CHANGELOG exists
<refsect1 role="changelog">
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>Enter the PHP version of change here</entry>
<entry>Description of change</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
-->
<!-- Use when examples exist
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>A <function>xmlwriter_end_dtd_attlist</function> example</title>
<para>
Any text that describes the purpose of the example, or
what goes on in the example should go here (inside the
<example> tag, not out
</para>
<programlisting role="php">
<![CDATA[
<?php
if ($anexample === true) {
echo 'Use the PEAR Coding Standards';
}
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
Use the PEAR Coding Standards
]]>
</screen>
</example>
</para>
</refsect1>
-->
<!-- Use when adding See Also links
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function></function></member>
<member>Or <link linkend="somethingelse">something else</link></member>
<member><xref linkend="function.xmlwriter-start-dtd-attlist" /></member>
<member><xref linkend="function.xmlwriter-write-dtd-attlist" /></member>
</simplelist>
</para>
</refsect1>
-->
</refentry>

108
reference/xmlwriter/functions/xmlwriter-end-dtd-element.xml
View file

@ -1,123 +1,55 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. -->
<refentry id="function.xmlwriter-end-dtd-element">
<refnamediv>
<refname>xmlwriter_end_dtd_element</refname>
<refpurpose>End current DTD element - returns FALSE on error</refpurpose>
<refname>XMLWriter->endDTDElement()</refname>
<refpurpose>End current DTD element</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>Object oriented style:</para>
<classsynopsis>
<ooclass><classname>XMLWriter</classname></ooclass>
<methodsynopsis>
<type>bool</type><methodname>endDTDElement</methodname>
<void/>
</methodsynopsis>
</classsynopsis>
<para>Procedural style:</para>
<methodsynopsis>
<type>bool</type><methodname>xmlwriter_end_dtd_element</methodname>
<methodparam><type>resource</type><parameter>xmlwriter</parameter></methodparam>
</methodsynopsis>
&warn.undocumented.func;
<para>
Ends the current DTD element.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>xmlwriter</parameter></term>
<listitem>
<para>
Its description
</para>
</listitem>
</varlistentry>
&xmlwriter.xmlwriter.description;
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
What the function returns, first on success, then on failure. See
also the &amp;return.success; entity
&return.success;
</para>
</refsect1>
<!-- Use when ERRORS exist
<refsect1 role="errors">
&reftitle.errors;
<para>
When does this function throw E_* level errors, or exceptions?
</para>
</refsect1>
-->
<!-- Use when a CHANGELOG exists
<refsect1 role="changelog">
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>Enter the PHP version of change here</entry>
<entry>Description of change</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
-->
<!-- Use when examples exist
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>A <function>xmlwriter_end_dtd_element</function> example</title>
<para>
Any text that describes the purpose of the example, or
what goes on in the example should go here (inside the
<example> tag, not out
</para>
<programlisting role="php">
<![CDATA[
<?php
if ($anexample === true) {
echo 'Use the PEAR Coding Standards';
}
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
Use the PEAR Coding Standards
]]>
</screen>
</example>
</para>
</refsect1>
-->
<!-- Use when adding See Also links
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function></function></member>
<member>Or <link linkend="somethingelse">something else</link></member>
<member><xref linkend="function.xmlwriter-start-dtd-element" /></member>
<member><xref linkend="function.xmlwriter-write-dtd-element" /></member>
</simplelist>
</para>
</refsect1>
-->
</refentry>

109
reference/xmlwriter/functions/xmlwriter-end-dtd-entity.xml
View file

@ -1,123 +1,54 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. -->
<refentry id="function.xmlwriter-end-dtd-entity">
<refnamediv>
<refname>xmlwriter_end_dtd_entity</refname>
<refpurpose>End current DTD Entity - returns FALSE on error</refpurpose>
<refname>XMLWriter->endDTDEntity()</refname>
<refpurpose>End current DTD Entity</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>Object oriented style:</para>
<classsynopsis>
<ooclass><classname>XMLWriter</classname></ooclass>
<methodsynopsis>
<type>bool</type><methodname>endDTDEntity</methodname>
<void/>
</methodsynopsis>
</classsynopsis>
<para>Procedural style:</para>
<methodsynopsis>
<type>bool</type><methodname>xmlwriter_end_dtd_entity</methodname>
<methodparam><type>resource</type><parameter>xmlwriter</parameter></methodparam>
</methodsynopsis>
&warn.undocumented.func;
<para>
Ends the current DTD entity.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>xmlwriter</parameter></term>
<listitem>
<para>
Its description
</para>
</listitem>
</varlistentry>
&xmlwriter.xmlwriter.description;
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
What the function returns, first on success, then on failure. See
also the &amp;return.success; entity
&return.success;
</para>
</refsect1>
<!-- Use when ERRORS exist
<refsect1 role="errors">
&reftitle.errors;
<para>
When does this function throw E_* level errors, or exceptions?
</para>
</refsect1>
-->
<!-- Use when a CHANGELOG exists
<refsect1 role="changelog">
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>Enter the PHP version of change here</entry>
<entry>Description of change</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
-->
<!-- Use when examples exist
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>A <function>xmlwriter_end_dtd_entity</function> example</title>
<para>
Any text that describes the purpose of the example, or
what goes on in the example should go here (inside the
<example> tag, not out
</para>
<programlisting role="php">
<![CDATA[
<?php
if ($anexample === true) {
echo 'Use the PEAR Coding Standards';
}
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
Use the PEAR Coding Standards
]]>
</screen>
</example>
</para>
</refsect1>
-->
<!-- Use when adding See Also links
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function></function></member>
<member>Or <link linkend="somethingelse">something else</link></member>
<member><xref linkend="function.xmlwriter-start-dtd-entity" /></member>
<member><xref linkend="function.xmlwriter-write-dtd-entity" /></member>
</simplelist>
</para>
</refsect1>
-->
</refentry>

110
reference/xmlwriter/functions/xmlwriter-end-dtd.xml
View file

@ -1,125 +1,57 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. -->
<refentry id="function.xmlwriter-end-dtd">
<refnamediv>
<refname>xmlwriter_end_dtd</refname>
<refpurpose>End current DTD - returns FALSE on error</refpurpose>
<refname>XMLWriter->endDTD()</refname>
<refpurpose>End current DTD</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>Object oriented style:</para>
<classsynopsis>
<ooclass><classname>XMLWriter</classname></ooclass>
<methodsynopsis>
<type>bool</type><methodname>endDTD</methodname>
<void/>
</methodsynopsis>
</classsynopsis>
<para>Procedural style:</para>
<methodsynopsis>
<type>bool</type><methodname>xmlwriter_end_dtd</methodname>
<methodparam><type>resource</type><parameter>xmlwriter</parameter></methodparam>
</methodsynopsis>
&warn.undocumented.func;
<para>
Ends the DTD of the document.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>xmlwriter</parameter></term>
<listitem>
<para>
Its description
</para>
</listitem>
</varlistentry>
&xmlwriter.xmlwriter.description;
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
What the function returns, first on success, then on failure. See
also the &amp;return.success; entity
&return.success;
</para>
</refsect1>
<!-- Use when ERRORS exist
<refsect1 role="errors">
&reftitle.errors;
<para>
When does this function throw E_* level errors, or exceptions?
</para>
</refsect1>
-->
<!-- Use when a CHANGELOG exists
<refsect1 role="changelog">
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>Enter the PHP version of change here</entry>
<entry>Description of change</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
-->
<!-- Use when examples exist
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>A <function>xmlwriter_end_dtd</function> example</title>
<para>
Any text that describes the purpose of the example, or
what goes on in the example should go here (inside the
<example> tag, not out
</para>
<programlisting role="php">
<![CDATA[
<?php
if ($anexample === true) {
echo 'Use the PEAR Coding Standards';
}
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
Use the PEAR Coding Standards
]]>
</screen>
</example>
</para>
</refsect1>
-->
<!-- Use when adding See Also links
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function></function></member>
<member>Or <link linkend="somethingelse">something else</link></member>
<member><xref linkend="function.xmlwriter-start-dtd" /></member>
<member><xref linkend="function.xmlwriter-write-dtd" /></member>
</simplelist>
</para>
</refsect1>
-->
</refentry>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

108
reference/xmlwriter/functions/xmlwriter-end-element.xml
View file

@ -1,123 +1,55 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. -->
<refentry id="function.xmlwriter-end-element">
<refnamediv>
<refname>xmlwriter_end_element</refname>
<refpurpose>End current element - returns FALSE on error</refpurpose>
<refname>XMLWriter->endElement()</refname>
<refpurpose>End current element</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>Object oriented style:</para>
<classsynopsis>
<ooclass><classname>XMLWriter</classname></ooclass>
<methodsynopsis>
<type>bool</type><methodname>endElement</methodname>
<void/>
</methodsynopsis>
</classsynopsis>
<para>Procedural style:</para>
<methodsynopsis>
<type>bool</type><methodname>xmlwriter_end_element</methodname>
<methodparam><type>resource</type><parameter>xmlwriter</parameter></methodparam>
</methodsynopsis>
&warn.undocumented.func;
<para>
Ends the current element.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>xmlwriter</parameter></term>
<listitem>
<para>
Its description
</para>
</listitem>
</varlistentry>
&xmlwriter.xmlwriter.description;
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
What the function returns, first on success, then on failure. See
also the &amp;return.success; entity
&return.success;
</para>
</refsect1>
<!-- Use when ERRORS exist
<refsect1 role="errors">
&reftitle.errors;
<para>
When does this function throw E_* level errors, or exceptions?
</para>
</refsect1>
-->
<!-- Use when a CHANGELOG exists
<refsect1 role="changelog">
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>Enter the PHP version of change here</entry>
<entry>Description of change</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
-->
<!-- Use when examples exist
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>A <function>xmlwriter_end_element</function> example</title>
<para>
Any text that describes the purpose of the example, or
what goes on in the example should go here (inside the
<example> tag, not out
</para>
<programlisting role="php">
<![CDATA[
<?php
if ($anexample === true) {
echo 'Use the PEAR Coding Standards';
}
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
Use the PEAR Coding Standards
]]>
</screen>
</example>
</para>
</refsect1>
-->
<!-- Use when adding See Also links
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function></function></member>
<member>Or <link linkend="somethingelse">something else</link></member>
<member><xref linkend="function.xmlwriter-start-element" /></member>
<member><xref linkend="function.xmlwriter-write-element" /></member>
</simplelist>
</para>
</refsect1>
-->
</refentry>

108
reference/xmlwriter/functions/xmlwriter-end-pi.xml
View file

@ -1,123 +1,55 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. -->
<refentry id="function.xmlwriter-end-pi">
<refnamediv>
<refname>xmlwriter_end_pi</refname>
<refpurpose>End current PI - returns FALSE on error</refpurpose>
<refname>XMLWriter->endPI()</refname>
<refpurpose>End current PI</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>Object oriented style:</para>
<classsynopsis>
<ooclass><classname>XMLWriter</classname></ooclass>
<methodsynopsis>
<type>bool</type><methodname>endPI</methodname>
<void/>
</methodsynopsis>
</classsynopsis>
<para>Procedural style:</para>
<methodsynopsis>
<type>bool</type><methodname>xmlwriter_end_pi</methodname>
<methodparam><type>resource</type><parameter>xmlwriter</parameter></methodparam>
</methodsynopsis>
&warn.undocumented.func;
<para>
Ends the current processing instruction.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>xmlwriter</parameter></term>
<listitem>
<para>
Its description
</para>
</listitem>
</varlistentry>
&xmlwriter.xmlwriter.description;
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
What the function returns, first on success, then on failure. See
also the &amp;return.success; entity
&return.success;
</para>
</refsect1>
<!-- Use when ERRORS exist
<refsect1 role="errors">
&reftitle.errors;
<para>
When does this function throw E_* level errors, or exceptions?
</para>
</refsect1>
-->
<!-- Use when a CHANGELOG exists
<refsect1 role="changelog">
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>Enter the PHP version of change here</entry>
<entry>Description of change</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
-->
<!-- Use when examples exist
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>A <function>xmlwriter_end_pi</function> example</title>
<para>
Any text that describes the purpose of the example, or
what goes on in the example should go here (inside the
<example> tag, not out
</para>
<programlisting role="php">
<![CDATA[
<?php
if ($anexample === true) {
echo 'Use the PEAR Coding Standards';
}
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
Use the PEAR Coding Standards
]]>
</screen>
</example>
</para>
</refsect1>
-->
<!-- Use when adding See Also links
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function></function></member>
<member>Or <link linkend="somethingelse">something else</link></member>
<member><xref linkend="function.xmlwriter-start-pi" /></member>
<member><xref linkend="function.xmlwriter-write-pi" /></member>
</simplelist>
</para>
</refsect1>
-->
</refentry>

119
reference/xmlwriter/functions/xmlwriter-flush.xml
View file

@ -1,133 +1,58 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. -->
<refentry id="function.xmlwriter-flush">
<refnamediv>
<refname>xmlwriter_flush</refname>
<refpurpose>Output current buffer</refpurpose>
<refname>XMLWriter->flush()</refname>
<refpurpose>Flush current buffer</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>Object oriented style:</para>
<classsynopsis>
<ooclass><classname>XMLWriter</classname></ooclass>
<methodsynopsis>
<type>mixed</type><methodname>flush</methodname>
<methodparam choice="opt"><type>bool</type><parameter>empty</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<para>Procedural style:</para>
<methodsynopsis>
<type>mixed</type><methodname>xmlwriter_flush</methodname>
<methodparam><type>resource</type><parameter>xmlwriter</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>empty</parameter></methodparam>
</methodsynopsis>
&warn.undocumented.func;
<para>
Flushes the current buffer.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>xmlwriter</parameter></term>
<listitem>
<para>
Its description
</para>
</listitem>
</varlistentry>
&xmlwriter.xmlwriter.description;
<varlistentry>
<term><parameter>empty</parameter></term>
<listitem>
<para>
Its description
Whether to empty the buffer or no. Default is &true;.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
What the function returns, first on success, then on failure. See
also the &amp;return.success; entity
If you opened the writer in memory, this function returns the generated XML buffer,
Else, if using URI, this function will write the buffer and return the number of
written bytes.
</para>
</refsect1>
<!-- Use when ERRORS exist
<refsect1 role="errors">
&reftitle.errors;
<para>
When does this function throw E_* level errors, or exceptions?
</para>
</refsect1>
-->
<!-- Use when a CHANGELOG exists
<refsect1 role="changelog">
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>Enter the PHP version of change here</entry>
<entry>Description of change</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
-->
<!-- Use when examples exist
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>A <function>xmlwriter_flush</function> example</title>
<para>
Any text that describes the purpose of the example, or
what goes on in the example should go here (inside the
<example> tag, not out
</para>
<programlisting role="php">
<![CDATA[
<?php
if ($anexample === true) {
echo 'Use the PEAR Coding Standards';
}
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
Use the PEAR Coding Standards
]]>
</screen>
</example>
</para>
</refsect1>
-->
<!-- Use when adding See Also links
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function></function></member>
<member>Or <link linkend="somethingelse">something else</link></member>
</simplelist>
</para>
</refsect1>
-->
</refentry>
<!-- Keep this comment at the end of the file

107
reference/xmlwriter/functions/xmlwriter-full-end-element.xml
View file

@ -1,123 +1,54 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. -->
<refentry id="function.xmlwriter-full-end-element">
<refnamediv>
<refname>xmlwriter_full_end_element</refname>
<refpurpose>End current element - returns FALSE on error</refpurpose>
<refname>XMLWriter->fullEndElement()</refname>
<refpurpose>End current element</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>Object oriented style:</para>
<classsynopsis>
<ooclass><classname>XMLWriter</classname></ooclass>
<methodsynopsis>
<type>bool</type><methodname>fullEndElement</methodname>
<void/>
</methodsynopsis>
</classsynopsis>
<para>Procedural style:</para>
<methodsynopsis>
<type>bool</type><methodname>xmlwriter_full_end_element</methodname>
<methodparam><type>resource</type><parameter>xmlwriter</parameter></methodparam>
</methodsynopsis>
&warn.undocumented.func;
<para>
End the current xml element. Writes an end tag even if the element is empty.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>xmlwriter</parameter></term>
<listitem>
<para>
Its description
</para>
</listitem>
</varlistentry>
&xmlwriter.xmlwriter.description;
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
What the function returns, first on success, then on failure. See
also the &amp;return.success; entity
&return.success;
</para>
</refsect1>
<!-- Use when ERRORS exist
<refsect1 role="errors">
&reftitle.errors;
<para>
When does this function throw E_* level errors, or exceptions?
</para>
</refsect1>
-->
<!-- Use when a CHANGELOG exists
<refsect1 role="changelog">
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>Enter the PHP version of change here</entry>
<entry>Description of change</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
-->
<!-- Use when examples exist
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>A <function>xmlwriter_full_end_element</function> example</title>
<para>
Any text that describes the purpose of the example, or
what goes on in the example should go here (inside the
<example> tag, not out
</para>
<programlisting role="php">
<![CDATA[
<?php
if ($anexample === true) {
echo 'Use the PEAR Coding Standards';
}
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
Use the PEAR Coding Standards
]]>
</screen>
</example>
</para>
</refsect1>
-->
<!-- Use when adding See Also links
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function></function></member>
<member>Or <link linkend="somethingelse">something else</link></member>
<member><xref linkend="function.xmlwriter-end-element" /></member>
</simplelist>
</para>
</refsect1>
-->
</refentry>

96
reference/xmlwriter/functions/xmlwriter-open-memory.xml
View file

@ -1,113 +1,55 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. -->
<refentry id="function.xmlwriter-open-memory">
<refnamediv>
<refname>xmlwriter_open_memory</refname>
<refname>XMLWriter->openMemory()</refname>
<refpurpose>Create new xmlwriter using memory for string output</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>Object oriented style:</para>
<classsynopsis>
<ooclass><classname>XMLWriter</classname></ooclass>
<methodsynopsis>
<type>bool</type><methodname>openMemory</methodname>
<void/>
</methodsynopsis>
</classsynopsis>
<para>Procedural style:</para>
<methodsynopsis>
<type>resource</type><methodname>xmlwriter_open_memory</methodname>
<void/>
</methodsynopsis>
&warn.undocumented.func;
<para>
Creates a new XMLWriter using memory for string output.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
What the function returns, first on success, then on failure. See
also the &amp;return.success; entity
Object oriented style: &return.success;.
</para>
</refsect1>
<!-- Use when ERRORS exist
<refsect1 role="errors">
&reftitle.errors;
<para>
When does this function throw E_* level errors, or exceptions?
Procedural style: Returns a new xmlwriter resource for later use with the
xmlwriter functions on success, &false; on error.
</para>
</refsect1>
-->
<!-- Use when a CHANGELOG exists
<refsect1 role="changelog">
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>Enter the PHP version of change here</entry>
<entry>Description of change</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
-->
<!-- Use when examples exist
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>A <function>xmlwriter_open_memory</function> example</title>
<para>
Any text that describes the purpose of the example, or
what goes on in the example should go here (inside the
<example> tag, not out
</para>
<programlisting role="php">
<![CDATA[
<?php
if ($anexample === true) {
echo 'Use the PEAR Coding Standards';
}
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
Use the PEAR Coding Standards
]]>
</screen>
</example>
</para>
</refsect1>
-->
<!-- Use when adding See Also links
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function></function></member>
<member>Or <link linkend="somethingelse">something else</link></member>
<member><xref linkend="function.xmlwriter-open-uri" /></member>
</simplelist>
</para>
</refsect1>
-->
</refentry>

102
reference/xmlwriter/functions/xmlwriter-open-uri.xml
View file

@ -1,123 +1,65 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. -->
<refentry id="function.xmlwriter-open-uri">
<refnamediv>
<refname>xmlwriter_open_uri</refname>
<refname>XMLWriter->openURI()</refname>
<refpurpose>Create new xmlwriter using source uri for output</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>Object oriented style:</para>
<classsynopsis>
<ooclass><classname>XMLWriter</classname></ooclass>
<methodsynopsis>
<type>bool</type><methodname>openURI</methodname>
<methodparam><type>string</type><parameter>uri</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<para>Procedural style:</para>
<methodsynopsis>
<type>resource</type><methodname>xmlwriter_open_uri</methodname>
<methodparam><type>string</type><parameter>source</parameter></methodparam>
<methodparam><type>string</type><parameter>uri</parameter></methodparam>
</methodsynopsis>
&warn.undocumented.func;
<para>
Creates a new XMLWriter using <parameter>uri</parameter> for the output.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>source</parameter></term>
<term><parameter>uri</parameter></term>
<listitem>
<para>
Its description
The URI of the resource for the output.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
What the function returns, first on success, then on failure. See
also the &amp;return.success; entity
Object oriented style: &return.success;.
</para>
</refsect1>
<!-- Use when ERRORS exist
<refsect1 role="errors">
&reftitle.errors;
<para>
When does this function throw E_* level errors, or exceptions?
Procedural style: Returns a new xmlwriter resource for later use with the
xmlwriter functions on success, &false; on error.
</para>
</refsect1>
-->
<!-- Use when a CHANGELOG exists
<refsect1 role="changelog">
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>Enter the PHP version of change here</entry>
<entry>Description of change</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
-->
<!-- Use when examples exist
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>A <function>xmlwriter_open_uri</function> example</title>
<para>
Any text that describes the purpose of the example, or
what goes on in the example should go here (inside the
<example> tag, not out
</para>
<programlisting role="php">
<![CDATA[
<?php
if ($anexample === true) {
echo 'Use the PEAR Coding Standards';
}
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
Use the PEAR Coding Standards
]]>
</screen>
</example>
</para>
</refsect1>
-->
<!-- Use when adding See Also links
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function></function></member>
<member>Or <link linkend="somethingelse">something else</link></member>
<member><xref linkend="function.xmlwriter-open-memory" /></member>
</simplelist>
</para>
</refsect1>
-->
</refentry>

109
reference/xmlwriter/functions/xmlwriter-output-memory.xml
View file

@ -1,132 +1,63 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. -->
<refentry id="function.xmlwriter-output-memory">
<refnamediv>
<refname>xmlwriter_output_memory</refname>
<refpurpose>Output current buffer as string</refpurpose>
<refname>XMLWriter->outputMemory()</refname>
<refpurpose>Returns current buffer</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>Object oriented style:</para>
<classsynopsis>
<ooclass><classname>XMLWriter</classname></ooclass>
<methodsynopsis>
<type>bool</type><methodname>outputMemory</methodname>
<methodparam choice="opt"><type>bool</type><parameter>flush</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<para>Procedural style:</para>
<methodsynopsis>
<type>string</type><methodname>xmlwriter_output_memory</methodname>
<methodparam><type>resource</type><parameter>xmlwriter</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>flush</parameter></methodparam>
</methodsynopsis>
&warn.undocumented.func;
<para>
Returns the current buffer.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>xmlwriter</parameter></term>
<listitem>
<para>
Its description
</para>
</listitem>
</varlistentry>
&xmlwriter.xmlwriter.description;
<varlistentry>
<term><parameter>flush</parameter></term>
<listitem>
<para>
Its description
Whether to flush the output buffer or no. Default is &true;.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
What the function returns, first on success, then on failure. See
also the &amp;return.success; entity
Returns the current buffer as a string.
</para>
</refsect1>
<!-- Use when ERRORS exist
<refsect1 role="errors">
&reftitle.errors;
<para>
When does this function throw E_* level errors, or exceptions?
</para>
</refsect1>
-->
<!-- Use when a CHANGELOG exists
<refsect1 role="changelog">
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>Enter the PHP version of change here</entry>
<entry>Description of change</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
-->
<!-- Use when examples exist
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>A <function>xmlwriter_output_memory</function> example</title>
<para>
Any text that describes the purpose of the example, or
what goes on in the example should go here (inside the
<example> tag, not out
</para>
<programlisting role="php">
<![CDATA[
<?php
if ($anexample === true) {
echo 'Use the PEAR Coding Standards';
}
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
Use the PEAR Coding Standards
]]>
</screen>
</example>
</para>
</refsect1>
-->
<!-- Use when adding See Also links
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function></function></member>
<member>Or <link linkend="somethingelse">something else</link></member>
<member><xref linkend="function.xmlwriter-flush" /></member>
</simplelist>
</para>
</refsect1>
-->
</refentry>

110
reference/xmlwriter/functions/xmlwriter-set-indent-string.xml
View file

@ -1,132 +1,64 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. -->
<refentry id="function.xmlwriter-set-indent-string">
<refnamediv>
<refname>xmlwriter_set_indent_string</refname>
<refpurpose>Set string used for indenting - returns FALSE on error</refpurpose>
<refname>XMLWriter->setIndentString()</refname>
<refpurpose>Set string used for indenting</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>Object oriented style:</para>
<classsynopsis>
<ooclass><classname>XMLWriter</classname></ooclass>
<methodsynopsis>
<type>bool</type><methodname>setIndentString</methodname>
<methodparam><type>string</type><parameter>indentString</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<para>Procedural style:</para>
<methodsynopsis>
<type>bool</type><methodname>xmlwriter_set_indent_string</methodname>
<methodparam><type>resource</type><parameter>xmlwriter</parameter></methodparam>
<methodparam><type>string</type><parameter>indentString</parameter></methodparam>
</methodsynopsis>
&warn.undocumented.func;
<para>
Sets the string which will be used to indent each element/attribute of the
resulting xml.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>xmlwriter</parameter></term>
<listitem>
<para>
Its description
</para>
</listitem>
</varlistentry>
&xmlwriter.xmlwriter.description;
<varlistentry>
<term><parameter>indentString</parameter></term>
<listitem>
<para>
Its description
The indentation string.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
What the function returns, first on success, then on failure. See
also the &amp;return.success; entity
&return.success;
</para>
</refsect1>
<!-- Use when ERRORS exist
<refsect1 role="errors">
&reftitle.errors;
<para>
When does this function throw E_* level errors, or exceptions?
</para>
</refsect1>
-->
<!-- Use when a CHANGELOG exists
<refsect1 role="changelog">
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>Enter the PHP version of change here</entry>
<entry>Description of change</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
-->
<!-- Use when examples exist
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>A <function>xmlwriter_set_indent_string</function> example</title>
<para>
Any text that describes the purpose of the example, or
what goes on in the example should go here (inside the
<example> tag, not out
</para>
<programlisting role="php">
<![CDATA[
<?php
if ($anexample === true) {
echo 'Use the PEAR Coding Standards';
}
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
Use the PEAR Coding Standards
]]>
</screen>
</example>
</para>
</refsect1>
-->
<!-- Use when adding See Also links
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function></function></member>
<member>Or <link linkend="somethingelse">something else</link></member>
<member><xref linkend="function.xmlwriter-set-indent" /></member>
</simplelist>
</para>
</refsect1>
-->
</refentry>

109
reference/xmlwriter/functions/xmlwriter-set-indent.xml
View file

@ -1,132 +1,63 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. -->
<refentry id="function.xmlwriter-set-indent">
<refnamediv>
<refname>xmlwriter_set_indent</refname>
<refpurpose>Toggle indentation on/off - returns FALSE on error</refpurpose>
<refname>XMLWriter->setIndent()</refname>
<refpurpose>Toggle indentation on/off</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>Object oriented style:</para>
<classsynopsis>
<ooclass><classname>XMLWriter</classname></ooclass>
<methodsynopsis>
<type>bool</type><methodname>setIndent</methodname>
<methodparam><type>bool</type><parameter>indent</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<para>Procedural style:</para>
<methodsynopsis>
<type>bool</type><methodname>xmlwriter_set_indent</methodname>
<methodparam><type>resource</type><parameter>xmlwriter</parameter></methodparam>
<methodparam><type>bool</type><parameter>indent</parameter></methodparam>
</methodsynopsis>
&warn.undocumented.func;
<para>
Toggles indentation on or off.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>xmlwriter</parameter></term>
<listitem>
<para>
Its description
</para>
</listitem>
</varlistentry>
&xmlwriter.xmlwriter.description;
<varlistentry>
<term><parameter>indent</parameter></term>
<listitem>
<para>
Its description
Whether indentation is enabled. Defaults to &false;.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
What the function returns, first on success, then on failure. See
also the &amp;return.success; entity
&return.success;
</para>
</refsect1>
<!-- Use when ERRORS exist
<refsect1 role="errors">
&reftitle.errors;
<para>
When does this function throw E_* level errors, or exceptions?
</para>
</refsect1>
-->
<!-- Use when a CHANGELOG exists
<refsect1 role="changelog">
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>Enter the PHP version of change here</entry>
<entry>Description of change</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
-->
<!-- Use when examples exist
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>A <function>xmlwriter_set_indent</function> example</title>
<para>
Any text that describes the purpose of the example, or
what goes on in the example should go here (inside the
<example> tag, not out
</para>
<programlisting role="php">
<![CDATA[
<?php
if ($anexample === true) {
echo 'Use the PEAR Coding Standards';
}
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
Use the PEAR Coding Standards
]]>
</screen>
</example>
</para>
</refsect1>
-->
<!-- Use when adding See Also links
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function></function></member>
<member>Or <link linkend="somethingelse">something else</link></member>
<member><xref linkend="function.xmlwriter-set-indent-string" /></member>
</simplelist>
</para>
</refsect1>
-->
</refentry>

118
reference/xmlwriter/functions/xmlwriter-start-attribute-ns.xml
View file

@ -1,13 +1,24 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. -->
<refentry id="function.xmlwriter-start-attribute-ns">
<refnamediv>
<refname>xmlwriter_start_attribute_ns</refname>
<refpurpose>Create start namespaced attribute - returns FALSE on error</refpurpose>
<refname>XMLWriter->startAttributeNS()</refname>
<refpurpose>Create start namespaced attribute</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>Object oriented style:</para>
<classsynopsis>
<ooclass><classname>XMLWriter</classname></ooclass>
<methodsynopsis>
<type>bool</type><methodname>startAttributeNS</methodname>
<methodparam><type>string</type><parameter>prefix</parameter></methodparam>
<methodparam><type>string</type><parameter>name</parameter></methodparam>
<methodparam><type>string</type><parameter>uri</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<para>Procedural style:</para>
<methodsynopsis>
<type>bool</type><methodname>xmlwriter_start_attribute_ns</methodname>
<methodparam><type>resource</type><parameter>xmlwriter</parameter></methodparam>
@ -15,27 +26,20 @@
<methodparam><type>string</type><parameter>name</parameter></methodparam>
<methodparam><type>string</type><parameter>uri</parameter></methodparam>
</methodsynopsis>
&warn.undocumented.func;
<para>
Starts a namespaced attribute.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>xmlwriter</parameter></term>
<listitem>
<para>
Its description
</para>
</listitem>
</varlistentry>
&xmlwriter.xmlwriter.description;
<varlistentry>
<term><parameter>prefix</parameter></term>
<listitem>
<para>
Its description
The namespace prefix.
</para>
</listitem>
</varlistentry>
@ -43,7 +47,7 @@
<term><parameter>name</parameter></term>
<listitem>
<para>
Its description
The attribute name.
</para>
</listitem>
</varlistentry>
@ -51,100 +55,32 @@
<term><parameter>uri</parameter></term>
<listitem>
<para>
Its description
The namespace URI.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
What the function returns, first on success, then on failure. See
also the &amp;return.success; entity
&return.success;
</para>
</refsect1>
<!-- Use when ERRORS exist
<refsect1 role="errors">
&reftitle.errors;
<para>
When does this function throw E_* level errors, or exceptions?
</para>
</refsect1>
-->
<!-- Use when a CHANGELOG exists
<refsect1 role="changelog">
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>Enter the PHP version of change here</entry>
<entry>Description of change</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
-->
<!-- Use when examples exist
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>A <function>xmlwriter_start_attribute_ns</function> example</title>
<para>
Any text that describes the purpose of the example, or
what goes on in the example should go here (inside the
<example> tag, not out
</para>
<programlisting role="php">
<![CDATA[
<?php
if ($anexample === true) {
echo 'Use the PEAR Coding Standards';
}
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
Use the PEAR Coding Standards
]]>
</screen>
</example>
</para>
</refsect1>
-->
<!-- Use when adding See Also links
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function></function></member>
<member>Or <link linkend="somethingelse">something else</link></member>
<member><xref linkend="function.xmlwriter-start-attribute" /></member>
<member><xref linkend="function.xmlwriter-end-attribute" /></member>
<member><xref linkend="function.xmlwriter-write-attribute" /></member>
<member><xref linkend="function.xmlwriter-write-attribute-ns" /></member>
</simplelist>
</para>
</refsect1>
-->
</refentry>

112
reference/xmlwriter/functions/xmlwriter-start-attribute.xml
View file

@ -1,132 +1,66 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. -->
<refentry id="function.xmlwriter-start-attribute">
<refnamediv>
<refname>xmlwriter_start_attribute</refname>
<refpurpose>Create start attribute - returns FALSE on error</refpurpose>
<refname>XMLWriter->startAttribute()</refname>
<refpurpose>Create start attribute</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>Object oriented style:</para>
<classsynopsis>
<ooclass><classname>XMLWriter</classname></ooclass>
<methodsynopsis>
<type>bool</type><methodname>startAttribute</methodname>
<methodparam><type>string</type><parameter>name</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<para>Procedural style:</para>
<methodsynopsis>
<type>bool</type><methodname>xmlwriter_start_attribute</methodname>
<methodparam><type>resource</type><parameter>xmlwriter</parameter></methodparam>
<methodparam><type>string</type><parameter>name</parameter></methodparam>
</methodsynopsis>
&warn.undocumented.func;
<para>
Starts an attribute.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>xmlwriter</parameter></term>
<listitem>
<para>
Its description
</para>
</listitem>
</varlistentry>
&xmlwriter.xmlwriter.description;
<varlistentry>
<term><parameter>name</parameter></term>
<listitem>
<para>
Its description
The attribute name.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
What the function returns, first on success, then on failure. See
also the &amp;return.success; entity
&return.success;
</para>
</refsect1>
<!-- Use when ERRORS exist
<refsect1 role="errors">
&reftitle.errors;
<para>
When does this function throw E_* level errors, or exceptions?
</para>
</refsect1>
-->
<!-- Use when a CHANGELOG exists
<refsect1 role="changelog">
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>Enter the PHP version of change here</entry>
<entry>Description of change</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
-->
<!-- Use when examples exist
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>A <function>xmlwriter_start_attribute</function> example</title>
<para>
Any text that describes the purpose of the example, or
what goes on in the example should go here (inside the
<example> tag, not out
</para>
<programlisting role="php">
<![CDATA[
<?php
if ($anexample === true) {
echo 'Use the PEAR Coding Standards';
}
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
Use the PEAR Coding Standards
]]>
</screen>
</example>
</para>
</refsect1>
-->
<!-- Use when adding See Also links
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function></function></member>
<member>Or <link linkend="somethingelse">something else</link></member>
<member><xref linkend="function.xmlwriter-start-attribute-ns" /></member>
<member><xref linkend="function.xmlwriter-end-attribute" /></member>
<member><xref linkend="function.xmlwriter-write-attribute" /></member>
<member><xref linkend="function.xmlwriter-write-attribute-ns" /></member>
</simplelist>
</para>
</refsect1>
-->
</refentry>

108
reference/xmlwriter/functions/xmlwriter-start-cdata.xml
View file

@ -1,123 +1,55 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. -->
<refentry id="function.xmlwriter-start-cdata">
<refnamediv>
<refname>xmlwriter_start_cdata</refname>
<refpurpose>Create start CDATA tag - returns FALSE on error</refpurpose>
<refname>XMLWriter->startCData()</refname>
<refpurpose>Create start CDATA tag</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>Object oriented style:</para>
<classsynopsis>
<ooclass><classname>XMLWriter</classname></ooclass>
<methodsynopsis>
<type>bool</type><methodname>startCData</methodname>
<void/>
</methodsynopsis>
</classsynopsis>
<para>Procedural style:</para>
<methodsynopsis>
<type>bool</type><methodname>xmlwriter_start_cdata</methodname>
<methodparam><type>resource</type><parameter>xmlwriter</parameter></methodparam>
</methodsynopsis>
&warn.undocumented.func;
<para>
Starts a CDATA.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>xmlwriter</parameter></term>
<listitem>
<para>
Its description
</para>
</listitem>
</varlistentry>
&xmlwriter.xmlwriter.description;
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
What the function returns, first on success, then on failure. See
also the &amp;return.success; entity
&return.success;
</para>
</refsect1>
<!-- Use when ERRORS exist
<refsect1 role="errors">
&reftitle.errors;
<para>
When does this function throw E_* level errors, or exceptions?
</para>
</refsect1>
-->
<!-- Use when a CHANGELOG exists
<refsect1 role="changelog">
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>Enter the PHP version of change here</entry>
<entry>Description of change</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
-->
<!-- Use when examples exist
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>A <function>xmlwriter_start_cdata</function> example</title>
<para>
Any text that describes the purpose of the example, or
what goes on in the example should go here (inside the
<example> tag, not out
</para>
<programlisting role="php">
<![CDATA[
<?php
if ($anexample === true) {
echo 'Use the PEAR Coding Standards';
}
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
Use the PEAR Coding Standards
]]>
</screen>
</example>
</para>
</refsect1>
-->
<!-- Use when adding See Also links
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function></function></member>
<member>Or <link linkend="somethingelse">something else</link></member>
<member><xref linkend="function.xmlwriter-end-cdata" /></member>
<member><xref linkend="function.xmlwriter-write-cdata" /></member>
</simplelist>
</para>
</refsect1>
-->
</refentry>

108
reference/xmlwriter/functions/xmlwriter-start-comment.xml
View file

@ -1,123 +1,55 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. -->
<refentry id="function.xmlwriter-start-comment">
<refnamediv>
<refname>xmlwriter_start_comment</refname>
<refpurpose>Create start comment - returns FALSE on error</refpurpose>
<refname>XMLWriter->startComment()</refname>
<refpurpose>Create start comment</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>Object oriented style:</para>
<classsynopsis>
<ooclass><classname>XMLWriter</classname></ooclass>
<methodsynopsis>
<type>bool</type><methodname>startComment</methodname>
<void/>
</methodsynopsis>
</classsynopsis>
<para>Procedural style:</para>
<methodsynopsis>
<type>bool</type><methodname>xmlwriter_start_comment</methodname>
<methodparam><type>resource</type><parameter>xmlwriter</parameter></methodparam>
</methodsynopsis>
&warn.undocumented.func;
<para>
Starts a comment.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>xmlwriter</parameter></term>
<listitem>
<para>
Its description
</para>
</listitem>
</varlistentry>
&xmlwriter.xmlwriter.description;
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
What the function returns, first on success, then on failure. See
also the &amp;return.success; entity
&return.success;
</para>
</refsect1>
<!-- Use when ERRORS exist
<refsect1 role="errors">
&reftitle.errors;
<para>
When does this function throw E_* level errors, or exceptions?
</para>
</refsect1>
-->
<!-- Use when a CHANGELOG exists
<refsect1 role="changelog">
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>Enter the PHP version of change here</entry>
<entry>Description of change</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
-->
<!-- Use when examples exist
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>A <function>xmlwriter_start_comment</function> example</title>
<para>
Any text that describes the purpose of the example, or
what goes on in the example should go here (inside the
<example> tag, not out
</para>
<programlisting role="php">
<![CDATA[
<?php
if ($anexample === true) {
echo 'Use the PEAR Coding Standards';
}
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
Use the PEAR Coding Standards
]]>
</screen>
</example>
</para>
</refsect1>
-->
<!-- Use when adding See Also links
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function></function></member>
<member>Or <link linkend="somethingelse">something else</link></member>
<member><xref linkend="function.xmlwriter-end-comment" /></member>
<member><xref linkend="function.xmlwriter-write-comment" /></member>
</simplelist>
</para>
</refsect1>
-->
</refentry>

118
reference/xmlwriter/functions/xmlwriter-start-document.xml
View file

@ -1,13 +1,24 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. -->
<refentry id="function.xmlwriter-start-document">
<refnamediv>
<refname>xmlwriter_start_document</refname>
<refpurpose>Create document tag - returns FALSE on error</refpurpose>
<refname>XMLWriter->startDocument()</refname>
<refpurpose>Create document tag</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>Object oriented style:</para>
<classsynopsis>
<ooclass><classname>XMLWriter</classname></ooclass>
<methodsynopsis>
<type>bool</type><methodname>startDocument</methodname>
<methodparam choice="opt"><type>string</type><parameter>version</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>encoding</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>standalone</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<para>Procedural style:</para>
<methodsynopsis>
<type>bool</type><methodname>xmlwriter_start_document</methodname>
<methodparam><type>resource</type><parameter>xmlwriter</parameter></methodparam>
@ -15,27 +26,21 @@
<methodparam choice="opt"><type>string</type><parameter>encoding</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>standalone</parameter></methodparam>
</methodsynopsis>
&warn.undocumented.func;
<para>
Starts a document.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>xmlwriter</parameter></term>
<listitem>
<para>
Its description
</para>
</listitem>
</varlistentry>
&xmlwriter.xmlwriter.description;
<varlistentry>
<term><parameter>version</parameter></term>
<listitem>
<para>
Its description
The version number of the document as part of the XML declaration.
Defaults to <literal>1.0</literal>.
</para>
</listitem>
</varlistentry>
@ -43,7 +48,8 @@
<term><parameter>encoding</parameter></term>
<listitem>
<para>
Its description
The encoding of the document as part of the XML declaration.
&null by default.
</para>
</listitem>
</varlistentry>
@ -51,100 +57,30 @@
<term><parameter>standalone</parameter></term>
<listitem>
<para>
Its description
<literal>yes</literal> or <literal>no</literal>.
&null; by default.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
What the function returns, first on success, then on failure. See
also the &amp;return.success; entity
&return.success;
</para>
</refsect1>
<!-- Use when ERRORS exist
<refsect1 role="errors">
&reftitle.errors;
<para>
When does this function throw E_* level errors, or exceptions?
</para>
</refsect1>
-->
<!-- Use when a CHANGELOG exists
<refsect1 role="changelog">
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>Enter the PHP version of change here</entry>
<entry>Description of change</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
-->
<!-- Use when examples exist
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>A <function>xmlwriter_start_document</function> example</title>
<para>
Any text that describes the purpose of the example, or
what goes on in the example should go here (inside the
<example> tag, not out
</para>
<programlisting role="php">
<![CDATA[
<?php
if ($anexample === true) {
echo 'Use the PEAR Coding Standards';
}
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
Use the PEAR Coding Standards
]]>
</screen>
</example>
</para>
</refsect1>
-->
<!-- Use when adding See Also links
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function></function></member>
<member>Or <link linkend="somethingelse">something else</link></member>
<member><xref linkend="function.xmlwriter-end-document" /></member>
</simplelist>
</para>
</refsect1>
-->
</refentry>

110
reference/xmlwriter/functions/xmlwriter-start-dtd-attlist.xml
View file

@ -1,132 +1,64 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. -->
<refentry id="function.xmlwriter-start-dtd-attlist">
<refnamediv>
<refname>xmlwriter_start_dtd_attlist</refname>
<refpurpose>Create start DTD AttList - returns FALSE on error</refpurpose>
<refname>XMLWriter->startDTDAttlist()</refname>
<refpurpose>Create start DTD AttList</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>Object oriented style:</para>
<classsynopsis>
<ooclass><classname>XMLWriter</classname></ooclass>
<methodsynopsis>
<type>bool</type><methodname>startDTDAttlist</methodname>
<methodparam><type>string</type><parameter>name</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<para>Procedural style:</para>
<methodsynopsis>
<type>bool</type><methodname>xmlwriter_start_dtd_attlist</methodname>
<methodparam><type>resource</type><parameter>xmlwriter</parameter></methodparam>
<methodparam><type>string</type><parameter>name</parameter></methodparam>
</methodsynopsis>
&warn.undocumented.func;
<para>
Starts a DTD attribute list.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>xmlwriter</parameter></term>
<listitem>
<para>
Its description
</para>
</listitem>
</varlistentry>
&xmlwriter.xmlwriter.description;
<varlistentry>
<term><parameter>name</parameter></term>
<listitem>
<para>
Its description
The attribute list name.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
What the function returns, first on success, then on failure. See
also the &amp;return.success; entity
&return.success;
</para>
</refsect1>
<!-- Use when ERRORS exist
<refsect1 role="errors">
&reftitle.errors;
<para>
When does this function throw E_* level errors, or exceptions?
</para>
</refsect1>
-->
<!-- Use when a CHANGELOG exists
<refsect1 role="changelog">
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>Enter the PHP version of change here</entry>
<entry>Description of change</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
-->
<!-- Use when examples exist
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>A <function>xmlwriter_start_dtd_attlist</function> example</title>
<para>
Any text that describes the purpose of the example, or
what goes on in the example should go here (inside the
<example> tag, not out
</para>
<programlisting role="php">
<![CDATA[
<?php
if ($anexample === true) {
echo 'Use the PEAR Coding Standards';
}
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
Use the PEAR Coding Standards
]]>
</screen>
</example>
</para>
</refsect1>
-->
<!-- Use when adding See Also links
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function></function></member>
<member>Or <link linkend="somethingelse">something else</link></member>
<member><xref linkend="function.xmlwriter-end-dtd-attlist" /></member>
<member><xref linkend="function.xmlwriter-write-dtd-attlist" /></member>
</simplelist>
</para>
</refsect1>
-->
</refentry>

114
reference/xmlwriter/functions/xmlwriter-start-dtd-element.xml
View file

@ -1,132 +1,64 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. -->
<refentry id="function.xmlwriter-start-dtd-element">
<refnamediv>
<refname>xmlwriter_start_dtd_element</refname>
<refpurpose>Create start DTD element - returns FALSE on error</refpurpose>
<refname>XMLWriter->startDTDElement()</refname>
<refpurpose>Create start DTD element</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>Object oriented style:</para>
<classsynopsis>
<ooclass><classname>XMLWriter</classname></ooclass>
<methodsynopsis>
<type>bool</type><methodname>startDTDElement</methodname>
<methodparam><type>string</type><parameter>qualifiedName</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<para>Procedural style:</para>
<methodsynopsis>
<type>bool</type><methodname>xmlwriter_start_dtd_element</methodname>
<methodparam><type>resource</type><parameter>xmlwriter</parameter></methodparam>
<methodparam><type>string</type><parameter>name</parameter></methodparam>
<methodparam><type>string</type><parameter>qualifiedName</parameter></methodparam>
</methodsynopsis>
&warn.undocumented.func;
<para>
Starts a DTD element.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
&xmlwriter.xmlwriter.description;
<varlistentry>
<term><parameter>xmlwriter</parameter></term>
<term><parameter>qualifiedName</parameter></term>
<listitem>
<para>
Its description
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>name</parameter></term>
<listitem>
<para>
Its description
The qualified name of the document type to create.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
What the function returns, first on success, then on failure. See
also the &amp;return.success; entity
&return.success;
</para>
</refsect1>
<!-- Use when ERRORS exist
<refsect1 role="errors">
&reftitle.errors;
<para>
When does this function throw E_* level errors, or exceptions?
</para>
</refsect1>
-->
<!-- Use when a CHANGELOG exists
<refsect1 role="changelog">
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>Enter the PHP version of change here</entry>
<entry>Description of change</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
-->
<!-- Use when examples exist
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>A <function>xmlwriter_start_dtd_element</function> example</title>
<para>
Any text that describes the purpose of the example, or
what goes on in the example should go here (inside the
<example> tag, not out
</para>
<programlisting role="php">
<![CDATA[
<?php
if ($anexample === true) {
echo 'Use the PEAR Coding Standards';
}
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
Use the PEAR Coding Standards
]]>
</screen>
</example>
</para>
</refsect1>
-->
<!-- Use when adding See Also links
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function></function></member>
<member>Or <link linkend="somethingelse">something else</link></member>
<member><xref linkend="function.xmlwriter-end-dtd-element" /></member>
<member><xref linkend="function.xmlwriter-write-dtd-element" /></member>
</simplelist>
</para>
</refsect1>
-->
</refentry>

112
reference/xmlwriter/functions/xmlwriter-start-dtd-entity.xml
View file

@ -1,40 +1,43 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. -->
<refentry id="function.xmlwriter-start-dtd-entity">
<refnamediv>
<refname>xmlwriter_start_dtd_entity</refname>
<refpurpose>Create start DTD Entity - returns FALSE on error</refpurpose>
<refname>XMLWriter->startDTDEntity()</refname>
<refpurpose>Create start DTD Entity</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>Object oriented style:</para>
<classsynopsis>
<ooclass><classname>XMLWriter</classname></ooclass>
<methodsynopsis>
<type>bool</type><methodname>startDTDEntity</methodname>
<methodparam><type>string</type><parameter>name</parameter></methodparam>
<methodparam><type>bool</type><parameter>isparam</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<para>Procedural style:</para>
<methodsynopsis>
<type>bool</type><methodname>xmlwriter_start_dtd_entity</methodname>
<methodparam><type>resource</type><parameter>xmlwriter</parameter></methodparam>
<methodparam><type>string</type><parameter>name</parameter></methodparam>
<methodparam><type>bool</type><parameter>isparam</parameter></methodparam>
</methodsynopsis>
&warn.undocumented.func;
<para>
Starts a DTD entity.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>xmlwriter</parameter></term>
<listitem>
<para>
Its description
</para>
</listitem>
</varlistentry>
&xmlwriter.xmlwriter.description;
<varlistentry>
<term><parameter>name</parameter></term>
<listitem>
<para>
Its description
The name of the entity.
</para>
</listitem>
</varlistentry>
@ -42,100 +45,29 @@
<term><parameter>isparam</parameter></term>
<listitem>
<para>
Its description
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
What the function returns, first on success, then on failure. See
also the &amp;return.success; entity
&return.success;
</para>
</refsect1>
<!-- Use when ERRORS exist
<refsect1 role="errors">
&reftitle.errors;
<para>
When does this function throw E_* level errors, or exceptions?
</para>
</refsect1>
-->
<!-- Use when a CHANGELOG exists
<refsect1 role="changelog">
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>Enter the PHP version of change here</entry>
<entry>Description of change</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
-->
<!-- Use when examples exist
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>A <function>xmlwriter_start_dtd_entity</function> example</title>
<para>
Any text that describes the purpose of the example, or
what goes on in the example should go here (inside the
<example> tag, not out
</para>
<programlisting role="php">
<![CDATA[
<?php
if ($anexample === true) {
echo 'Use the PEAR Coding Standards';
}
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
Use the PEAR Coding Standards
]]>
</screen>
</example>
</para>
</refsect1>
-->
<!-- Use when adding See Also links
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function></function></member>
<member>Or <link linkend="somethingelse">something else</link></member>
<member><xref linkend="function.xmlwriter-end-dtd-entity" /></member>
<member><xref linkend="function.xmlwriter-write-dtd-entity" /></member>
</simplelist>
</para>
</refsect1>
-->
</refentry>

128
reference/xmlwriter/functions/xmlwriter-start-dtd.xml
View file

@ -1,150 +1,84 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. -->
<refentry id="function.xmlwriter-start-dtd">
<refnamediv>
<refname>xmlwriter_start_dtd</refname>
<refpurpose>Create start DTD tag - returns FALSE on error</refpurpose>
<refname>XMLWriter->startDTD()</refname>
<refpurpose>Create start DTD tag</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>Object oriented style:</para>
<classsynopsis>
<ooclass><classname>XMLWriter</classname></ooclass>
<methodsynopsis>
<type>bool</type><methodname>startDTD</methodname>
<methodparam><type>string</type><parameter>qualifiedName</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>publicId</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>systemId</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<para>Procedural style:</para>
<methodsynopsis>
<type>bool</type><methodname>xmlwriter_start_dtd</methodname>
<methodparam><type>resource</type><parameter>xmlwriter</parameter></methodparam>
<methodparam><type>string</type><parameter>name</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>pubid</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>sysid</parameter></methodparam>
<methodparam><type>string</type><parameter>qualifiedName</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>publicId</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>systemId</parameter></methodparam>
</methodsynopsis>
&warn.undocumented.func;
<para>
Starts a DTD.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
&xmlwriter.xmlwriter.description;
<varlistentry>
<term><parameter>xmlwriter</parameter></term>
<term><parameter>qualifiedName</parameter></term>
<listitem>
<para>
Its description
The qualified name of the document type to create.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>name</parameter></term>
<term><parameter>publicId</parameter></term>
<listitem>
<para>
Its description
The external subset public identifier.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>pubid</parameter></term>
<term><parameter>systemId</parameter></term>
<listitem>
<para>
Its description
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>sysid</parameter></term>
<listitem>
<para>
Its description
The external subset system identifier.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
What the function returns, first on success, then on failure. See
also the &amp;return.success; entity
&return.success;
</para>
</refsect1>
<!-- Use when ERRORS exist
<refsect1 role="errors">
&reftitle.errors;
<para>
When does this function throw E_* level errors, or exceptions?
</para>
</refsect1>
-->
<!-- Use when a CHANGELOG exists
<refsect1 role="changelog">
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>Enter the PHP version of change here</entry>
<entry>Description of change</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
-->
<!-- Use when examples exist
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>A <function>xmlwriter_start_dtd</function> example</title>
<para>
Any text that describes the purpose of the example, or
what goes on in the example should go here (inside the
<example> tag, not out
</para>
<programlisting role="php">
<![CDATA[
<?php
if ($anexample === true) {
echo 'Use the PEAR Coding Standards';
}
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
Use the PEAR Coding Standards
]]>
</screen>
</example>
</para>
</refsect1>
-->
<!-- Use when adding See Also links
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function></function></member>
<member>Or <link linkend="somethingelse">something else</link></member>
<member><xref linkend="function.xmlwriter-end-dtd" /></member>
<member><xref linkend="function.xmlwriter-write-dtd" /></member>
</simplelist>
</para>
</refsect1>
-->
</refentry>

116
reference/xmlwriter/functions/xmlwriter-start-element-ns.xml
View file

@ -1,13 +1,24 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. -->
<refentry id="function.xmlwriter-start-element-ns">
<refnamediv>
<refname>xmlwriter_start_element_ns</refname>
<refpurpose>Create start namespaced element tag - returns FALSE on error</refpurpose>
<refname>XMLWriter->startElementNS()</refname>
<refpurpose>Create start namespaced element tag</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>Object oriented style:</para>
<classsynopsis>
<ooclass><classname>XMLWriter</classname></ooclass>
<methodsynopsis>
<type>bool</type><methodname>startElementNS</methodname>
<methodparam><type>string</type><parameter>prefix</parameter></methodparam>
<methodparam><type>string</type><parameter>name</parameter></methodparam>
<methodparam><type>string</type><parameter>uri</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<para>Procedural style:</para>
<methodsynopsis>
<type>bool</type><methodname>xmlwriter_start_element_ns</methodname>
<methodparam><type>resource</type><parameter>xmlwriter</parameter></methodparam>
@ -15,27 +26,20 @@
<methodparam><type>string</type><parameter>name</parameter></methodparam>
<methodparam><type>string</type><parameter>uri</parameter></methodparam>
</methodsynopsis>
&warn.undocumented.func;
<para>
Starts a namespaced element.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>xmlwriter</parameter></term>
<listitem>
<para>
Its description
</para>
</listitem>
</varlistentry>
&xmlwriter.xmlwriter.description;
<varlistentry>
<term><parameter>prefix</parameter></term>
<listitem>
<para>
Its description
The namespace prefix.
</para>
</listitem>
</varlistentry>
@ -43,7 +47,7 @@
<term><parameter>name</parameter></term>
<listitem>
<para>
Its description
The element name.
</para>
</listitem>
</varlistentry>
@ -51,100 +55,30 @@
<term><parameter>uri</parameter></term>
<listitem>
<para>
Its description
The namespace URI.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
What the function returns, first on success, then on failure. See
also the &amp;return.success; entity
&return.success;
</para>
</refsect1>
<!-- Use when ERRORS exist
<refsect1 role="errors">
&reftitle.errors;
<para>
When does this function throw E_* level errors, or exceptions?
</para>
</refsect1>
-->
<!-- Use when a CHANGELOG exists
<refsect1 role="changelog">
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>Enter the PHP version of change here</entry>
<entry>Description of change</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
-->
<!-- Use when examples exist
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>A <function>xmlwriter_start_element_ns</function> example</title>
<para>
Any text that describes the purpose of the example, or
what goes on in the example should go here (inside the
<example> tag, not out
</para>
<programlisting role="php">
<![CDATA[
<?php
if ($anexample === true) {
echo 'Use the PEAR Coding Standards';
}
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
Use the PEAR Coding Standards
]]>
</screen>
</example>
</para>
</refsect1>
-->
<!-- Use when adding See Also links
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function></function></member>
<member>Or <link linkend="somethingelse">something else</link></member>
<member><xref linkend="function.xmlwriter-end-element" /></member>
<member><xref linkend="function.xmlwriter-write-element-ns" /></member>
</simplelist>
</para>
</refsect1>
-->
</refentry>

110
reference/xmlwriter/functions/xmlwriter-start-element.xml
View file

@ -1,132 +1,64 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. -->
<refentry id="function.xmlwriter-start-element">
<refnamediv>
<refname>xmlwriter_start_element</refname>
<refpurpose>Create start element tag - returns FALSE on error</refpurpose>
<refname>XMLWriter->startElement()</refname>
<refpurpose>Create start element tag</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>Object oriented style:</para>
<classsynopsis>
<ooclass><classname>XMLWriter</classname></ooclass>
<methodsynopsis>
<type>bool</type><methodname>startElement</methodname>
<methodparam><type>string</type><parameter>name</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<para>Procedural style:</para>
<methodsynopsis>
<type>bool</type><methodname>xmlwriter_start_element</methodname>
<methodparam><type>resource</type><parameter>xmlwriter</parameter></methodparam>
<methodparam><type>string</type><parameter>name</parameter></methodparam>
</methodsynopsis>
&warn.undocumented.func;
<para>
Starts an element.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>xmlwriter</parameter></term>
<listitem>
<para>
Its description
</para>
</listitem>
</varlistentry>
&xmlwriter.xmlwriter.description;
<varlistentry>
<term><parameter>name</parameter></term>
<listitem>
<para>
Its description
The element name.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
What the function returns, first on success, then on failure. See
also the &amp;return.success; entity
&return.success;
</para>
</refsect1>
<!-- Use when ERRORS exist
<refsect1 role="errors">
&reftitle.errors;
<para>
When does this function throw E_* level errors, or exceptions?
</para>
</refsect1>
-->
<!-- Use when a CHANGELOG exists
<refsect1 role="changelog">
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>Enter the PHP version of change here</entry>
<entry>Description of change</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
-->
<!-- Use when examples exist
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>A <function>xmlwriter_start_element</function> example</title>
<para>
Any text that describes the purpose of the example, or
what goes on in the example should go here (inside the
<example> tag, not out
</para>
<programlisting role="php">
<![CDATA[
<?php
if ($anexample === true) {
echo 'Use the PEAR Coding Standards';
}
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
Use the PEAR Coding Standards
]]>
</screen>
</example>
</para>
</refsect1>
-->
<!-- Use when adding See Also links
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function></function></member>
<member>Or <link linkend="somethingelse">something else</link></member>
<member><xref linkend="function.xmlwriter-end-element" /></member>
<member><xref linkend="function.xmlwriter-write-element" /></member>
</simplelist>
</para>
</refsect1>
-->
</refentry>

110
reference/xmlwriter/functions/xmlwriter-start-pi.xml
View file

@ -1,132 +1,64 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. -->
<refentry id="function.xmlwriter-start-pi">
<refnamediv>
<refname>xmlwriter_start_pi</refname>
<refpurpose>Create start PI tag - returns FALSE on error</refpurpose>
<refname>XMLWriter->startPI()</refname>
<refpurpose>Create start PI tag</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>Object oriented style:</para>
<classsynopsis>
<ooclass><classname>XMLWriter</classname></ooclass>
<methodsynopsis>
<type>bool</type><methodname>startPI</methodname>
<methodparam><type>string</type><parameter>target</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<para>Procedural style:</para>
<methodsynopsis>
<type>bool</type><methodname>xmlwriter_start_pi</methodname>
<methodparam><type>resource</type><parameter>xmlwriter</parameter></methodparam>
<methodparam><type>string</type><parameter>target</parameter></methodparam>
</methodsynopsis>
&warn.undocumented.func;
<para>
Starts a processing instruction tag.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>xmlwriter</parameter></term>
<listitem>
<para>
Its description
</para>
</listitem>
</varlistentry>
&xmlwriter.xmlwriter.description;
<varlistentry>
<term><parameter>target</parameter></term>
<listitem>
<para>
Its description
The target of the processing instruction.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
What the function returns, first on success, then on failure. See
also the &amp;return.success; entity
&return.success;
</para>
</refsect1>
<!-- Use when ERRORS exist
<refsect1 role="errors">
&reftitle.errors;
<para>
When does this function throw E_* level errors, or exceptions?
</para>
</refsect1>
-->
<!-- Use when a CHANGELOG exists
<refsect1 role="changelog">
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>Enter the PHP version of change here</entry>
<entry>Description of change</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
-->
<!-- Use when examples exist
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>A <function>xmlwriter_start_pi</function> example</title>
<para>
Any text that describes the purpose of the example, or
what goes on in the example should go here (inside the
<example> tag, not out
</para>
<programlisting role="php">
<![CDATA[
<?php
if ($anexample === true) {
echo 'Use the PEAR Coding Standards';
}
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
Use the PEAR Coding Standards
]]>
</screen>
</example>
</para>
</refsect1>
-->
<!-- Use when adding See Also links
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function></function></member>
<member>Or <link linkend="somethingelse">something else</link></member>
<member><xref linkend="function.xmlwriter-end-pi" /></member>
<member><xref linkend="function.xmlwriter-write-pi" /></member>
</simplelist>
</para>
</refsect1>
-->
</refentry>

116
reference/xmlwriter/functions/xmlwriter-text.xml
View file

@ -1,133 +1,55 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. -->
<refentry id="function.xmlwriter-text">
<refnamediv>
<refname>xmlwriter_text</refname>
<refpurpose>Write text - returns FALSE on error</refpurpose>
<refname>XMLWriter->text()</refname>
<refpurpose>Write text</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>Object oriented style:</para>
<classsynopsis>
<ooclass><classname>XMLWriter</classname></ooclass>
<methodsynopsis>
<type>bool</type><methodname>text</methodname>
<methodparam><type>string</type><parameter>content</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<para>Procedural style:</para>
<methodsynopsis>
<type>bool</type><methodname>xmlwriter_text</methodname>
<methodparam><type>resource</type><parameter>xmlwriter</parameter></methodparam>
<methodparam><type>string</type><parameter>content</parameter></methodparam>
</methodsynopsis>
&warn.undocumented.func;
<para>
Writes a text.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>xmlwriter</parameter></term>
<listitem>
<para>
Its description
</para>
</listitem>
</varlistentry>
&xmlwriter.xmlwriter.description;
<varlistentry>
<term><parameter>content</parameter></term>
<listitem>
<para>
Its description
The contents of the text.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
What the function returns, first on success, then on failure. See
also the &amp;return.success; entity
&return.success;
</para>
</refsect1>
<!-- Use when ERRORS exist
<refsect1 role="errors">
&reftitle.errors;
<para>
When does this function throw E_* level errors, or exceptions?
</para>
</refsect1>
-->
<!-- Use when a CHANGELOG exists
<refsect1 role="changelog">
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>Enter the PHP version of change here</entry>
<entry>Description of change</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
-->
<!-- Use when examples exist
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>A <function>xmlwriter_text</function> example</title>
<para>
Any text that describes the purpose of the example, or
what goes on in the example should go here (inside the
<example> tag, not out
</para>
<programlisting role="php">
<![CDATA[
<?php
if ($anexample === true) {
echo 'Use the PEAR Coding Standards';
}
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
Use the PEAR Coding Standards
]]>
</screen>
</example>
</para>
</refsect1>
-->
<!-- Use when adding See Also links
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function></function></member>
<member>Or <link linkend="somethingelse">something else</link></member>
</simplelist>
</para>
</refsect1>
-->
</refentry>
<!-- Keep this comment at the end of the file

121
reference/xmlwriter/functions/xmlwriter-write-attribute-ns.xml
View file

@ -1,13 +1,25 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. -->
<refentry id="function.xmlwriter-write-attribute-ns">
<refnamediv>
<refname>xmlwriter_write_attribute_ns</refname>
<refpurpose>Write full namespaced attribute - returns FALSE on error</refpurpose>
<refname>XMLWriter->writeAttributeNS()</refname>
<refpurpose>Write full namespaced attribute</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>Object oriented style:</para>
<classsynopsis>
<ooclass><classname>XMLWriter</classname></ooclass>
<methodsynopsis>
<type>bool</type><methodname>writeAttributeNS</methodname>
<methodparam><type>string</type><parameter>prefix</parameter></methodparam>
<methodparam><type>string</type><parameter>name</parameter></methodparam>
<methodparam><type>string</type><parameter>uri</parameter></methodparam>
<methodparam><type>string</type><parameter>content</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<para>Procedural style:</para>
<methodsynopsis>
<type>bool</type><methodname>xmlwriter_write_attribute_ns</methodname>
<methodparam><type>resource</type><parameter>xmlwriter</parameter></methodparam>
@ -16,27 +28,20 @@
<methodparam><type>string</type><parameter>uri</parameter></methodparam>
<methodparam><type>string</type><parameter>content</parameter></methodparam>
</methodsynopsis>
&warn.undocumented.func;
<para>
Writes a full namespaced attribute.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>xmlwriter</parameter></term>
<listitem>
<para>
Its description
</para>
</listitem>
</varlistentry>
&xmlwriter.xmlwriter.description;
<varlistentry>
<term><parameter>prefix</parameter></term>
<listitem>
<para>
Its description
The namespace prefix.
</para>
</listitem>
</varlistentry>
@ -44,7 +49,7 @@
<term><parameter>name</parameter></term>
<listitem>
<para>
Its description
The attribute name.
</para>
</listitem>
</varlistentry>
@ -52,7 +57,7 @@
<term><parameter>uri</parameter></term>
<listitem>
<para>
Its description
The namespace URI.
</para>
</listitem>
</varlistentry>
@ -60,100 +65,32 @@
<term><parameter>content</parameter></term>
<listitem>
<para>
Its description
The attribute value.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
What the function returns, first on success, then on failure. See
also the &amp;return.success; entity
&return.success;
</para>
</refsect1>
<!-- Use when ERRORS exist
<refsect1 role="errors">
&reftitle.errors;
<para>
When does this function throw E_* level errors, or exceptions?
</para>
</refsect1>
-->
<!-- Use when a CHANGELOG exists
<refsect1 role="changelog">
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>Enter the PHP version of change here</entry>
<entry>Description of change</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
-->
<!-- Use when examples exist
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>A <function>xmlwriter_write_attribute_ns</function> example</title>
<para>
Any text that describes the purpose of the example, or
what goes on in the example should go here (inside the
<example> tag, not out
</para>
<programlisting role="php">
<![CDATA[
<?php
if ($anexample === true) {
echo 'Use the PEAR Coding Standards';
}
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
Use the PEAR Coding Standards
]]>
</screen>
</example>
</para>
</refsect1>
-->
<!-- Use when adding See Also links
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function></function></member>
<member>Or <link linkend="somethingelse">something else</link></member>
<member><xref linkend="function.xmlwriter-write-attribute" /></member>
<member><xref linkend="function.xmlwriter-start-attribute" /></member>
<member><xref linkend="function.xmlwriter-start-attribute-ns" /></member>
<member><xref linkend="function.xmlwriter-end-attribute" /></member>
</simplelist>
</para>
</refsect1>
-->
</refentry>

118
reference/xmlwriter/functions/xmlwriter-write-attribute.xml
View file

@ -1,140 +1,76 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. -->
<refentry id="function.xmlwriter-write-attribute">
<refnamediv>
<refname>xmlwriter_write_attribute</refname>
<refpurpose>Write full attribute - returns FALSE on error</refpurpose>
<refname>XMLWriter->writeAttribute()</refname>
<refpurpose>Write full attribute</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>Object oriented style:</para>
<classsynopsis>
<ooclass><classname>XMLWriter</classname></ooclass>
<methodsynopsis>
<type>bool</type><methodname>writeAttribute</methodname>
<methodparam><type>string</type><parameter>name</parameter></methodparam>
<methodparam><type>string</type><parameter>value</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<para>Procedural style:</para>
<methodsynopsis>
<type>bool</type><methodname>xmlwriter_write_attribute</methodname>
<methodparam><type>resource</type><parameter>xmlwriter</parameter></methodparam>
<methodparam><type>string</type><parameter>name</parameter></methodparam>
<methodparam><type>string</type><parameter>content</parameter></methodparam>
<methodparam><type>string</type><parameter>value</parameter></methodparam>
</methodsynopsis>
&warn.undocumented.func;
<para>
Writes a full attribute.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>xmlwriter</parameter></term>
<listitem>
<para>
Its description
</para>
</listitem>
</varlistentry>
&xmlwriter.xmlwriter.description;
<varlistentry>
<term><parameter>name</parameter></term>
<listitem>
<para>
Its description
The name of the attribute.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>content</parameter></term>
<term><parameter>value</parameter></term>
<listitem>
<para>
Its description
The value of the attribute.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
What the function returns, first on success, then on failure. See
also the &amp;return.success; entity
&return.success;
</para>
</refsect1>
<!-- Use when ERRORS exist
<refsect1 role="errors">
&reftitle.errors;
<para>
When does this function throw E_* level errors, or exceptions?
</para>
</refsect1>
-->
<!-- Use when a CHANGELOG exists
<refsect1 role="changelog">
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>Enter the PHP version of change here</entry>
<entry>Description of change</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
-->
<!-- Use when examples exist
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>A <function>xmlwriter_write_attribute</function> example</title>
<para>
Any text that describes the purpose of the example, or
what goes on in the example should go here (inside the
<example> tag, not out
</para>
<programlisting role="php">
<![CDATA[
<?php
if ($anexample === true) {
echo 'Use the PEAR Coding Standards';
}
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
Use the PEAR Coding Standards
]]>
</screen>
</example>
</para>
</refsect1>
-->
<!-- Use when adding See Also links
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function></function></member>
<member>Or <link linkend="somethingelse">something else</link></member>
<member><xref linkend="function.xmlwriter-write-attribute-ns" /></member>
<member><xref linkend="function.xmlwriter-start-attribute" /></member>
<member><xref linkend="function.xmlwriter-start-attribute-ns" /></member>
<member><xref linkend="function.xmlwriter-end-attribute" /></member>
</simplelist>
</para>
</refsect1>
-->
</refentry>

110
reference/xmlwriter/functions/xmlwriter-write-cdata.xml
View file

@ -1,132 +1,64 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. -->
<refentry id="function.xmlwriter-write-cdata">
<refnamediv>
<refname>xmlwriter_write_cdata</refname>
<refpurpose>Write full CDATA tag - returns FALSE on error</refpurpose>
<refname>XMLWriter->writeCData()</refname>
<refpurpose>Write full CDATA tag</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>Object oriented style:</para>
<classsynopsis>
<ooclass><classname>XMLWriter</classname></ooclass>
<methodsynopsis>
<type>bool</type><methodname>writeCData</methodname>
<methodparam><type>string</type><parameter>content</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<para>Procedural style:</para>
<methodsynopsis>
<type>bool</type><methodname>xmlwriter_write_cdata</methodname>
<methodparam><type>resource</type><parameter>xmlwriter</parameter></methodparam>
<methodparam><type>string</type><parameter>content</parameter></methodparam>
</methodsynopsis>
&warn.undocumented.func;
<para>
Writes a full CDATA.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>xmlwriter</parameter></term>
<listitem>
<para>
Its description
</para>
</listitem>
</varlistentry>
&xmlwriter.xmlwriter.description;
<varlistentry>
<term><parameter>content</parameter></term>
<listitem>
<para>
Its description
The contents of the CDATA.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
What the function returns, first on success, then on failure. See
also the &amp;return.success; entity
&return.success;
</para>
</refsect1>
<!-- Use when ERRORS exist
<refsect1 role="errors">
&reftitle.errors;
<para>
When does this function throw E_* level errors, or exceptions?
</para>
</refsect1>
-->
<!-- Use when a CHANGELOG exists
<refsect1 role="changelog">
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>Enter the PHP version of change here</entry>
<entry>Description of change</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
-->
<!-- Use when examples exist
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>A <function>xmlwriter_write_cdata</function> example</title>
<para>
Any text that describes the purpose of the example, or
what goes on in the example should go here (inside the
<example> tag, not out
</para>
<programlisting role="php">
<![CDATA[
<?php
if ($anexample === true) {
echo 'Use the PEAR Coding Standards';
}
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
Use the PEAR Coding Standards
]]>
</screen>
</example>
</para>
</refsect1>
-->
<!-- Use when adding See Also links
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function></function></member>
<member>Or <link linkend="somethingelse">something else</link></member>
<member><xref linkend="function.xmlwriter-start-cdata" /></member>
<member><xref linkend="function.xmlwriter-end-cdata" /></member>
</simplelist>
</para>
</refsect1>
-->
</refentry>

110
reference/xmlwriter/functions/xmlwriter-write-comment.xml
View file

@ -1,132 +1,64 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. -->
<refentry id="function.xmlwriter-write-comment">
<refnamediv>
<refname>xmlwriter_write_comment</refname>
<refpurpose>Write full comment tag - returns FALSE on error</refpurpose>
<refname>XMLWriter->writeComment()</refname>
<refpurpose>Write full comment tag</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>Object oriented style:</para>
<classsynopsis>
<ooclass><classname>XMLWriter</classname></ooclass>
<methodsynopsis>
<type>bool</type><methodname>writeComment</methodname>
<methodparam><type>string</type><parameter>content</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<para>Procedural style:</para>
<methodsynopsis>
<type>bool</type><methodname>xmlwriter_write_comment</methodname>
<methodparam><type>resource</type><parameter>xmlwriter</parameter></methodparam>
<methodparam><type>string</type><parameter>content</parameter></methodparam>
</methodsynopsis>
&warn.undocumented.func;
<para>
Writes a full comment.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>xmlwriter</parameter></term>
<listitem>
<para>
Its description
</para>
</listitem>
</varlistentry>
&xmlwriter.xmlwriter.description;
<varlistentry>
<term><parameter>content</parameter></term>
<listitem>
<para>
Its description
The contents of the comment.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
What the function returns, first on success, then on failure. See
also the &amp;return.success; entity
&return.success;
</para>
</refsect1>
<!-- Use when ERRORS exist
<refsect1 role="errors">
&reftitle.errors;
<para>
When does this function throw E_* level errors, or exceptions?
</para>
</refsect1>
-->
<!-- Use when a CHANGELOG exists
<refsect1 role="changelog">
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>Enter the PHP version of change here</entry>
<entry>Description of change</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
-->
<!-- Use when examples exist
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>A <function>xmlwriter_write_comment</function> example</title>
<para>
Any text that describes the purpose of the example, or
what goes on in the example should go here (inside the
<example> tag, not out
</para>
<programlisting role="php">
<![CDATA[
<?php
if ($anexample === true) {
echo 'Use the PEAR Coding Standards';
}
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
Use the PEAR Coding Standards
]]>
</screen>
</example>
</para>
</refsect1>
-->
<!-- Use when adding See Also links
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function></function></member>
<member>Or <link linkend="somethingelse">something else</link></member>
<member><xref linkend="function.xmlwriter-start-comment" /></member>
<member><xref linkend="function.xmlwriter-end-comment" /></member>
</simplelist>
</para>
</refsect1>
-->
</refentry>

113
reference/xmlwriter/functions/xmlwriter-write-dtd-attlist.xml
View file

@ -1,40 +1,43 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. -->
<refentry id="function.xmlwriter-write-dtd-attlist">
<refnamediv>
<refname>xmlwriter_write_dtd_attlist</refname>
<refpurpose>Write full DTD AttList tag - returns FALSE on error</refpurpose>
<refname>XMLWriter->writeDTDAttlist()</refname>
<refpurpose>Write full DTD AttList tag</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>Object oriented style:</para>
<classsynopsis>
<ooclass><classname>XMLWriter</classname></ooclass>
<methodsynopsis>
<type>bool</type><methodname>writeDTDAttlist</methodname>
<methodparam><type>string</type><parameter>name</parameter></methodparam>
<methodparam><type>string</type><parameter>content</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<para>Procedural style:</para>
<methodsynopsis>
<type>bool</type><methodname>xmlwriter_write_dtd_attlist</methodname>
<methodparam><type>resource</type><parameter>xmlwriter</parameter></methodparam>
<methodparam><type>string</type><parameter>name</parameter></methodparam>
<methodparam><type>string</type><parameter>content</parameter></methodparam>
</methodsynopsis>
&warn.undocumented.func;
<para>
Writes a DTD attribute list.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>xmlwriter</parameter></term>
<listitem>
<para>
Its description
</para>
</listitem>
</varlistentry>
&xmlwriter.xmlwriter.description;
<varlistentry>
<term><parameter>name</parameter></term>
<listitem>
<para>
Its description
The name of the DTD attribute list.
</para>
</listitem>
</varlistentry>
@ -42,100 +45,30 @@
<term><parameter>content</parameter></term>
<listitem>
<para>
Its description
The content of the DTD attribute list.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
What the function returns, first on success, then on failure. See
also the &amp;return.success; entity
&return.success;
</para>
</refsect1>
<!-- Use when ERRORS exist
<refsect1 role="errors">
&reftitle.errors;
<para>
When does this function throw E_* level errors, or exceptions?
</para>
</refsect1>
-->
<!-- Use when a CHANGELOG exists
<refsect1 role="changelog">
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>Enter the PHP version of change here</entry>
<entry>Description of change</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
-->
<!-- Use when examples exist
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>A <function>xmlwriter_write_dtd_attlist</function> example</title>
<para>
Any text that describes the purpose of the example, or
what goes on in the example should go here (inside the
<example> tag, not out
</para>
<programlisting role="php">
<![CDATA[
<?php
if ($anexample === true) {
echo 'Use the PEAR Coding Standards';
}
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
Use the PEAR Coding Standards
]]>
</screen>
</example>
</para>
</refsect1>
-->
<!-- Use when adding See Also links
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function></function></member>
<member>Or <link linkend="somethingelse">something else</link></member>
<member><xref linkend="function.xmlwriter-start-dtd-attlist" /></member>
<member><xref linkend="function.xmlwriter-end-dtd-attlist" /></member>
</simplelist>
</para>
</refsect1>
-->
</refentry>

113
reference/xmlwriter/functions/xmlwriter-write-dtd-element.xml
View file

@ -1,40 +1,43 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. -->
<refentry id="function.xmlwriter-write-dtd-element">
<refnamediv>
<refname>xmlwriter_write_dtd_element</refname>
<refpurpose>Write full DTD element tag - returns FALSE on error</refpurpose>
<refname>XMLWriter->writeDTDElement()</refname>
<refpurpose>Write full DTD element tag</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>Object oriented style:</para>
<classsynopsis>
<ooclass><classname>XMLWriter</classname></ooclass>
<methodsynopsis>
<type>bool</type><methodname>writeDTDElement</methodname>
<methodparam><type>string</type><parameter>name</parameter></methodparam>
<methodparam><type>string</type><parameter>content</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<para>Procedural style:</para>
<methodsynopsis>
<type>bool</type><methodname>xmlwriter_write_dtd_element</methodname>
<methodparam><type>resource</type><parameter>xmlwriter</parameter></methodparam>
<methodparam><type>string</type><parameter>name</parameter></methodparam>
<methodparam><type>string</type><parameter>content</parameter></methodparam>
</methodsynopsis>
&warn.undocumented.func;
<para>
Writes a full DTD element.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>xmlwriter</parameter></term>
<listitem>
<para>
Its description
</para>
</listitem>
</varlistentry>
&xmlwriter.xmlwriter.description;
<varlistentry>
<term><parameter>name</parameter></term>
<listitem>
<para>
Its description
The name of the DTD element.
</para>
</listitem>
</varlistentry>
@ -42,100 +45,30 @@
<term><parameter>content</parameter></term>
<listitem>
<para>
Its description
The content of the element.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
What the function returns, first on success, then on failure. See
also the &amp;return.success; entity
&return.success;
</para>
</refsect1>
<!-- Use when ERRORS exist
<refsect1 role="errors">
&reftitle.errors;
<para>
When does this function throw E_* level errors, or exceptions?
</para>
</refsect1>
-->
<!-- Use when a CHANGELOG exists
<refsect1 role="changelog">
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>Enter the PHP version of change here</entry>
<entry>Description of change</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
-->
<!-- Use when examples exist
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>A <function>xmlwriter_write_dtd_element</function> example</title>
<para>
Any text that describes the purpose of the example, or
what goes on in the example should go here (inside the
<example> tag, not out
</para>
<programlisting role="php">
<![CDATA[
<?php
if ($anexample === true) {
echo 'Use the PEAR Coding Standards';
}
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
Use the PEAR Coding Standards
]]>
</screen>
</example>
</para>
</refsect1>
-->
<!-- Use when adding See Also links
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function></function></member>
<member>Or <link linkend="somethingelse">something else</link></member>
<member><xref linkend="function.xmlwriter-start-dtd-element" /></member>
<member><xref linkend="function.xmlwriter-end-dtd-element" /></member>
</simplelist>
</para>
</refsect1>
-->
</refentry>

113
reference/xmlwriter/functions/xmlwriter-write-dtd-entity.xml
View file

@ -1,40 +1,43 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. -->
<refentry id="function.xmlwriter-write-dtd-entity">
<refnamediv>
<refname>xmlwriter_write_dtd_entity</refname>
<refpurpose>Write full DTD Entity tag - returns FALSE on error</refpurpose>
<refname>XMLWriter->writeDTDEntity()</refname>
<refpurpose>Write full DTD Entity tag</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>Object oriented style:</para>
<classsynopsis>
<ooclass><classname>XMLWriter</classname></ooclass>
<methodsynopsis>
<type>bool</type><methodname>writeDTDEntity</methodname>
<methodparam><type>string</type><parameter>name</parameter></methodparam>
<methodparam><type>string</type><parameter>content</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<para>Procedural style:</para>
<methodsynopsis>
<type>bool</type><methodname>xmlwriter_write_dtd_entity</methodname>
<methodparam><type>resource</type><parameter>xmlwriter</parameter></methodparam>
<methodparam><type>string</type><parameter>name</parameter></methodparam>
<methodparam><type>string</type><parameter>content</parameter></methodparam>
</methodsynopsis>
&warn.undocumented.func;
<para>
Writes a full DTD entity.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>xmlwriter</parameter></term>
<listitem>
<para>
Its description
</para>
</listitem>
</varlistentry>
&xmlwriter.xmlwriter.description;
<varlistentry>
<term><parameter>name</parameter></term>
<listitem>
<para>
Its description
The name of the entity.
</para>
</listitem>
</varlistentry>
@ -42,100 +45,30 @@
<term><parameter>content</parameter></term>
<listitem>
<para>
Its description
The content of the entity.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
What the function returns, first on success, then on failure. See
also the &amp;return.success; entity
&return.success;
</para>
</refsect1>
<!-- Use when ERRORS exist
<refsect1 role="errors">
&reftitle.errors;
<para>
When does this function throw E_* level errors, or exceptions?
</para>
</refsect1>
-->
<!-- Use when a CHANGELOG exists
<refsect1 role="changelog">
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>Enter the PHP version of change here</entry>
<entry>Description of change</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
-->
<!-- Use when examples exist
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>A <function>xmlwriter_write_dtd_entity</function> example</title>
<para>
Any text that describes the purpose of the example, or
what goes on in the example should go here (inside the
<example> tag, not out
</para>
<programlisting role="php">
<![CDATA[
<?php
if ($anexample === true) {
echo 'Use the PEAR Coding Standards';
}
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
Use the PEAR Coding Standards
]]>
</screen>
</example>
</para>
</refsect1>
-->
<!-- Use when adding See Also links
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function></function></member>
<member>Or <link linkend="somethingelse">something else</link></member>
<member><xref linkend="function.xmlwriter-start-dtd-entity" /></member>
<member><xref linkend="function.xmlwriter-end-dtd-entity" /></member>
</simplelist>
</para>
</refsect1>
-->
</refentry>

127
reference/xmlwriter/functions/xmlwriter-write-dtd.xml
View file

@ -1,58 +1,63 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. -->
<refentry id="function.xmlwriter-write-dtd">
<refnamediv>
<refname>xmlwriter_write_dtd</refname>
<refpurpose>Write full DTD tag - returns FALSE on error</refpurpose>
<refname>XMLWriter->writeDTD()</refname>
<refpurpose>Write full DTD tag</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>Object oriented style:</para>
<classsynopsis>
<ooclass><classname>XMLWriter</classname></ooclass>
<methodsynopsis>
<type>bool</type><methodname>writeDTD</methodname>
<methodparam><type>string</type><parameter>name</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>publicId</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>systemId</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>subset</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<para>Procedural style:</para>
<methodsynopsis>
<type>bool</type><methodname>xmlwriter_write_dtd</methodname>
<methodparam><type>resource</type><parameter>xmlwriter</parameter></methodparam>
<methodparam><type>string</type><parameter>name</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>pubid</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>sysid</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>publicId</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>systemId</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>subset</parameter></methodparam>
</methodsynopsis>
&warn.undocumented.func;
<para>
Writes a full DTD.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>xmlwriter</parameter></term>
<listitem>
<para>
Its description
</para>
</listitem>
</varlistentry>
&xmlwriter.xmlwriter.description;
<varlistentry>
<term><parameter>name</parameter></term>
<listitem>
<para>
Its description
The DTD name.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>pubid</parameter></term>
<term><parameter>publicId</parameter></term>
<listitem>
<para>
Its description
The external subset public identifier.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>sysid</parameter></term>
<term><parameter>systemId</parameter></term>
<listitem>
<para>
Its description
The external subset system identifier.
</para>
</listitem>
</varlistentry>
@ -60,100 +65,30 @@
<term><parameter>subset</parameter></term>
<listitem>
<para>
Its description
The content of the DTD.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
What the function returns, first on success, then on failure. See
also the &amp;return.success; entity
&return.success;
</para>
</refsect1>
<!-- Use when ERRORS exist
<refsect1 role="errors">
&reftitle.errors;
<para>
When does this function throw E_* level errors, or exceptions?
</para>
</refsect1>
-->
<!-- Use when a CHANGELOG exists
<refsect1 role="changelog">
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>Enter the PHP version of change here</entry>
<entry>Description of change</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
-->
<!-- Use when examples exist
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>A <function>xmlwriter_write_dtd</function> example</title>
<para>
Any text that describes the purpose of the example, or
what goes on in the example should go here (inside the
<example> tag, not out
</para>
<programlisting role="php">
<![CDATA[
<?php
if ($anexample === true) {
echo 'Use the PEAR Coding Standards';
}
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
Use the PEAR Coding Standards
]]>
</screen>
</example>
</para>
</refsect1>
-->
<!-- Use when adding See Also links
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function></function></member>
<member>Or <link linkend="somethingelse">something else</link></member>
<member><xref linkend="function.xmlwriter-start-dtd" /></member>
<member><xref linkend="function.xmlwriter-end-dtd" /></member>
</simplelist>
</para>
</refsect1>
-->
</refentry>

120
reference/xmlwriter/functions/xmlwriter-write-element-ns.xml
View file

@ -1,13 +1,25 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. -->
<refentry id="function.xmlwriter-write-element-ns">
<refnamediv>
<refname>xmlwriter_write_element_ns</refname>
<refpurpose>Write full namesapced element tag - returns FALSE on error</refpurpose>
<refname>XMLWriter->writeElementNS()</refname>
<refpurpose>Write full namesapced element tag</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>Object oriented style:</para>
<classsynopsis>
<ooclass><classname>XMLWriter</classname></ooclass>
<methodsynopsis>
<type>bool</type><methodname>writeElementNS</methodname>
<methodparam><type>string</type><parameter>prefix</parameter></methodparam>
<methodparam><type>string</type><parameter>name</parameter></methodparam>
<methodparam><type>string</type><parameter>uri</parameter></methodparam>
<methodparam><type>string</type><parameter>content</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<para>Procedural style:</para>
<methodsynopsis>
<type>bool</type><methodname>xmlwriter_write_element_ns</methodname>
<methodparam><type>resource</type><parameter>xmlwriter</parameter></methodparam>
@ -16,27 +28,20 @@
<methodparam><type>string</type><parameter>uri</parameter></methodparam>
<methodparam><type>string</type><parameter>content</parameter></methodparam>
</methodsynopsis>
&warn.undocumented.func;
<para>
Writes a full namesapced element tag.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>xmlwriter</parameter></term>
<listitem>
<para>
Its description
</para>
</listitem>
</varlistentry>
&xmlwriter.xmlwriter.description;
<varlistentry>
<term><parameter>prefix</parameter></term>
<listitem>
<para>
Its description
The namespace prefix.
</para>
</listitem>
</varlistentry>
@ -44,7 +49,7 @@
<term><parameter>name</parameter></term>
<listitem>
<para>
Its description
The element name.
</para>
</listitem>
</varlistentry>
@ -52,7 +57,7 @@
<term><parameter>uri</parameter></term>
<listitem>
<para>
Its description
The namespace URI.
</para>
</listitem>
</varlistentry>
@ -60,100 +65,31 @@
<term><parameter>content</parameter></term>
<listitem>
<para>
Its description
The element contents.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
What the function returns, first on success, then on failure. See
also the &amp;return.success; entity
&return.success;
</para>
</refsect1>
<!-- Use when ERRORS exist
<refsect1 role="errors">
&reftitle.errors;
<para>
When does this function throw E_* level errors, or exceptions?
</para>
</refsect1>
-->
<!-- Use when a CHANGELOG exists
<refsect1 role="changelog">
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>Enter the PHP version of change here</entry>
<entry>Description of change</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
-->
<!-- Use when examples exist
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>A <function>xmlwriter_write_element_ns</function> example</title>
<para>
Any text that describes the purpose of the example, or
what goes on in the example should go here (inside the
<example> tag, not out
</para>
<programlisting role="php">
<![CDATA[
<?php
if ($anexample === true) {
echo 'Use the PEAR Coding Standards';
}
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
Use the PEAR Coding Standards
]]>
</screen>
</example>
</para>
</refsect1>
-->
<!-- Use when adding See Also links
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function></function></member>
<member>Or <link linkend="somethingelse">something else</link></member>
<member><xref linkend="function.xmlwriter-start-element-ns" /></member>
<member><xref linkend="function.xmlwriter-end-element" /></member>
<member><xref linkend="function.xmlwriter-write-element" /></member>
</simplelist>
</para>
</refsect1>
-->
</refentry>

114
reference/xmlwriter/functions/xmlwriter-write-element.xml
View file

@ -1,40 +1,43 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. -->
<refentry id="function.xmlwriter-write-element">
<refnamediv>
<refname>xmlwriter_write_element</refname>
<refpurpose>Write full element tag - returns FALSE on error</refpurpose>
<refname>XMLWriter->writeElement()</refname>
<refpurpose>Write full element tag</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>Object oriented style:</para>
<classsynopsis>
<ooclass><classname>XMLWriter</classname></ooclass>
<methodsynopsis>
<type>bool</type><methodname>writeElement</methodname>
<methodparam><type>string</type><parameter>name</parameter></methodparam>
<methodparam><type>string</type><parameter>content</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<para>Procedural style:</para>
<methodsynopsis>
<type>bool</type><methodname>xmlwriter_write_element</methodname>
<methodparam><type>resource</type><parameter>xmlwriter</parameter></methodparam>
<methodparam><type>string</type><parameter>name</parameter></methodparam>
<methodparam><type>string</type><parameter>content</parameter></methodparam>
</methodsynopsis>
&warn.undocumented.func;
<para>
Writes a full element taf.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>xmlwriter</parameter></term>
<listitem>
<para>
Its description
</para>
</listitem>
</varlistentry>
&xmlwriter.xmlwriter.description;
<varlistentry>
<term><parameter>name</parameter></term>
<listitem>
<para>
Its description
The element name.
</para>
</listitem>
</varlistentry>
@ -42,100 +45,31 @@
<term><parameter>content</parameter></term>
<listitem>
<para>
Its description
The element contents.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
What the function returns, first on success, then on failure. See
also the &amp;return.success; entity
&return.success;
</para>
</refsect1>
<!-- Use when ERRORS exist
<refsect1 role="errors">
&reftitle.errors;
<para>
When does this function throw E_* level errors, or exceptions?
</para>
</refsect1>
-->
<!-- Use when a CHANGELOG exists
<refsect1 role="changelog">
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>Enter the PHP version of change here</entry>
<entry>Description of change</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
-->
<!-- Use when examples exist
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>A <function>xmlwriter_write_element</function> example</title>
<para>
Any text that describes the purpose of the example, or
what goes on in the example should go here (inside the
<example> tag, not out
</para>
<programlisting role="php">
<![CDATA[
<?php
if ($anexample === true) {
echo 'Use the PEAR Coding Standards';
}
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
Use the PEAR Coding Standards
]]>
</screen>
</example>
</para>
</refsect1>
-->
<!-- Use when adding See Also links
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function></function></member>
<member>Or <link linkend="somethingelse">something else</link></member>
<member><xref linkend="function.xmlwriter-start-element" /></member>
<member><xref linkend="function.xmlwriter-end-element" /></member>
<member><xref linkend="function.xmlwriter-write-element-ns" /></member>
</simplelist>
</para>
</refsect1>
-->
</refentry>

113
reference/xmlwriter/functions/xmlwriter-write-pi.xml
View file

@ -1,40 +1,43 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. -->
<refentry id="function.xmlwriter-write-pi">
<refnamediv>
<refname>xmlwriter_write_pi</refname>
<refpurpose>Write full PI tag - returns FALSE on error</refpurpose>
<refname>XMLWriter->writePI()</refname>
<refpurpose>Writes a PI</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>Object oriented style:</para>
<classsynopsis>
<ooclass><classname>XMLWriter</classname></ooclass>
<methodsynopsis>
<type>bool</type><methodname>writePI</methodname>
<methodparam><type>string</type><parameter>target</parameter></methodparam>
<methodparam><type>string</type><parameter>content</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<para>Procedural style:</para>
<methodsynopsis>
<type>bool</type><methodname>xmlwriter_write_pi</methodname>
<methodparam><type>resource</type><parameter>xmlwriter</parameter></methodparam>
<methodparam><type>string</type><parameter>target</parameter></methodparam>
<methodparam><type>string</type><parameter>content</parameter></methodparam>
</methodsynopsis>
&warn.undocumented.func;
<para>
Writes a processing instruction.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>xmlwriter</parameter></term>
<listitem>
<para>
Its description
</para>
</listitem>
</varlistentry>
&xmlwriter.xmlwriter.description;
<varlistentry>
<term><parameter>target</parameter></term>
<listitem>
<para>
Its description
The target of the processing instruction.
</para>
</listitem>
</varlistentry>
@ -42,100 +45,30 @@
<term><parameter>content</parameter></term>
<listitem>
<para>
Its description
The content of the processing instruction.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
What the function returns, first on success, then on failure. See
also the &amp;return.success; entity
&return.success;
</para>
</refsect1>
<!-- Use when ERRORS exist
<refsect1 role="errors">
&reftitle.errors;
<para>
When does this function throw E_* level errors, or exceptions?
</para>
</refsect1>
-->
<!-- Use when a CHANGELOG exists
<refsect1 role="changelog">
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>Enter the PHP version of change here</entry>
<entry>Description of change</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
-->
<!-- Use when examples exist
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>A <function>xmlwriter_write_pi</function> example</title>
<para>
Any text that describes the purpose of the example, or
what goes on in the example should go here (inside the
<example> tag, not out
</para>
<programlisting role="php">
<![CDATA[
<?php
if ($anexample === true) {
echo 'Use the PEAR Coding Standards';
}
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
Use the PEAR Coding Standards
]]>
</screen>
</example>
</para>
</refsect1>
-->
<!-- Use when adding See Also links
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function></function></member>
<member>Or <link linkend="somethingelse">something else</link></member>
<member><xref linkend="function.xmlwriter-start-pi" /></member>
<member><xref linkend="function.xmlwriter-end-pi" /></member>
</simplelist>
</para>
</refsect1>
-->
</refentry>

109
reference/xmlwriter/functions/xmlwriter-write-raw.xml
View file

@ -1,132 +1,63 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. -->
<refentry id="function.xmlwriter-write-raw">
<refnamediv>
<refname>xmlwriter_write_raw</refname>
<refpurpose>Write text - returns FALSE on error</refpurpose>
<refname>XMLWriter->writeRaw()</refname>
<refpurpose>Write a raw XML text</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>Object oriented style:</para>
<classsynopsis>
<ooclass><classname>XMLWriter</classname></ooclass>
<methodsynopsis>
<type>bool</type><methodname>writeRaw</methodname>
<methodparam><type>string</type><parameter>content</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<para>Procedural style:</para>
<methodsynopsis>
<type>bool</type><methodname>xmlwriter_write_raw</methodname>
<methodparam><type>resource</type><parameter>xmlwriter</parameter></methodparam>
<methodparam><type>string</type><parameter>content</parameter></methodparam>
</methodsynopsis>
&warn.undocumented.func;
<para>
Writes a raw xml text.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>xmlwriter</parameter></term>
<listitem>
<para>
Its description
</para>
</listitem>
</varlistentry>
&xmlwriter.xmlwriter.description;
<varlistentry>
<term><parameter>content</parameter></term>
<listitem>
<para>
Its description
The text string to write.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
What the function returns, first on success, then on failure. See
also the &amp;return.success; entity
&return.success;
</para>
</refsect1>
<!-- Use when ERRORS exist
<refsect1 role="errors">
&reftitle.errors;
<para>
When does this function throw E_* level errors, or exceptions?
</para>
</refsect1>
-->
<!-- Use when a CHANGELOG exists
<refsect1 role="changelog">
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>Enter the PHP version of change here</entry>
<entry>Description of change</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
-->
<!-- Use when examples exist
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>A <function>xmlwriter_write_raw</function> example</title>
<para>
Any text that describes the purpose of the example, or
what goes on in the example should go here (inside the
<example> tag, not out
</para>
<programlisting role="php">
<![CDATA[
<?php
if ($anexample === true) {
echo 'Use the PEAR Coding Standards';
}
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
Use the PEAR Coding Standards
]]>
</screen>
</example>
</para>
</refsect1>
-->
<!-- Use when adding See Also links
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function></function></member>
<member>Or <link linkend="somethingelse">something else</link></member>
<member><xref linkend="function.xmlwriter-text" /></member>
</simplelist>
</para>
</refsect1>
-->
</refentry>

177
reference/xmlwriter/reference.xml
View file

@ -1,39 +1,186 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<!-- Purpose: xml -->
<!-- Membership: pecl -->
<!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. -->
<reference id="ref.xmlwriter">
<title>xmlwriter Functions</title>
<titleabbrev>xmlwriter</titleabbrev>
<title>XMLWriter Functions</title>
<titleabbrev>XMLWriter</titleabbrev>
<partintro>
<section id="xmlwriter.intro">
&reftitle.intro;
<para>
This is the xmlwriter extension. It
currently only lists the proto definitions.
This is the XMLWriter extension. It wraps the libxml xmlWriter API.
</para>
</section>
<section id="xmlwriter.requirements">
&reftitle.required;
<para>
To be written. For example what external libraries are required
This extension represents a writer that provides a non-cached,
forward-only means of generating streams or files containing XML data.
</para>
<para>
This extension can be used in an object oriented style or a procedural
one. Every method documented describes the alternative procedural call.
</para>
</section>
<!-- Information found in configure.xml -->
<!-- reference.xmlwriter.configure; -->
<!-- Information found in ini.xml -->
<!-- reference.xmlwriter.ini; -->
<section id='xmlwriter.classes'>
&reftitle.classes;
<para>
</para>
<section id='xmlwriter.class.xmlwriter'>
<title><classname>XMLWriter</classname></title>
<para>
</para>
<section id='xmlreader.class.xmlwriter.methods'>
&reftitle.methods;
<itemizedlist>
<listitem>
<para><xref linkend="function.xmlwriter-end-attribute" /> - End attribute</para>
</listitem>
<listitem>
<para><xref linkend="function.xmlwriter-end-cdata" /> - End current CDATA</para>
</listitem>
<listitem>
<para><xref linkend="function.xmlwriter-end-comment" /> - Create end comment</para>
</listitem>
<listitem>
<para><xref linkend="function.xmlwriter-end-document" /> - End current document</para>
</listitem>
<listitem>
<para><xref linkend="function.xmlwriter-end-dtd-attlist" /> - End current DTD AttList</para>
</listitem>
<listitem>
<para><xref linkend="function.xmlwriter-end-dtd-element" /> - End current DTD element</para>
</listitem>
<listitem>
<para><xref linkend="function.xmlwriter-end-dtd-entity" /> - End current DTD Entity</para>
</listitem>
<listitem>
<para><xref linkend="function.xmlwriter-end-dtd" /> - End current DTD</para>
</listitem>
<listitem>
<para><xref linkend="function.xmlwriter-end-element" /> - End current element</para>
</listitem>
<listitem>
<para><xref linkend="function.xmlwriter-end-pi" /> - End current PI</para>
</listitem>
<listitem>
<para><xref linkend="function.xmlwriter-flush" /> - Flush current buffer</para>
</listitem>
<listitem>
<para><xref linkend="function.xmlwriter-full-end-element" /> - End current element</para>
</listitem>
<listitem>
<para><xref linkend="function.xmlwriter-open-memory" /> - Create new xmlwriter using memory for string output</para>
</listitem>
<listitem>
<para><xref linkend="function.xmlwriter-open-uri" /> - Create new xmlwriter using source uri for output</para>
</listitem>
<listitem>
<para><xref linkend="function.xmlwriter-output-memory" /> - Returns current buffer</para>
</listitem>
<listitem>
<para><xref linkend="function.xmlwriter-set-indent-string" /> - Set string used for indenting</para>
</listitem>
<listitem>
<para><xref linkend="function.xmlwriter-set-indent" /> - Toggle indentation on/off</para>
</listitem>
<listitem>
<para><xref linkend="function.xmlwriter-start-attribute-ns" /> - Create start namespaced attribute</para>
</listitem>
<listitem>
<para><xref linkend="function.xmlwriter-start-attribute" /> - Create start attribute</para>
</listitem>
<listitem>
<para><xref linkend="function.xmlwriter-start-cdata" /> - Create start CDATA tag</para>
</listitem>
<listitem>
<para><xref linkend="function.xmlwriter-start-comment" /> - Create start comment</para>
</listitem>
<listitem>
<para><xref linkend="function.xmlwriter-start-document" /> - Create document tag</para>
</listitem>
<listitem>
<para><xref linkend="function.xmlwriter-start-dtd-attlist" /> - Create start DTD AttList</para>
</listitem>
<listitem>
<para><xref linkend="function.xmlwriter-start-dtd-element" /> - Create start DTD element</para>
</listitem>
<listitem>
<para><xref linkend="function.xmlwriter-start-dtd-entity" /> - Create start DTD Entity</para>
</listitem>
<listitem>
<para><xref linkend="function.xmlwriter-start-dtd" /> - Create start DTD tag</para>
</listitem>
<listitem>
<para><xref linkend="function.xmlwriter-start-element-ns" /> - Create start namespaced element tag</para>
</listitem>
<listitem>
<para><xref linkend="function.xmlwriter-start-element" /> - Create start element tag</para>
</listitem>
<listitem>
<para><xref linkend="function.xmlwriter-start-pi" /> - Create start PI tag</para>
</listitem>
<listitem>
<para><xref linkend="function.xmlwriter-text" /> - Write text</para>
</listitem>
<listitem>
<para><xref linkend="function.xmlwriter-write-attribute-ns" /> - Write full namespaced attribute</para>
</listitem>
<listitem>
<para><xref linkend="function.xmlwriter-write-attribute" /> - Write full attribute</para>
</listitem>
<listitem>
<para><xref linkend="function.xmlwriter-write-cdata" /> - Write full CDATA tag</para>
</listitem>
<listitem>
<para><xref linkend="function.xmlwriter-write-comment" /> - Write full comment tag</para>
</listitem>
<listitem>
<para><xref linkend="function.xmlwriter-write-dtd-attlist" /> - Write full DTD AttList tag</para>
</listitem>
<listitem>
<para><xref linkend="function.xmlwriter-write-dtd-element" /> - Write full DTD element tag</para>
</listitem>
<listitem>
<para><xref linkend="function.xmlwriter-write-dtd-entity" /> - Write full DTD Entity tag</para>
</listitem>
<listitem>
<para><xref linkend="function.xmlwriter-write-dtd" /> - Write full DTD tag</para>
</listitem>
<listitem>
<para><xref linkend="function.xmlwriter-write-element-ns" /> - Write full namesapced element tag</para>
</listitem>
<listitem>
<para><xref linkend="function.xmlwriter-write-element" /> - Write full element tag</para>
</listitem>
<listitem>
<para><xref linkend="function.xmlwriter-write-pi" /> - Writes a PI</para>
</listitem>
<listitem>
<para><xref linkend="function.xmlwriter-write-raw" /> - Write a raw XML text</para>
</listitem>
</itemizedlist>
</section>
</section>
</section>
<section id="xmlwriter.resources">
&reftitle.resources;
<para>
Type of resource types (link id, etc.) this extension returns.
There is one resource used by the procedural version of the XMLWriter
extension: returned by <function>xmlwriter_open_memory</function> or
<function>xmlwriter_open_uri</function>.
</para>
&no.resource;
</section>
<section id="xmlwriter.constants">
&reftitle.constants;
&no.constants;
</section>
</partintro>
&reference.xmlwriter.functions;
</reference>