Skip to content

Commit 73948b4

Browse files
committed
PHP 8.4: New XML{Reader,Writer} methods
php/doc-en@2f92a27
1 parent 1591359 commit 73948b4

File tree

6 files changed

+466
-0
lines changed

6 files changed

+466
-0
lines changed
Lines changed: 114 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,114 @@
1+
<?xml version="1.0" encoding="utf-8"?>
2+
<!-- $Revision$ -->
3+
<!-- EN-Revision: 2f92a27cd53d6f81d77078c603bec626c8e96d54 Maintainer: mumumu Status: ready -->
4+
<refentry xml:id="xmlreader.fromstream" xmlns="http://docbook.org/ns/docbook">
5+
<refnamediv>
6+
<refname>XMLReader::fromStream</refname>
7+
<refpurpose>読み取り先のストリームから、<classname>XMLReader</classname> を作成する</refpurpose>
8+
</refnamediv>
9+
10+
<refsect1 role="description">
11+
&reftitle.description;
12+
<methodsynopsis role="XMLReader">
13+
<modifier>public</modifier> <modifier>static</modifier> <type>static</type><methodname>XMLReader::fromStream</methodname>
14+
<methodparam><type>resource</type><parameter>stream</parameter></methodparam>
15+
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>encoding</parameter><initializer>&null;</initializer></methodparam>
16+
<methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>0</initializer></methodparam>
17+
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>documentUri</parameter><initializer>&null;</initializer></methodparam>
18+
</methodsynopsis>
19+
<simpara>
20+
読み取り先のストリームから、<classname>XMLReader</classname> を作成します。
21+
</simpara>
22+
</refsect1>
23+
24+
<refsect1 role="parameters">
25+
&reftitle.parameters;
26+
<variablelist>
27+
<varlistentry>
28+
<term><parameter>stream</parameter></term>
29+
<listitem>
30+
<simpara>
31+
XML を読み取るストリーム
32+
</simpara>
33+
</listitem>
34+
</varlistentry>
35+
<varlistentry>
36+
<term><parameter>encoding</parameter></term>
37+
<listitem>
38+
<simpara>
39+
XML文書 のエンコーディング、または &null;
40+
</simpara>
41+
</listitem>
42+
</varlistentry>
43+
<varlistentry>
44+
<term><parameter>flags</parameter></term>
45+
<listitem>
46+
<simpara>
47+
定数 <constant>LIBXML_<replaceable>*</replaceable></constant> からなるビットマスク
48+
</simpara>
49+
</listitem>
50+
</varlistentry>
51+
<varlistentry>
52+
<term><parameter>documentUri</parameter></term>
53+
<listitem>
54+
<simpara>
55+
オプションの document base URI
56+
</simpara>
57+
</listitem>
58+
</varlistentry>
59+
</variablelist>
60+
</refsect1>
61+
62+
<refsect1 role="returnvalues">
63+
&reftitle.returnvalues;
64+
<simpara>
65+
Returns an <classname>XMLReader</classname>.
66+
</simpara>
67+
</refsect1>
68+
69+
<refsect1 role="errors">
70+
&reftitle.errors;
71+
<itemizedlist>
72+
<listitem>
73+
<simpara>
74+
不正な <parameter>encoding</parameter> を渡すと、
75+
<exceptionname>ValueError</exceptionname> をスローします。
76+
</simpara>
77+
</listitem>
78+
<listitem>
79+
<simpara>
80+
ストリームでないリソースを <parameter>stream</parameter> に渡すと、
81+
<exceptionname>TypeError</exceptionname> をスローします。
82+
</simpara>
83+
</listitem>
84+
</itemizedlist>
85+
</refsect1>
86+
87+
<refsect1 role="seealso">
88+
&reftitle.seealso;
89+
<simplelist>
90+
<member><methodname>XMLReader::fromString</methodname></member>
91+
<member><methodname>XMLReader::fromUri</methodname></member>
92+
</simplelist>
93+
</refsect1>
94+
</refentry>
95+
<!-- Keep this comment at the end of the file
96+
Local variables:
97+
mode: sgml
98+
sgml-omittag:t
99+
sgml-shorttag:t
100+
sgml-minimize-attributes:nil
101+
sgml-always-quote-attributes:t
102+
sgml-indent-step:1
103+
sgml-indent-data:t
104+
indent-tabs-mode:nil
105+
sgml-parent-document:nil
106+
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
107+
sgml-exposed-tags:nil
108+
sgml-local-catalogs:nil
109+
sgml-local-ecat-files:nil
110+
End:
111+
vim600: syn=xml fen fdm=syntax fdl=2 si
112+
vim: et tw=78 syn=sgml
113+
vi: ts=1 sw=1
114+
-->
Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
<?xml version="1.0" encoding="utf-8"?>
2+
<!-- $Revision$ -->
3+
<!-- EN-Revision: 2df06506a7abf6f41bcbcc122880f53fc8823171 Maintainer: mumumu Status: ready -->
4+
<refentry xml:id="xmlreader.fromstring" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
5+
<refnamediv>
6+
<refname>XMLReader::fromString</refname>
7+
<refpurpose>XML 文字列から、<classname>XMLReader</classname> を作成する</refpurpose>
8+
</refnamediv>
9+
10+
<refsect1 role="description">
11+
&reftitle.description;
12+
<methodsynopsis role="XMLReader">
13+
<modifier>public</modifier> <modifier>static</modifier> <type>static</type><methodname>XMLReader::fromString</methodname>
14+
<methodparam><type>string</type><parameter>source</parameter></methodparam>
15+
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>encoding</parameter><initializer>&null;</initializer></methodparam>
16+
<methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>0</initializer></methodparam>
17+
</methodsynopsis>
18+
<simpara>
19+
XML 文字列から、<classname>XMLReader</classname> を作成します。
20+
</simpara>
21+
</refsect1>
22+
23+
<refsect1 role="parameters">
24+
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('xmlreader.xml')/db:refsect1[@role='parameters']/*)">
25+
<xi:fallback/>
26+
</xi:include>
27+
</refsect1>
28+
29+
<refsect1 role="returnvalues">
30+
&reftitle.returnvalues;
31+
<simpara>
32+
<classname>XMLReader</classname> を返します。
33+
</simpara>
34+
</refsect1>
35+
36+
<refsect1 role="errors">
37+
&reftitle.errors;
38+
<itemizedlist>
39+
<listitem>
40+
<simpara>
41+
不正な <parameter>encoding</parameter> を渡すと、
42+
<exceptionname>ValueError</exceptionname> をスローします。
43+
</simpara>
44+
</listitem>
45+
</itemizedlist>
46+
</refsect1>
47+
48+
<refsect1 role="seealso">
49+
&reftitle.seealso;
50+
<simplelist>
51+
<member><methodname>XMLReader::fromStream</methodname></member>
52+
<member><methodname>XMLReader::fromUri</methodname></member>
53+
</simplelist>
54+
</refsect1>
55+
</refentry>
56+
<!-- Keep this comment at the end of the file
57+
Local variables:
58+
mode: sgml
59+
sgml-omittag:t
60+
sgml-shorttag:t
61+
sgml-minimize-attributes:nil
62+
sgml-always-quote-attributes:t
63+
sgml-indent-step:1
64+
sgml-indent-data:t
65+
indent-tabs-mode:nil
66+
sgml-parent-document:nil
67+
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
68+
sgml-exposed-tags:nil
69+
sgml-local-catalogs:nil
70+
sgml-local-ecat-files:nil
71+
End:
72+
vim600: syn=xml fen fdm=syntax fdl=2 si
73+
vim: et tw=78 syn=sgml
74+
vi: ts=1 sw=1
75+
-->
Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
<?xml version="1.0" encoding="utf-8"?>
2+
<!-- $Revision$ -->
3+
<!-- EN-Revision: 2df06506a7abf6f41bcbcc122880f53fc8823171 Maintainer: mumumu Status: ready -->
4+
<refentry xml:id="xmlreader.fromuri" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
5+
<refnamediv>
6+
<refname>XMLReader::fromUri</refname>
7+
<refpurpose>読み取り先の URI から、<classname>XMLReader</classname> を作成する</refpurpose>
8+
</refnamediv>
9+
10+
<refsect1 role="description">
11+
&reftitle.description;
12+
<methodsynopsis role="XMLReader">
13+
<modifier>public</modifier> <modifier>static</modifier> <type>static</type><methodname>XMLReader::fromUri</methodname>
14+
<methodparam><type>string</type><parameter>uri</parameter></methodparam>
15+
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>encoding</parameter><initializer>&null;</initializer></methodparam>
16+
<methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>0</initializer></methodparam>
17+
</methodsynopsis>
18+
<simpara>
19+
読み取り先の URI から、<classname>XMLReader</classname> を作成します。
20+
</simpara>
21+
</refsect1>
22+
23+
<refsect1 role="parameters">
24+
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('xmlreader.open')/db:refsect1[@role='parameters']/*)">
25+
<xi:fallback/>
26+
</xi:include>
27+
</refsect1>
28+
29+
<refsect1 role="returnvalues">
30+
&reftitle.returnvalues;
31+
<simpara>
32+
<classname>XMLReader</classname> を返します。
33+
</simpara>
34+
</refsect1>
35+
36+
<refsect1 role="errors">
37+
&reftitle.errors;
38+
<itemizedlist>
39+
<listitem>
40+
<simpara>
41+
不正な <parameter>encoding</parameter> を渡すと、
42+
<exceptionname>ValueError</exceptionname> をスローします。
43+
</simpara>
44+
</listitem>
45+
</itemizedlist>
46+
</refsect1>
47+
48+
<refsect1 role="seealso">
49+
&reftitle.seealso;
50+
<simplelist>
51+
<member><methodname>XMLReader::fromStream</methodname></member>
52+
<member><methodname>XMLReader::fromString</methodname></member>
53+
</simplelist>
54+
</refsect1>
55+
</refentry>
56+
<!-- Keep this comment at the end of the file
57+
Local variables:
58+
mode: sgml
59+
sgml-omittag:t
60+
sgml-shorttag:t
61+
sgml-minimize-attributes:nil
62+
sgml-always-quote-attributes:t
63+
sgml-indent-step:1
64+
sgml-indent-data:t
65+
indent-tabs-mode:nil
66+
sgml-parent-document:nil
67+
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
68+
sgml-exposed-tags:nil
69+
sgml-local-catalogs:nil
70+
sgml-local-ecat-files:nil
71+
End:
72+
vim600: syn=xml fen fdm=syntax fdl=2 si
73+
vim: et tw=78 syn=sgml
74+
vi: ts=1 sw=1
75+
-->
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+
<!-- EN-Revision: 2f92a27cd53d6f81d77078c603bec626c8e96d54 Maintainer: mumumu Status: ready -->
4+
<refentry xml:id="xmlwriter.tomemory" xmlns="http://docbook.org/ns/docbook">
5+
<refnamediv>
6+
<refname>XMLWriter::toMemory</refname>
7+
<refpurpose>文字列出力先のメモリを使い、新しい <classname>XMLWriter</classname> を作成する</refpurpose>
8+
</refnamediv>
9+
<refsect1 role="description">
10+
&reftitle.description;
11+
<methodsynopsis role="XMLWriter">
12+
<modifier>public</modifier> <modifier>static</modifier> <type>static</type><methodname>XMLWriter::toMemory</methodname>
13+
<void/>
14+
</methodsynopsis>
15+
<simpara>
16+
文字列出力先のメモリを使い、<classname>XMLWriter</classname> を作成します。
17+
</simpara>
18+
</refsect1>
19+
20+
<refsect1 role="parameters">
21+
&reftitle.parameters;
22+
&no.function.parameters;
23+
</refsect1>
24+
25+
<refsect1 role="returnvalues">
26+
&reftitle.returnvalues;
27+
<simpara>
28+
<classname>XMLWriter</classname> を返します。
29+
</simpara>
30+
</refsect1>
31+
32+
<refsect1 role="seealso">
33+
&reftitle.seealso;
34+
<simplelist>
35+
<member><methodname>XMLWriter::toStream</methodname></member>
36+
<member><methodname>XMLWriter::toUri</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)