<?xml version="1.0" encoding="utf-8"?>

<!-- EN-Revision: 51610360d58ed09bc9d1312f419057c0d1d1a998 Maintainer: sergey Status: ready -->

<!-- Reviewed: no -->

<refentry xml:id="pdo-sqlite.createcollation" xmlns="http://docbook.org/ns/docbook">

<refnamediv>

<refname>Pdo\Sqlite::createCollation</refname>

<refpurpose>

Регистрирует определяемую пользователем функцию для использования в качестве функции сопоставления в SQL-выражениях

</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>

Метод похож на <methodname>Pdo\Sqlite::createFunction</methodname>, за исключением того,

что он регистрирует функции, которые используются для сортировки строк.

</simpara>

</refsect1>

<refsect1 role="parameters">

&reftitle.parameters;

<variablelist>

<varlistentry>

<term><parameter>name</parameter></term>

<listitem>

<simpara>

Имя создаваемой или переопределяемой SQL-функции сортировки.

</simpara>

</listitem>

</varlistentry>

<varlistentry>

<term><parameter>callback</parameter></term>

<listitem>

<simpara>

Callback-функция, определяющая поведение сортировки.

Должна принимать две строки (<type>string</type>) и возвращать значение

<literal>-1</literal>, <literal>0</literal> или <literal>1</literal>,

если первая строка сортируется до, сортируется идентично

или сортируется после второй строки соответственно.

Встроенной функцией, которая ведёт себя подобным образом,

является <function>strcmp</function>.

</simpara>

<para>

Сигнатура функции должна быть определена как:

<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></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

-->