mirror of
https://github.com/php/doc-en.git
synced 2026-03-24 15:52:15 +01:00
135 lines
3.8 KiB
XML
135 lines
3.8 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<refentry xml:id="pdo-sqlite.createcollation" xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>Pdo\Sqlite::createCollation</refname>
|
|
<refpurpose>
|
|
Registers a user-defined function for use as a collating function in SQL statements
|
|
</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis role="Pdo\\Sqlite">
|
|
<modifier>public</modifier> <type>bool</type><methodname>Pdo\Sqlite::createCollation</methodname>
|
|
<methodparam><type>string</type><parameter>name</parameter></methodparam>
|
|
<methodparam><type>callable</type><parameter>callback</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<simpara>
|
|
This method is similar to <methodname>Pdo\Sqlite::createFunction</methodname>
|
|
except that it registers functions that are used to collate strings.
|
|
</simpara>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>name</parameter></term>
|
|
<listitem>
|
|
<simpara>
|
|
Name of the SQL collating function to be created or redefined.
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>callback</parameter></term>
|
|
<listitem>
|
|
<simpara>
|
|
Callback function that defines the behaviour of a collation.
|
|
It must accept two <type>string</type>s and return
|
|
<literal>-1</literal>, <literal>0</literal>, or <literal>1</literal>
|
|
if the first string sorts before, sorts identically, or sorts after
|
|
the second string respectively.
|
|
An internal function that behaves like this is <function>strcmp</function>.
|
|
</simpara>
|
|
<para>
|
|
This function need to be defined as:
|
|
<methodsynopsis>
|
|
<type>int</type><methodname><replaceable>collation</replaceable></methodname>
|
|
<methodparam><type>string</type><parameter>string1</parameter></methodparam>
|
|
<methodparam><type>string</type><parameter>string2</parameter></methodparam>
|
|
</methodsynopsis>
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<simpara>
|
|
&return.success;
|
|
</simpara>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<example>
|
|
<title><methodname>Pdo\Sqlite::createCollation</methodname> example</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
$db = new Pdo\Sqlite('sqlite::memory:');
|
|
$db->exec("CREATE TABLE test (col1 string)");
|
|
$db->exec("INSERT INTO test VALUES ('a1')");
|
|
$db->exec("INSERT INTO test VALUES ('a10')");
|
|
$db->exec("INSERT INTO test VALUES ('a2')");
|
|
|
|
$db->sqliteCreateCollation('NATURAL_CMP', 'strnatcmp');
|
|
foreach ($db->query("SELECT col1 FROM test ORDER BY col1") as $row) {
|
|
echo $row['col1'] . "\n";
|
|
}
|
|
echo "\n";
|
|
foreach ($db->query("SELECT col1 FROM test ORDER BY col1 COLLATE NATURAL_CMP") as $row) {
|
|
echo $row['col1'] . "\n";
|
|
}
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
&example.outputs;
|
|
<screen>
|
|
<![CDATA[
|
|
a1
|
|
a10
|
|
a2
|
|
|
|
a1
|
|
a2
|
|
a10
|
|
]]>
|
|
</screen>
|
|
</example>
|
|
</refsect1>
|
|
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<simplelist>
|
|
<member><methodname>Pdo\Sqlite::createFunction</methodname></member>
|
|
<member><methodname>Pdo\Sqlite::createAggregate</methodname></member>
|
|
<member><function>sqlite_create_function</function></member>
|
|
<member><function>sqlite_create_aggregate</function></member>
|
|
</simplelist>
|
|
</refsect1>
|
|
|
|
</refentry>
|
|
<!-- Keep this comment at the end of the file
|
|
Local variables:
|
|
mode: sgml
|
|
sgml-omittag:t
|
|
sgml-shorttag:t
|
|
sgml-minimize-attributes:nil
|
|
sgml-always-quote-attributes:t
|
|
sgml-indent-step:1
|
|
sgml-indent-data:t
|
|
indent-tabs-mode:nil
|
|
sgml-parent-document:nil
|
|
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
|
|
sgml-exposed-tags:nil
|
|
sgml-local-catalogs:nil
|
|
sgml-local-ecat-files:nil
|
|
End:
|
|
vim600: syn=xml fen fdm=syntax fdl=2 si
|
|
vim: et tw=78 syn=sgml
|
|
vi: ts=1 sw=1
|
|
-->
|