reference/xml/functions/xml-set-end-namespace-decl-handler.xml
5a14f904d231d294e2e5b4fb5d2fc4d2fd9eddee
...
...
@@ -9,7 +9,7 @@
9
9
<refsect1 role="description">
10
10
&reftitle.description;
11
11
<methodsynopsis>
12
-
<type>bool</type><methodname>xml_set_end_namespace_decl_handler</methodname>
12
+
<type>true</type><methodname>xml_set_end_namespace_decl_handler</methodname>
13
13
<methodparam><type>XMLParser</type><parameter>parser</parameter></methodparam>
14
14
<methodparam><type>callable</type><parameter>handler</parameter></methodparam>
15
15
</methodsynopsis>
...
...
@@ -31,59 +31,31 @@
31
31
&reftitle.parameters;
32
32
<para>
33
33
<variablelist>
34
-
<varlistentry>
35
-
<term><parameter>parser</parameter></term>
36
-
<listitem>
37
-
<para>
38
-
A reference to the XML parser.
39
-
</para>
40
-
</listitem>
41
-
</varlistentry>
34
+
&xml.parser.param;
42
35
<varlistentry>
43
36
<term><parameter>handler</parameter></term>
44
37
<listitem>
38
+
&xml.handler.description;
45
39
<para>
46
-
<parameter>handler</parameter> is a string containing the name of a
47
-
function that must exist when <function>xml_parse</function> is called
48
-
for <parameter>parser</parameter>.
49
-
</para>
50
-
<para>
51
-
The function named by <parameter>handler</parameter> must accept
52
-
two parameters, and should return an integer value. If the
53
-
value returned from the handler is &false; (which it will be if no
54
-
value is returned), the XML parser will stop parsing and
55
-
<function>xml_get_error_code</function> will return
56
-
<constant>XML_ERROR_EXTERNAL_ENTITY_HANDLING</constant>.
40
+
The signature of the handler must be:
57
41
<methodsynopsis>
58
42
<methodname><replaceable>handler</replaceable></methodname>
59
43
<methodparam><type>XMLParser</type><parameter>parser</parameter></methodparam>
60
-
<methodparam><type>string</type><parameter>prefix</parameter></methodparam>
44
+
<methodparam><type class="union"><type>string</type><type>false</type></type><parameter>prefix</parameter></methodparam>
61
45
</methodsynopsis>
62
46
<variablelist>
63
-
<varlistentry>
64
-
<term><parameter>parser</parameter></term>
65
-
<listitem>
66
-
<simpara>
67
-
The first parameter, <replaceable>parser</replaceable>, is a
68
-
reference to the XML parser calling the handler.
69
-
</simpara>
70
-
</listitem>
71
-
</varlistentry>
47
+
&xml.handler.parser.param;
72
48
<varlistentry>
73
49
<term><parameter>prefix</parameter></term>
74
50
<listitem>
75
51
<simpara>
76
52
The prefix is a string used to reference the namespace within an XML object.
53
+
&false; if no prefix exists.
77
54
</simpara>
78
55
</listitem>
79
56
</varlistentry>
80
57
</variablelist>
81
58
</para>
82
-
<para>
83
-
If a handler function is set to an empty string, or &false;, the handler
84
-
in question is disabled.
85
-
</para>
86
-
&note.func-callback;
87
59
</listitem>
88
60
</varlistentry>
89
61
</variablelist>
...
...
@@ -93,7 +65,7 @@
93
65
<refsect1 role="returnvalues">
94
66
&reftitle.returnvalues;
95
67
<para>
96
-
&return.success;
68
+
&return.true.always;
97
69
</para>
98
70
</refsect1>
99
71

100
72