reference/xml/functions/xml-set-unparsed-entity-decl-handler.xml
5a14f904d231d294e2e5b4fb5d2fc4d2fd9eddee
...
...
@@ -11,7 +11,7 @@
11
11
<refsect1 role="description">
12
12
&reftitle.description;
13
13
<methodsynopsis>
14
-
<type>bool</type><methodname>xml_set_unparsed_entity_decl_handler</methodname>
14
+
<type>true</type><methodname>xml_set_unparsed_entity_decl_handler</methodname>
15
15
<methodparam><type>XMLParser</type><parameter>parser</parameter></methodparam>
16
16
<methodparam><type>callable</type><parameter>handler</parameter></methodparam>
17
17
</methodsynopsis>
...
...
@@ -41,45 +41,24 @@
41
41
&reftitle.parameters;
42
42
<para>
43
43
<variablelist>
44
-
<varlistentry>
45
-
<term><parameter>parser</parameter></term>
46
-
<listitem>
47
-
<para>
48
-
A reference to the XML parser to set up unparsed entity declaration handler function.
49
-
</para>
50
-
</listitem>
51
-
</varlistentry>
44
+
&xml.parser.param;
52
45
<varlistentry>
53
46
<term><parameter>handler</parameter></term>
54
47
<listitem>
48
+
&xml.handler.description;
55
49
<para>
56
-
<parameter>handler</parameter> is a string containing the name of a
57
-
function that must exist when <function>xml_parse</function> is called
58
-
for <parameter>parser</parameter>.
59
-
</para>
60
-
<para>
61
-
The function named by <parameter>handler</parameter> must accept six
62
-
parameters:
50
+
The signature of the handler must be:
63
51
<methodsynopsis>
64
-
<methodname><replaceable>handler</replaceable></methodname>
52
+
<type>void</type><methodname><replaceable>handler</replaceable></methodname>
65
53
<methodparam><type>XMLParser</type><parameter>parser</parameter></methodparam>
66
54
<methodparam><type>string</type><parameter>entity_name</parameter></methodparam>
67
-
<methodparam><type>string</type><parameter>base</parameter></methodparam>
55
+
<methodparam><type class="union"><type>string</type><type>false</type></type><parameter>base</parameter></methodparam>
68
56
<methodparam><type>string</type><parameter>system_id</parameter></methodparam>
69
-
<methodparam><type>string</type><parameter>public_id</parameter></methodparam>
70
-
<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>
71
59
</methodsynopsis>
72
60
<variablelist>
73
-
<varlistentry>
74
-
<term><parameter>parser</parameter></term>
75
-
<listitem>
76
-
<simpara>
77
-
The first parameter, <replaceable>parser</replaceable>, is a
78
-
reference to the XML parser calling the
79
-
handler.
80
-
</simpara>
81
-
</listitem>
82
-
</varlistentry>
61
+
&xml.handler.parser.param;
83
62
<varlistentry>
84
63
<term><parameter>entity_name</parameter></term>
85
64
<listitem>
...
...
@@ -93,8 +72,7 @@
93
72
<listitem>
94
73
<simpara>
95
74
This is the base for resolving the system identifier
96
-
(<parameter>systemId</parameter>) of the external entity.Currently
97
-
this parameter will always be set to an empty string.
75
+
(<parameter>systemId</parameter>) of the external entity.
98
76
</simpara>
99
77
</listitem>
100
78
</varlistentry>
...
...
@@ -125,11 +103,6 @@
125
103
</varlistentry>
126
104
</variablelist>
127
105
</para>
128
-
<para>
129
-
If a handler function is set to an empty string, or &false;, the handler
130
-
in question is disabled.
131
-
</para>
132
-
&note.func-callback;
133
106
</listitem>
134
107
</varlistentry>
135
108
</variablelist>
...
...
@@ -139,7 +112,7 @@
139
112
<refsect1 role="returnvalues">
140
113
&reftitle.returnvalues;
141
114
<para>
142
-
&return.success;
115
+
&return.true.always;
143
116
</para>
144
117
</refsect1>
145
118

146
119