reference/xml/functions/xml-set-unparsed-entity-decl-handler.xml
5a14f904d231d294e2e5b4fb5d2fc4d2fd9eddee
...
...
@@ -1,8 +1,6 @@
1
1
<?xml version="1.0" encoding="utf-8"?>
2
2
<!-- $Revision$ -->
3
-
<refentry xmlns="http://docbook.org/ns/docbook"
4
-
xml:id="function.xml-set-unparsed-entity-decl-handler"
5
-
xmlns:xlink="http://www.w3.org/1999/xlink">
3
+
<refentry xml:id="function.xml-set-unparsed-entity-decl-handler" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
6
4
<refnamediv>
7
5
<refname>xml_set_unparsed_entity_decl_handler</refname>
8
6
<refpurpose>
...
...
@@ -13,8 +11,8 @@
13
11
<refsect1 role="description">
14
12
&reftitle.description;
15
13
<methodsynopsis>
16
-
<type>bool</type><methodname>xml_set_unparsed_entity_decl_handler</methodname>
17
-
<methodparam><type>resource</type><parameter>parser</parameter></methodparam>
14
+
<type>true</type><methodname>xml_set_unparsed_entity_decl_handler</methodname>
15
+
<methodparam><type>XMLParser</type><parameter>parser</parameter></methodparam>
18
16
<methodparam><type>callable</type><parameter>handler</parameter></methodparam>
19
17
</methodsynopsis>
20
18
<para>
...
...
@@ -43,45 +41,24 @@
43
41
&reftitle.parameters;
44
42
<para>
45
43
<variablelist>
46
-
<varlistentry>
47
-
<term><parameter>parser</parameter></term>
48
-
<listitem>
49
-
<para>
50
-
A reference to the XML parser to set up unparsed entity declaration handler function.
51
-
</para>
52
-
</listitem>
53
-
</varlistentry>
44
+
&xml.parser.param;
54
45
<varlistentry>
55
46
<term><parameter>handler</parameter></term>
56
47
<listitem>
48
+
&xml.handler.description;
57
49
<para>
58
-
<parameter>handler</parameter> is a string containing the name of a
59
-
function that must exist when <function>xml_parse</function> is called
60
-
for <parameter>parser</parameter>.
61
-
</para>
62
-
<para>
63
-
The function named by <parameter>handler</parameter> must accept six
64
-
parameters:
50
+
The signature of the handler must be:
65
51
<methodsynopsis>
66
-
<methodname><replaceable>handler</replaceable></methodname>
67
-
<methodparam><type>resource</type><parameter>parser</parameter></methodparam>
52
+
<type>void</type><methodname><replaceable>handler</replaceable></methodname>
53
+
<methodparam><type>XMLParser</type><parameter>parser</parameter></methodparam>
68
54
<methodparam><type>string</type><parameter>entity_name</parameter></methodparam>
69
-
<methodparam><type>string</type><parameter>base</parameter></methodparam>
55
+
<methodparam><type class="union"><type>string</type><type>false</type></type><parameter>base</parameter></methodparam>
70
56
<methodparam><type>string</type><parameter>system_id</parameter></methodparam>
71
-
<methodparam><type>string</type><parameter>public_id</parameter></methodparam>
72
-
<methodparam><type>string</type><parameter>notation_name</parameter></methodparam>
57
+
<methodparam><type class="union"><type>string</type><type>false</type></type><parameter>public_id</parameter></methodparam>
58
+
<methodparam><type class="union"><type>string</type><type>false</type></type><parameter>notation_name</parameter></methodparam>
73
59
</methodsynopsis>
74
60
<variablelist>
75
-
<varlistentry>
76
-
<term><parameter>parser</parameter></term>
77
-
<listitem>
78
-
<simpara>
79
-
The first parameter, <replaceable>parser</replaceable>, is a
80
-
reference to the XML parser calling the
81
-
handler.
82
-
</simpara>
83
-
</listitem>
84
-
</varlistentry>
61
+
&xml.handler.parser.param;
85
62
<varlistentry>
86
63
<term><parameter>entity_name</parameter></term>
87
64
<listitem>
...
...
@@ -95,8 +72,7 @@
95
72
<listitem>
96
73
<simpara>
97
74
This is the base for resolving the system identifier
98
-
(<parameter>systemId</parameter>) of the external entity.Currently
99
-
this parameter will always be set to an empty string.
75
+
(<parameter>systemId</parameter>) of the external entity.
100
76
</simpara>
101
77
</listitem>
102
78
</varlistentry>
...
...
@@ -127,11 +103,6 @@
127
103
</varlistentry>
128
104
</variablelist>
129
105
</para>
130
-
<para>
131
-
If a handler function is set to an empty string, or &false;, the handler
132
-
in question is disabled.
133
-
</para>
134
-
&note.func-callback;
135
106
</listitem>
136
107
</varlistentry>
137
108
</variablelist>
...
...
@@ -141,12 +112,28 @@
141
112
<refsect1 role="returnvalues">
142
113
&reftitle.returnvalues;
143
114
<para>
144
-
&return.success;
115
+
&return.true.always;
145
116
</para>
146
117
</refsect1>
147
118

148
-
</refentry>
119
+
<refsect1 role="changelog">
120
+
&reftitle.changelog;
121
+
<informaltable>
122
+
<tgroup cols="2">
123
+
<thead>
124
+
<row>
125
+
<entry>&Version;</entry>
126
+
<entry>&Description;</entry>
127
+
</row>
128
+
</thead>
129
+
<tbody>
130
+
&xml.changelog.parser-param;
131
+
</tbody>
132
+
</tgroup>
133
+
</informaltable>
134
+
</refsect1>
149
135

136
+
</refentry>
150
137
<!-- Keep this comment at the end of the file
151
138
Local variables:
152
139
mode: sgml
153
140