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

Registra una función de usuario de ordenación para su uso en las sentencias 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>

Este método es similar a <methodname>Pdo\Sqlite::createFunction</methodname>

salvo que registra funciones que se utilizan para ordenar strings.

</simpara>

</refsect1>

<refsect1 role="parameters">

&reftitle.parameters;

<variablelist>

<varlistentry>

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

<listitem>

<simpara>

El nombre de la función de ordenación SQL a crear o redefinir.

</simpara>

</listitem>

</varlistentry>

<varlistentry>

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

<listitem>

<simpara>

La retrollamada que define el comportamiento de una ordenación.

Debe aceptar dos <type>string</type>s y devolver

<literal>-1</literal>, <literal>0</literal>, o <literal>1</literal>

si el primer string se ordena antes, es idéntico o después

del segundo string respectivamente.

Una función interna que se comporta de esta manera es <function>strcmp</function>.

</simpara>

<para>

Esta función debe ser definida como sigue:

<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>Ejemplo de <methodname>Pdo\Sqlite::createCollation</methodname></title>

<programlisting role="php">

</programlisting>

&example.outputs;

<screen>

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