reference/sqlite3/sqlite3/createcollation.xml
855bfee2f3db70d7dbb4c60c7c4a4efa567f1c60
...
...
@@ -1,6 +1,5 @@
1
1
<?xml version="1.0" encoding="utf-8"?>
2
2
<!-- $Revision$ -->
3
-

4
3
<refentry xml:id="sqlite3.createcollation" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
5
4
<refnamediv>
6
5
<refname>SQLite3::createCollation</refname>
...
...
@@ -9,7 +8,7 @@
9
8

10
9
<refsect1 role="description">
11
10
&reftitle.description;
12
-
<methodsynopsis>
11
+
<methodsynopsis role="SQLite3">
13
12
<modifier>public</modifier> <type>bool</type><methodname>SQLite3::createCollation</methodname>
14
13
<methodparam><type>string</type><parameter>name</parameter></methodparam>
15
14
<methodparam><type>callable</type><parameter>callback</parameter></methodparam>
...
...
@@ -37,10 +36,18 @@
37
36
<para>
38
37
The name of a PHP function or user-defined function to apply as a
39
38
callback, defining the behavior of the collation. It should accept two
40
-
strings and return as <function>strcmp</function> does, i.e. it should
39
+
values and return as <function>strcmp</function> does, i.e. it should
41
40
return -1, 1, or 0 if the first string sorts before, sorts after, or is
42
41
equal to the second.
43
42
</para>
43
+
<para>
44
+
This function need to be defined as:
45
+
<methodsynopsis>
46
+
<type>int</type><methodname><replaceable>collation</replaceable></methodname>
47
+
<methodparam><type>mixed</type><parameter>value1</parameter></methodparam>
48
+
<methodparam><type>mixed</type><parameter>value2</parameter></methodparam>
49
+
</methodsynopsis>
50
+
</para>
44
51
</listitem>
45
52
</varlistentry>
46
53
</variablelist>
...
...
@@ -120,7 +127,6 @@ a10
120
127
</refsect1>
121
128

122
129
</refentry>
123
-

124
130
<!-- Keep this comment at the end of the file
125
131
Local variables:
126
132
mode: sgml
127
133