reference/xml/functions/xml-set-character-data-handler.xml
5a14f904d231d294e2e5b4fb5d2fc4d2fd9eddee
...
...
@@ -1,6 +1,6 @@
1
1
<?xml version="1.0" encoding="utf-8"?>
2
2
<!-- $Revision$ -->
3
-
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.xml-set-character-data-handler">
3
+
<refentry xml:id="function.xml-set-character-data-handler" xmlns="http://docbook.org/ns/docbook">
4
4
<refnamediv>
5
5
<refname>xml_set_character_data_handler</refname>
6
6
<refpurpose>Set up character data handler</refpurpose>
...
...
@@ -9,8 +9,8 @@
9
9
<refsect1 role="description">
10
10
&reftitle.description;
11
11
<methodsynopsis>
12
-
<type>bool</type><methodname>xml_set_character_data_handler</methodname>
13
-
<methodparam><type>resource</type><parameter>parser</parameter></methodparam>
12
+
<type>true</type><methodname>xml_set_character_data_handler</methodname>
13
+
<methodparam><type>XMLParser</type><parameter>parser</parameter></methodparam>
14
14
<methodparam><type>callable</type><parameter>handler</parameter></methodparam>
15
15
</methodsynopsis>
16
16
<para>
...
...
@@ -23,46 +23,25 @@
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 character data 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>
47
-
<methodparam><type>resource</type><parameter>parser</parameter></methodparam>
34
+
<type>void</type><methodname><replaceable>handler</replaceable></methodname>
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><parameter>parser</parameter></term>
53
-
<listitem>
54
-
<simpara>
55
-
The first parameter, <replaceable>parser</replaceable>, is a
56
-
reference to the XML parser calling the handler.
57
-
</simpara>
58
-
</listitem>
59
-
</varlistentry>
39
+
&xml.handler.parser.param;
60
40
<varlistentry>
61
41
<term><parameter>data</parameter></term>
62
42
<listitem>
63
43
<simpara>
64
-
The second parameter, <parameter>data</parameter>, contains
65
-
the character data as a string.
44
+
Character data as a string.
66
45
</simpara>
67
46
</listitem>
68
47
</varlistentry>
...
...
@@ -73,11 +52,6 @@
73
52
document. It can be called multiple times inside each fragment (e.g.
74
53
for non-ASCII strings).
75
54
</para>
76
-
<para>
77
-
If a handler function is set to an empty string, or &false;, the handler
78
-
in question is disabled.
79
-
</para>
80
-
&note.func-callback;
81
55
</listitem>
82
56
</varlistentry>
83
57
</variablelist>
...
...
@@ -87,12 +61,28 @@
87
61
<refsect1 role="returnvalues">
88
62
&reftitle.returnvalues;
89
63
<para>
90
-
&return.success;
64
+
&return.true.always;
91
65
</para>
92
66
</refsect1>
93
67

94
-
</refentry>
68
+
<refsect1 role="changelog">
69
+
&reftitle.changelog;
70
+
<informaltable>
71
+
<tgroup cols="2">
72
+
<thead>
73
+
<row>
74
+
<entry>&Version;</entry>
75
+
<entry>&Description;</entry>
76
+
</row>
77
+
</thead>
78
+
<tbody>
79
+
&xml.changelog.parser-param;
80
+
</tbody>
81
+
</tgroup>
82
+
</informaltable>
83
+
</refsect1>
95
84

85
+
</refentry>
96
86
<!-- Keep this comment at the end of the file
97
87
Local variables:
98
88
mode: sgml
99
89