Skip to content

Commit fecb2f5

Browse files
nielsdosnielsdos
committed
PHP 8.4: Document new XMLWriter methods
1 parent 2df0650 commit fecb2f5

File tree

4 files changed

+201
-0
lines changed

4 files changed

+201
-0
lines changed

‎reference/xmlwriter/versions.xml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,9 @@
3737
<function name="XMLWriter::startElementNs" from="PHP 5 &gt;= 5.1.2, PHP 7, PHP 8, PECL xmlwriter &gt;= 0.1.0"/>
3838
<function name="XMLWriter::startPi" from="PHP 5 &gt;= 5.1.2, PHP 7, PHP 8, PECL xmlwriter &gt;= 0.1.0"/>
3939
<function name="XMLWriter::text" from="PHP 5 &gt;= 5.1.2, PHP 7, PHP 8, PECL xmlwriter &gt;= 0.1.0"/>
40+
<function name="XMLWriter::toMemory" from="PHP 8 &gt;= 8.4.0"/>
41+
<function name="XMLWriter::toStream" from="PHP 8 &gt;= 8.4.0"/>
42+
<function name="XMLWriter::toUri" from="PHP 8 &gt;= 8.4.0"/>
4043
<function name="XMLWriter::writeAttribute" from="PHP 5 &gt;= 5.1.2, PHP 7, PHP 8, PECL xmlwriter &gt;= 0.1.0"/>
4144
<function name="XMLWriter::writeAttributeNs" from="PHP 5 &gt;= 5.1.2, PHP 7, PHP 8, PECL xmlwriter &gt;= 0.1.0"/>
4245
<function name="XMLWriter::writeCdata" from="PHP 5 &gt;= 5.1.2, PHP 7, PHP 8, PECL xmlwriter &gt;= 0.1.0"/>

‎reference/xmlwriter/xmlwriter/tomemory.xml

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
<?xml version="1.0" encoding="utf-8"?>
2+
<!-- $Revision$ -->
3+
<refentry xml:id="xmlwriter.tomemory" xmlns="http://docbook.org/ns/docbook">
4+
<refnamediv>
5+
<refname>XMLWriter::toMemory</refname>
6+
<refpurpose>Create new <classname>XMLWriter</classname> using memory for string output</refpurpose>
7+
</refnamediv>
8+
<refsect1 role="description">
9+
&reftitle.description;
10+
<methodsynopsis role="XMLWriter">
11+
<modifier>public</modifier> <modifier>static</modifier> <type>static</type><methodname>XMLWriter::toMemory</methodname>
12+
<void/>
13+
</methodsynopsis>
14+
<simpara>
15+
Creates a new <classname>XMLWriter</classname> using memory for string output.
16+
</simpara>
17+
</refsect1>
18+
<refsect1 role="parameters">
19+
&reftitle.parameters;
20+
&no.function.parameters;
21+
</refsect1>
22+
23+
<refsect1 role="returnvalues">
24+
&reftitle.returnvalues;
25+
<simpara>
26+
Returns an <classname>XMLWriter</classname>.
27+
</simpara>
28+
</refsect1>
29+
30+
<refsect1 role="seealso">
31+
&reftitle.seealso;
32+
<simplelist>
33+
<member><methodname>XMLWriter::toStream</methodname></member>
34+
<member><methodname>XMLWriter::toUri</methodname></member>
35+
</simplelist>
36+
</refsect1>
37+
38+
</refentry>
39+
<!-- Keep this comment at the end of the file
40+
Local variables:
41+
mode: sgml
42+
sgml-omittag:t
43+
sgml-shorttag:t
44+
sgml-minimize-attributes:nil
45+
sgml-always-quote-attributes:t
46+
sgml-indent-step:1
47+
sgml-indent-data:t
48+
indent-tabs-mode:nil
49+
sgml-parent-document:nil
50+
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
51+
sgml-exposed-tags:nil
52+
sgml-local-catalogs:nil
53+
sgml-local-ecat-files:nil
54+
End:
55+
vim600: syn=xml fen fdm=syntax fdl=2 si
56+
vim: et tw=78 syn=sgml
57+
vi: ts=1 sw=1
58+
-->

‎reference/xmlwriter/xmlwriter/tostream.xml

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
<?xml version="1.0" encoding="utf-8"?>
2+
<!-- $Revision$ -->
3+
<refentry xml:id="xmlwriter.tostream" xmlns="http://docbook.org/ns/docbook">
4+
<refnamediv>
5+
<refname>XMLWriter::toStream</refname>
6+
<refpurpose>Create new <classname>XMLWriter</classname> using a stream for output</refpurpose>
7+
</refnamediv>
8+
<refsect1 role="description">
9+
&reftitle.description;
10+
<methodsynopsis role="XMLWriter">
11+
<modifier>public</modifier> <modifier>static</modifier> <type>static</type><methodname>XMLWriter::toStream</methodname>
12+
<methodparam><type>resource</type><parameter>stream</parameter></methodparam>
13+
</methodsynopsis>
14+
<simpara>
15+
Creates a new <classname>XMLWriter</classname> using a stream for output.
16+
</simpara>
17+
</refsect1>
18+
19+
<refsect1 role="parameters">
20+
&reftitle.parameters;
21+
<variablelist>
22+
<varlistentry>
23+
<term><parameter>stream</parameter></term>
24+
<listitem>
25+
<simpara>
26+
The stream to use for output.
27+
</simpara>
28+
</listitem>
29+
</varlistentry>
30+
</variablelist>
31+
</refsect1>
32+
33+
<refsect1 role="returnvalues">
34+
&reftitle.returnvalues;
35+
<simpara>
36+
Returns an <classname>XMLWriter</classname>.
37+
</simpara>
38+
</refsect1>
39+
40+
<refsect1 role="errors">
41+
&reftitle.errors;
42+
<itemizedlist>
43+
<listitem>
44+
<simpara>
45+
Passing a resource that is not a stream to <parameter>stream</parameter>
46+
will throw a <exceptionname>TypeError</exceptionname>.
47+
</simpara>
48+
</listitem>
49+
</itemizedlist>
50+
</refsect1>
51+
52+
<refsect1 role="seealso">
53+
&reftitle.seealso;
54+
<simplelist>
55+
<member><methodname>XMLWriter::toMemory</methodname></member>
56+
<member><methodname>XMLWriter::toUri</methodname></member>
57+
</simplelist>
58+
</refsect1>
59+
60+
</refentry>
61+
<!-- Keep this comment at the end of the file
62+
Local variables:
63+
mode: sgml
64+
sgml-omittag:t
65+
sgml-shorttag:t
66+
sgml-minimize-attributes:nil
67+
sgml-always-quote-attributes:t
68+
sgml-indent-step:1
69+
sgml-indent-data:t
70+
indent-tabs-mode:nil
71+
sgml-parent-document:nil
72+
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
73+
sgml-exposed-tags:nil
74+
sgml-local-catalogs:nil
75+
sgml-local-ecat-files:nil
76+
End:
77+
vim600: syn=xml fen fdm=syntax fdl=2 si
78+
vim: et tw=78 syn=sgml
79+
vi: ts=1 sw=1
80+
-->

‎reference/xmlwriter/xmlwriter/touri.xml

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
<?xml version="1.0" encoding="utf-8"?>
2+
<!-- $Revision$ -->
3+
<refentry xml:id="xmlwriter.touri" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
4+
<refnamediv>
5+
<refname>XMLWriter::toUri</refname>
6+
<refpurpose>Create new <classname>XMLWriter</classname> using a URI for output</refpurpose>
7+
</refnamediv>
8+
<refsect1 role="description">
9+
&reftitle.description;
10+
<methodsynopsis role="XMLWriter">
11+
<modifier>public</modifier> <modifier>static</modifier> <type>static</type><methodname>XMLWriter::toUri</methodname>
12+
<methodparam><type>string</type><parameter>uri</parameter></methodparam>
13+
</methodsynopsis>
14+
<simpara>
15+
Creates a new <classname>XMLWriter</classname> using a URI for output.
16+
</simpara>
17+
</refsect1>
18+
19+
<refsect1 role="parameters">
20+
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('xmlwriter.openuri')/db:refsect1[@role='parameters']/*)">
21+
<xi:fallback/>
22+
</xi:include>
23+
</refsect1>
24+
25+
<refsect1 role="returnvalues">
26+
&reftitle.returnvalues;
27+
<simpara>
28+
Returns an <classname>XMLWriter</classname>.
29+
</simpara>
30+
</refsect1>
31+
32+
<refsect1 role="seealso">
33+
&reftitle.seealso;
34+
<simplelist>
35+
<member><methodname>XMLWriter::toMemory</methodname></member>
36+
<member><methodname>XMLWriter::toStream</methodname></member>
37+
</simplelist>
38+
</refsect1>
39+
40+
</refentry>
41+
<!-- Keep this comment at the end of the file
42+
Local variables:
43+
mode: sgml
44+
sgml-omittag:t
45+
sgml-shorttag:t
46+
sgml-minimize-attributes:nil
47+
sgml-always-quote-attributes:t
48+
sgml-indent-step:1
49+
sgml-indent-data:t
50+
indent-tabs-mode:nil
51+
sgml-parent-document:nil
52+
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
53+
sgml-exposed-tags:nil
54+
sgml-local-catalogs:nil
55+
sgml-local-ecat-files:nil
56+
End:
57+
vim600: syn=xml fen fdm=syntax fdl=2 si
58+
vim: et tw=78 syn=sgml
59+
vi: ts=1 sw=1
60+
-->

0 commit comments

Comments
 (0)