reference/xml/functions/xml-set-default-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_default_handler</methodname>
12
+
<type>true</type><methodname>xml_set_default_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>
...
...
@@ -23,62 +23,34 @@
23
23
&reftitle.parameters;
24
24
<para>
25
25
<variablelist>
26
-
<varlistentry>
27
-
<term><parameter>parser</parameter></term>
28
-
<listitem>
29
-
<para>
30
-
A reference to the XML parser to set up default handler function.
31
-
</para>
32
-
</listitem>
33
-
</varlistentry>
26
+
&xml.parser.param;
34
27
<varlistentry>
35
28
<term><parameter>handler</parameter></term>
36
29
<listitem>
30
+
&xml.handler.description;
37
31
<para>
38
-
<parameter>handler</parameter> is a string containing the name of a
39
-
function that must exist when <function>xml_parse</function> is called
40
-
for <parameter>parser</parameter>.
41
-
</para>
42
-
<para>
43
-
The function named by <parameter>handler</parameter> must accept
44
-
two parameters:
32
+
The signature of the handler must be:
45
33
<methodsynopsis>
46
-
<methodname><replaceable>handler</replaceable></methodname>
34
+
<type>void</type><methodname><replaceable>handler</replaceable></methodname>
47
35
<methodparam><type>XMLParser</type><parameter>parser</parameter></methodparam>
48
36
<methodparam><type>string</type><parameter>data</parameter></methodparam>
49
37
</methodsynopsis>
50
38
<variablelist>
51
-
<varlistentry>
52
-
<term>
53
-
<parameter>parser</parameter>
54
-
</term>
55
-
<listitem>
56
-
<simpara>
57
-
The first parameter, <replaceable>parser</replaceable>, is a
58
-
reference to the XML parser calling the handler.
59
-
</simpara>
60
-
</listitem>
61
-
</varlistentry>
39
+
&xml.handler.parser.param;
62
40
<varlistentry>
63
41
<term>
64
42
<parameter>data</parameter>
65
43
</term>
66
44
<listitem>
67
45
<simpara>
68
-
The second parameter, <parameter>data</parameter>, contains
69
-
the character data.This may be the XML declaration,
70
-
document type declaration, entities or other data for which
71
-
no other handler exists.
46
+
<parameter>data</parameter> contains the character data.
47
+
This may be the XML declaration, document type declaration,
48
+
entities or other data for which no other handler exists.
72
49
</simpara>
73
50
</listitem>
74
51
</varlistentry>
75
52
</variablelist>
76
53
</para>
77
-
<para>
78
-
If a handler function is set to an empty string, or &false;, the handler
79
-
in question is disabled.
80
-
</para>
81
-
&note.func-callback;
82
54
</listitem>
83
55
</varlistentry>
84
56
</variablelist>
...
...
@@ -88,7 +60,7 @@
88
60
<refsect1 role="returnvalues">
89
61
&reftitle.returnvalues;
90
62
<para>
91
-
&return.success;
63
+
&return.true.always;
92
64
</para>
93
65
</refsect1>
94
66

95
67



Tools (Spanish Manual)