mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-28 14:58:55 +00:00
af4410a7e1
still using this, after discussion on the phpdoc list. From now on, manual.ced will need to be found at ~/.phpdoc/manual.ced. git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@288721 c90b9560-bf6c-de11-be94-00142212c4b1
126 lines
3.2 KiB
XML
126 lines
3.2 KiB
XML
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xml:id="function.dbx-sort" xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>dbx_sort</refname>
|
|
<refpurpose>
|
|
Sort a result from a dbx_query by a custom sort function
|
|
</refpurpose>
|
|
</refnamediv>
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>bool</type><methodname>dbx_sort</methodname>
|
|
<methodparam><type>object</type><parameter>result</parameter></methodparam>
|
|
<methodparam><type>string</type><parameter>user_compare_function</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Sort a result from a <function>dbx_query</function> call with a custom sort
|
|
function.
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>result</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
A result set returned by <function>dbx_query</function>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>user_compare_function</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The user-defined comparison function. It must accept two arguments and
|
|
return an integer less than, equal to, or greater than zero if the
|
|
first argument is considered to be respectively less than, equal to,
|
|
or greater than the second.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
&return.success;
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example>
|
|
<title><function>dbx_sort</function> example</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
function user_re_order($a, $b)
|
|
{
|
|
$rv = dbx_compare($a, $b, "parentid", DBX_CMP_DESC);
|
|
if (!$rv) {
|
|
$rv = dbx_compare($a, $b, "id", DBX_CMP_NUMBER);
|
|
}
|
|
return $rv;
|
|
}
|
|
|
|
$link = dbx_connect(DBX_ODBC, "", "db", "username", "password")
|
|
or die("Could not connect");
|
|
|
|
$result = dbx_query($link, "SELECT id, parentid, description FROM tbl ORDER BY id");
|
|
// data in $result is now ordered by id
|
|
|
|
dbx_sort($result, "user_re_order");
|
|
// data in $result is now ordered by parentid (descending), then by id
|
|
|
|
dbx_close($link);
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
</example>
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="notes">
|
|
&reftitle.notes;
|
|
<note>
|
|
<para>
|
|
It is always better to use <literal>ORDER BY</literal>
|
|
<literal>SQL</literal> clause instead of <function>dbx_sort</function>
|
|
if possible.
|
|
</para>
|
|
</note>
|
|
</refsect1>
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><function>dbx_compare</function></member>
|
|
</simplelist>
|
|
</para>
|
|
</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
|
|
-->
|