Skip to content

Commit f254007

Browse files
ndosschendossche
committed
PHP 8.4: Document new XMLReader methods
1 parent 61e2ab1 commit f254007

File tree

4 files changed

+263
-0
lines changed

4 files changed

+263
-0
lines changed

‎reference/xmlreader/versions.xml‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,9 @@
88
<function name="xmlreader" from="PHP 5 &gt;= 5.1.0, PHP 7, PHP 8"/>
99
<function name="xmlreader::close" from="PHP 5 &gt;= 5.1.0, PHP 7, PHP 8"/>
1010
<function name="xmlreader::expand" from="PHP 5 &gt;= 5.1.0, PHP 7, PHP 8"/>
11+
<function name="xmlreader::fromstream" from="PHP 8 &gt;= 8.4.0"/>
12+
<function name="xmlreader::fromstring" from="PHP 8 &gt;= 8.4.0"/>
13+
<function name="xmlreader::fromuri" from="PHP 8 &gt;= 8.4.0"/>
1114
<function name="xmlreader::getattribute" from="PHP 5 &gt;= 5.1.0, PHP 7, PHP 8"/>
1215
<function name="xmlreader::getattributeno" from="PHP 5 &gt;= 5.1.0, PHP 7, PHP 8"/>
1316
<function name="xmlreader::getattributens" from="PHP 5 &gt;= 5.1.0, PHP 7, PHP 8"/>

‎reference/xmlreader/xmlreader/fromstream.xml‎

Lines changed: 116 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,116 @@
1+
<?xml version="1.0" encoding="utf-8"?>
2+
<!-- $Revision$ -->
3+
<refentry xml:id="xmlreader.fromstream" xmlns="http://docbook.org/ns/docbook">
4+
<refnamediv>
5+
<refname>XMLReader::fromStream</refname>
6+
<refpurpose>Creates an <classname>XMLReader</classname> from a stream to read from</refpurpose>
7+
</refnamediv>
8+
9+
<refsect1 role="description">
10+
&reftitle.description;
11+
<methodsynopsis role="XMLReader">
12+
<modifier>public</modifier> <modifier>static</modifier> <type>static</type><methodname>XMLReader::fromStream</methodname>
13+
<methodparam><type>resource</type><parameter>stream</parameter></methodparam>
14+
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>encoding</parameter><initializer>&null;</initializer></methodparam>
15+
<methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>0</initializer></methodparam>
16+
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>documentUri</parameter><initializer>&null;</initializer></methodparam>
17+
</methodsynopsis>
18+
<simpara>
19+
Creates an <classname>XMLReader</classname> from a stream to read from.
20+
</simpara>
21+
</refsect1>
22+
23+
<refsect1 role="parameters">
24+
&reftitle.parameters;
25+
<para>
26+
<variablelist>
27+
<varlistentry>
28+
<term><parameter>stream</parameter></term>
29+
<listitem>
30+
<para>
31+
The stream to read the XML from.
32+
</para>
33+
</listitem>
34+
</varlistentry>
35+
<varlistentry>
36+
<term><parameter>encoding</parameter></term>
37+
<listitem>
38+
<para>
39+
The document encoding or &null;.
40+
</para>
41+
</listitem>
42+
</varlistentry>
43+
<varlistentry>
44+
<term><parameter>flags</parameter></term>
45+
<listitem>
46+
<para>
47+
A bitmask of the <link linkend="libxml.constants">LIBXML_*</link>
48+
constants.
49+
</para>
50+
</listitem>
51+
</varlistentry>
52+
<varlistentry>
53+
<term><parameter>documentUri</parameter></term>
54+
<listitem>
55+
<para>
56+
Optional document base URI.
57+
</para>
58+
</listitem>
59+
</varlistentry>
60+
</variablelist>
61+
</para>
62+
</refsect1>
63+
64+
<refsect1 role="returnvalues">
65+
&reftitle.returnvalues;
66+
<simpara>
67+
Returns an <classname>XMLReader</classname>.
68+
</simpara>
69+
</refsect1>
70+
71+
<refsect1 role="errors">
72+
&reftitle.errors;
73+
<itemizedlist>
74+
<listitem>
75+
<simpara>
76+
Passing an invalid <parameter>encoding</parameter> will throw a
77+
<exceptionname>ValueError</exceptionname>.
78+
</simpara>
79+
</listitem>
80+
<listitem>
81+
<simpara>
82+
Passing a resource that is not a stream to <parameter>stream</parameter>
83+
will throw a <exceptionname>TypeError</exceptionname>.
84+
</simpara>
85+
</listitem>
86+
</itemizedlist>
87+
</refsect1>
88+
89+
<refsect1 role="seealso">
90+
&reftitle.seealso;
91+
<simplelist>
92+
<member><methodname>XMLReader::fromString</methodname></member>
93+
<member><methodname>XMLReader::fromUri</methodname></member>
94+
</simplelist>
95+
</refsect1>
96+
</refentry>
97+
<!-- Keep this comment at the end of the file
98+
Local variables:
99+
mode: sgml
100+
sgml-omittag:t
101+
sgml-shorttag:t
102+
sgml-minimize-attributes:nil
103+
sgml-always-quote-attributes:t
104+
sgml-indent-step:1
105+
sgml-indent-data:t
106+
indent-tabs-mode:nil
107+
sgml-parent-document:nil
108+
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
109+
sgml-exposed-tags:nil
110+
sgml-local-catalogs:nil
111+
sgml-local-ecat-files:nil
112+
End:
113+
vim600: syn=xml fen fdm=syntax fdl=2 si
114+
vim: et tw=78 syn=sgml
115+
vi: ts=1 sw=1
116+
-->

‎reference/xmlreader/xmlreader/fromstring.xml‎

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
<?xml version="1.0" encoding="utf-8"?>
2+
<!-- $Revision$ -->
3+
<refentry xml:id="xmlreader.fromstring" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
4+
<refnamediv>
5+
<refname>XMLReader::fromString</refname>
6+
<refpurpose>Creates an <classname>XMLReader</classname> from an XML string</refpurpose>
7+
</refnamediv>
8+
9+
<refsect1 role="description">
10+
&reftitle.description;
11+
<methodsynopsis role="XMLReader">
12+
<modifier>public</modifier> <modifier>static</modifier> <type>static</type><methodname>XMLReader::fromString</methodname>
13+
<methodparam><type>string</type><parameter>source</parameter></methodparam>
14+
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>encoding</parameter><initializer>&null;</initializer></methodparam>
15+
<methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>0</initializer></methodparam>
16+
</methodsynopsis>
17+
<simpara>
18+
Creates an <classname>XMLReader</classname> from an XML string.
19+
</simpara>
20+
</refsect1>
21+
22+
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('xmlreader.xml')/db:refsect1[@role='parameters'])">
23+
<xi:fallback/>
24+
</xi:include>
25+
26+
<refsect1 role="returnvalues">
27+
&reftitle.returnvalues;
28+
<simpara>
29+
Returns an <classname>XMLReader</classname>.
30+
</simpara>
31+
</refsect1>
32+
33+
<refsect1 role="errors">
34+
&reftitle.errors;
35+
<itemizedlist>
36+
<listitem>
37+
<simpara>
38+
Passing an invalid <parameter>encoding</parameter> will throw a
39+
<exceptionname>ValueError</exceptionname>.
40+
</simpara>
41+
</listitem>
42+
</itemizedlist>
43+
</refsect1>
44+
45+
<refsect1 role="seealso">
46+
&reftitle.seealso;
47+
<simplelist>
48+
<member><methodname>XMLReader::fromStream</methodname></member>
49+
<member><methodname>XMLReader::fromUri</methodname></member>
50+
</simplelist>
51+
</refsect1>
52+
</refentry>
53+
<!-- Keep this comment at the end of the file
54+
Local variables:
55+
mode: sgml
56+
sgml-omittag:t
57+
sgml-shorttag:t
58+
sgml-minimize-attributes:nil
59+
sgml-always-quote-attributes:t
60+
sgml-indent-step:1
61+
sgml-indent-data:t
62+
indent-tabs-mode:nil
63+
sgml-parent-document:nil
64+
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
65+
sgml-exposed-tags:nil
66+
sgml-local-catalogs:nil
67+
sgml-local-ecat-files:nil
68+
End:
69+
vim600: syn=xml fen fdm=syntax fdl=2 si
70+
vim: et tw=78 syn=sgml
71+
vi: ts=1 sw=1
72+
-->

‎reference/xmlreader/xmlreader/fromuri.xml‎

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
<?xml version="1.0" encoding="utf-8"?>
2+
<!-- $Revision$ -->
3+
<refentry xml:id="xmlreader.fromuri" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
4+
<refnamediv>
5+
<refname>XMLReader::fromUri</refname>
6+
<refpurpose>Creates an <classname>XMLReader</classname> from a URI to read from</refpurpose>
7+
</refnamediv>
8+
9+
<refsect1 role="description">
10+
&reftitle.description;
11+
<methodsynopsis role="XMLReader">
12+
<modifier>public</modifier> <modifier>static</modifier> <type>static</type><methodname>XMLReader::fromUri</methodname>
13+
<methodparam><type>string</type><parameter>uri</parameter></methodparam>
14+
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>encoding</parameter><initializer>&null;</initializer></methodparam>
15+
<methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>0</initializer></methodparam>
16+
</methodsynopsis>
17+
<simpara>
18+
Creates an <classname>XMLReader</classname> from a URI to read from.
19+
</simpara>
20+
</refsect1>
21+
22+
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('xmlreader.open')/db:refsect1[@role='parameters'])">
23+
<xi:fallback/>
24+
</xi:include>
25+
26+
<refsect1 role="returnvalues">
27+
&reftitle.returnvalues;
28+
<simpara>
29+
Returns an <classname>XMLReader</classname>.
30+
</simpara>
31+
</refsect1>
32+
33+
<refsect1 role="errors">
34+
&reftitle.errors;
35+
<itemizedlist>
36+
<listitem>
37+
<simpara>
38+
Passing an invalid <parameter>encoding</parameter> will throw a
39+
<exceptionname>ValueError</exceptionname>.
40+
</simpara>
41+
</listitem>
42+
</itemizedlist>
43+
</refsect1>
44+
45+
<refsect1 role="seealso">
46+
&reftitle.seealso;
47+
<simplelist>
48+
<member><methodname>XMLReader::fromStream</methodname></member>
49+
<member><methodname>XMLReader::fromString</methodname></member>
50+
</simplelist>
51+
</refsect1>
52+
</refentry>
53+
<!-- Keep this comment at the end of the file
54+
Local variables:
55+
mode: sgml
56+
sgml-omittag:t
57+
sgml-shorttag:t
58+
sgml-minimize-attributes:nil
59+
sgml-always-quote-attributes:t
60+
sgml-indent-step:1
61+
sgml-indent-data:t
62+
indent-tabs-mode:nil
63+
sgml-parent-document:nil
64+
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
65+
sgml-exposed-tags:nil
66+
sgml-local-catalogs:nil
67+
sgml-local-ecat-files:nil
68+
End:
69+
vim600: syn=xml fen fdm=syntax fdl=2 si
70+
vim: et tw=78 syn=sgml
71+
vi: ts=1 sw=1
72+
-->

0 commit comments

Comments
 (0)