From 4f0afbb68cf5c0d0b65083e4b10be561321ca6ac Mon Sep 17 00:00:00 2001
From: Kalle Sommer Nielsen <kalle@php.net>
Date: Sat, 23 Oct 2010 06:50:56 +0000
Subject: [PATCH] Documented TokyoTyrantQuery::setOrder() -- Fixes bug #52125

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@304640 c90b9560-bf6c-de11-be94-00142212c4b1
---
 .../tokyotyrantquery/setorder.xml             |  97 ++++++++
 reference/tokyo_tyrant/versions.xml           | 213 +++++++++---------
 2 files changed, 204 insertions(+), 106 deletions(-)
 create mode 100644 reference/tokyo_tyrant/tokyotyrantquery/setorder.xml

diff --git a/reference/tokyo_tyrant/tokyotyrantquery/setorder.xml b/reference/tokyo_tyrant/tokyotyrantquery/setorder.xml
new file mode 100644
index 0000000000..cfcf8908e3
--- /dev/null
+++ b/reference/tokyo_tyrant/tokyotyrantquery/setorder.xml
@@ -0,0 +1,97 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision$ -->
+
+<refentry xml:id="tokyotyrantquery.setorder" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <refnamediv>
+  <refname>TokyoTyrantQuery::setOrder</refname>
+  <refpurpose>Orders results</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <modifier>public</modifier> <type>mixed</type><methodname>TokyoTyrantQuery::setOrder</methodname>
+   <methodparam><type>string</type><parameter>name</parameter></methodparam>
+   <methodparam><type>int</type><parameter>type</parameter></methodparam>
+  </methodsynopsis>
+  <para>
+   Sets the order of a query
+  </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  <para>
+   <variablelist>
+    <varlistentry>
+     <term><parameter>name</parameter></term>
+     <listitem>
+      <para>
+       The column name to apply the ordering on.
+      </para>
+     </listitem>
+    </varlistentry>
+    <varlistentry>
+     <term><parameter>type</parameter></term>
+     <listitem>
+      <para>
+       The <parameter>type</parameter> can be one of the following 
+       constants:
+      </para>
+      <itemizedlist>
+       <listitem>
+        <simpara>
+         <constant>RDBQO_STRASC</constant> - String ascending
+        </simpara>
+       </listitem>
+       <listitem>
+        <simpara>
+         <constant>RDBQO_STRDESC</constant> - String descending
+        </simpara>
+       </listitem>
+       <listitem>
+        <simpara>
+         <constant>RDBQO_NUMASC</constant> - Numberic ascending
+        </simpara>
+       </listitem>
+       <listitem>
+        <simpara>
+         <constant>RDBQO_NUMDESC</constant> - String descending
+        </simpara>
+       </listitem>
+      </itemizedlist>
+     </listitem>
+    </varlistentry>
+   </variablelist>
+  </para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   This method returns the current object.
+  </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
+-->
diff --git a/reference/tokyo_tyrant/versions.xml b/reference/tokyo_tyrant/versions.xml
index 8cc43ca5de..e99d734254 100644
--- a/reference/tokyo_tyrant/versions.xml
+++ b/reference/tokyo_tyrant/versions.xml
@@ -1,106 +1,107 @@
-<?xml version='1.0' encoding='utf-8'?>
-<!-- $Revision$ -->
-<!--
-  Do NOT translate this file
--->
-<!--
-Example entries:
- <function name='classname::methodname' from='PECL extname &gt;= 1.1'/>
- <function name='functionname' from='PHP &gt;= 5.3.0'/>
- <function name='functionname' from='PHP 5'/>
--->
-<versions>
-  <!-- Methods -->
- <function name='tokyotyrant::__construct' from='PECL tokyo_tyrant &gt;= 0.1.0'/>
- <function name='tokyotyrant::connect' from='PECL tokyo_tyrant &gt;= 0.1.0'/>
- <function name='tokyotyrant::connecturi' from='PECL tokyo_tyrant &gt;= 0.1.0'/>
- <function name='tokyotyrant::vanish' from='PECL tokyo_tyrant &gt;= 0.1.0'/>
- <function name='tokyotyrant::stat' from='PECL tokyo_tyrant &gt;= 0.1.0'/>
- <function name='tokyotyrant::fwmkeys' from='PECL tokyo_tyrant &gt;= 0.1.0'/>
- <function name='tokyotyrant::size' from='PECL tokyo_tyrant &gt;= 0.1.0'/>
- <function name='tokyotyrant::num' from='PECL tokyo_tyrant &gt;= 0.1.0'/>
- <function name='tokyotyrant::sync' from='PECL tokyo_tyrant &gt;= 0.1.0'/>
- <function name='tokyotyrant::ext' from='PECL tokyo_tyrant &gt;= 0.1.0'/>
- <function name='tokyotyrant::copy' from='PECL tokyo_tyrant &gt;= 0.1.0'/>
- <function name='tokyotyrant::restore' from='PECL tokyo_tyrant &gt;= 0.1.0'/>
- <function name='tokyotyrant::setmaster' from='PECL tokyo_tyrant &gt;= 0.1.0'/>
- <function name='tokyotyrant::put' from='PECL tokyo_tyrant &gt;= 0.1.0'/>
- <function name='tokyotyrant::putkeep' from='PECL tokyo_tyrant &gt;= 0.1.0'/>
- <function name='tokyotyrant::putcat' from='PECL tokyo_tyrant &gt;= 0.1.0'/>
- <function name='tokyotyrant::putnr' from='PECL tokyo_tyrant &gt;= 0.1.0'/>
- <function name='tokyotyrant::putshl' from='PECL tokyo_tyrant &gt;= 0.1.0'/>
- <function name='tokyotyrant::get' from='PECL tokyo_tyrant &gt;= 0.1.0'/>
- <function name='tokyotyrant::out' from='PECL tokyo_tyrant &gt;= 0.1.0'/>
- <function name='tokyotyrant::add' from='PECL tokyo_tyrant &gt;= 0.1.0'/>
- <function name='tokyotyrant::tune' from='PECL tokyo_tyrant &gt;= 0.2.0'/>
- <function name='tokyotyranttable::put' from='PECL tokyo_tyrant &gt;= 0.1.0'/>
- <function name='tokyotyranttable::putkeep' from='PECL tokyo_tyrant &gt;= 0.1.0'/>
- <function name='tokyotyranttable::putcat' from='PECL tokyo_tyrant &gt;= 0.1.0'/>
- <function name='tokyotyranttable::putnr' from='PECL tokyo_tyrant &gt;= 0.1.0'/>
- <function name='tokyotyranttable::putshl' from='PECL tokyo_tyrant &gt;= 0.1.0'/>
- <function name='tokyotyranttable::get' from='PECL tokyo_tyrant &gt;= 0.1.0'/>
- <function name='tokyotyranttable::out' from='PECL tokyo_tyrant &gt;= 0.1.0'/>
- <function name='tokyotyranttable::add' from='PECL tokyo_tyrant &gt;= 0.1.0'/>
- <function name='tokyotyranttable::setindex' from='PECL tokyo_tyrant &gt;= 0.1.0'/>
- <function name='tokyotyranttable::getquery' from='PECL tokyo_tyrant &gt;= 0.1.0'/>
- <function name='tokyotyranttable::genuid' from='PECL tokyo_tyrant &gt;= 0.1.0'/>
- <function name='tokyotyranttable::__construct' from='PECL tokyo_tyrant &gt;= 0.1.0'/>
- <function name='tokyotyranttable::connect' from='PECL tokyo_tyrant &gt;= 0.1.0'/>
- <function name='tokyotyranttable::connecturi' from='PECL tokyo_tyrant &gt;= 0.1.0'/>
- <function name='tokyotyranttable::vanish' from='PECL tokyo_tyrant &gt;= 0.1.0'/>
- <function name='tokyotyranttable::stat' from='PECL tokyo_tyrant &gt;= 0.1.0'/>
- <function name='tokyotyranttable::fwmkeys' from='PECL tokyo_tyrant &gt;= 0.1.0'/>
- <function name='tokyotyranttable::size' from='PECL tokyo_tyrant &gt;= 0.1.0'/>
- <function name='tokyotyranttable::num' from='PECL tokyo_tyrant &gt;= 0.1.0'/>
- <function name='tokyotyranttable::sync' from='PECL tokyo_tyrant &gt;= 0.1.0'/>
- <function name='tokyotyranttable::ext' from='PECL tokyo_tyrant &gt;= 0.1.0'/>
- <function name='tokyotyranttable::copy' from='PECL tokyo_tyrant &gt;= 0.1.0'/>
- <function name='tokyotyranttable::restore' from='PECL tokyo_tyrant &gt;= 0.1.0'/>
- <function name='tokyotyranttable::setmaster' from='PECL tokyo_tyrant &gt;= 0.1.0'/>
- <function name='tokyotyrantquery::__construct' from='PECL tokyo_tyrant &gt;= 0.1.0'/>
- <function name='tokyotyrantquery::addcond' from='PECL tokyo_tyrant &gt;= 0.1.0'/>
- <function name='tokyotyrantquery::setlimit' from='PECL tokyo_tyrant &gt;= 0.1.0'/>
- <function name='tokyotyrantquery::search' from='PECL tokyo_tyrant &gt;= 0.1.0'/>
- <function name='tokyotyrantquery::out' from='PECL tokyo_tyrant &gt;= 0.1.0'/>
- <function name='tokyotyrantquery::key' from='PECL tokyo_tyrant &gt;= 0.1.0'/>
- <function name='tokyotyrantquery::next' from='PECL tokyo_tyrant &gt;= 0.1.0'/>
- <function name='tokyotyrantquery::rewind' from='PECL tokyo_tyrant &gt;= 0.1.0'/>
- <function name='tokyotyrantquery::current' from='PECL tokyo_tyrant &gt;= 0.1.0'/>
- <function name='tokyotyrantquery::valid' from='PECL tokyo_tyrant &gt;= 0.1.0'/>
- <function name='tokyotyrantexception::__clone' from='PECL tokyo_tyrant &gt;= 0.1.0'/>
- <function name='tokyotyrantexception::__construct' from='PECL tokyo_tyrant &gt;= 0.1.0'/>
- <function name='tokyotyrantexception::getmessage' from='PECL tokyo_tyrant &gt;= 0.1.0'/>
- <function name='tokyotyrantexception::getcode' from='PECL tokyo_tyrant &gt;= 0.1.0'/>
- <function name='tokyotyrantexception::getfile' from='PECL tokyo_tyrant &gt;= 0.1.0'/>
- <function name='tokyotyrantexception::getline' from='PECL tokyo_tyrant &gt;= 0.1.0'/>
- <function name='tokyotyrantexception::gettrace' from='PECL tokyo_tyrant &gt;= 0.1.0'/>
- <function name='tokyotyrantexception::gettraceasstring' from='PECL tokyo_tyrant &gt;= 0.1.0'/>
- <function name='tokyotyrantexception::__tostring' from='PECL tokyo_tyrant &gt;= 0.1.0'/>
- <function name='tokyotyrantiterator::__construct' from='PECL tokyo_tyrant &gt;= 0.2.0'/>
- <function name='tokyotyrantiterator::next' from='PECL tokyo_tyrant &gt;= 0.2.0'/>
- <function name='tokyotyrantiterator::valid' from='PECL tokyo_tyrant &gt;= 0.2.0'/>
- <function name='tokyotyrantiterator::rewind' from='PECL tokyo_tyrant &gt;= 0.2.0'/>
- <function name='tokyotyrantiterator::key' from='PECL tokyo_tyrant &gt;= 0.2.0'/>
- <function name='tokyotyrantiterator::current' from='PECL tokyo_tyrant &gt;= 0.2.0'/>
-</versions>
-
-<!-- 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
--->
+<?xml version='1.0' encoding='utf-8'?>
+<!-- $Revision$ -->
+<!--
+  Do NOT translate this file
+-->
+<!--
+Example entries:
+ <function name='classname::methodname' from='PECL extname &gt;= 1.1'/>
+ <function name='functionname' from='PHP &gt;= 5.3.0'/>
+ <function name='functionname' from='PHP 5'/>
+-->
+<versions>
+  <!-- Methods -->
+ <function name='tokyotyrant::__construct' from='PECL tokyo_tyrant &gt;= 0.1.0'/>
+ <function name='tokyotyrant::connect' from='PECL tokyo_tyrant &gt;= 0.1.0'/>
+ <function name='tokyotyrant::connecturi' from='PECL tokyo_tyrant &gt;= 0.1.0'/>
+ <function name='tokyotyrant::vanish' from='PECL tokyo_tyrant &gt;= 0.1.0'/>
+ <function name='tokyotyrant::stat' from='PECL tokyo_tyrant &gt;= 0.1.0'/>
+ <function name='tokyotyrant::fwmkeys' from='PECL tokyo_tyrant &gt;= 0.1.0'/>
+ <function name='tokyotyrant::size' from='PECL tokyo_tyrant &gt;= 0.1.0'/>
+ <function name='tokyotyrant::num' from='PECL tokyo_tyrant &gt;= 0.1.0'/>
+ <function name='tokyotyrant::sync' from='PECL tokyo_tyrant &gt;= 0.1.0'/>
+ <function name='tokyotyrant::ext' from='PECL tokyo_tyrant &gt;= 0.1.0'/>
+ <function name='tokyotyrant::copy' from='PECL tokyo_tyrant &gt;= 0.1.0'/>
+ <function name='tokyotyrant::restore' from='PECL tokyo_tyrant &gt;= 0.1.0'/>
+ <function name='tokyotyrant::setmaster' from='PECL tokyo_tyrant &gt;= 0.1.0'/>
+ <function name='tokyotyrant::put' from='PECL tokyo_tyrant &gt;= 0.1.0'/>
+ <function name='tokyotyrant::putkeep' from='PECL tokyo_tyrant &gt;= 0.1.0'/>
+ <function name='tokyotyrant::putcat' from='PECL tokyo_tyrant &gt;= 0.1.0'/>
+ <function name='tokyotyrant::putnr' from='PECL tokyo_tyrant &gt;= 0.1.0'/>
+ <function name='tokyotyrant::putshl' from='PECL tokyo_tyrant &gt;= 0.1.0'/>
+ <function name='tokyotyrant::get' from='PECL tokyo_tyrant &gt;= 0.1.0'/>
+ <function name='tokyotyrant::out' from='PECL tokyo_tyrant &gt;= 0.1.0'/>
+ <function name='tokyotyrant::add' from='PECL tokyo_tyrant &gt;= 0.1.0'/>
+ <function name='tokyotyrant::tune' from='PECL tokyo_tyrant &gt;= 0.2.0'/>
+ <function name='tokyotyranttable::put' from='PECL tokyo_tyrant &gt;= 0.1.0'/>
+ <function name='tokyotyranttable::putkeep' from='PECL tokyo_tyrant &gt;= 0.1.0'/>
+ <function name='tokyotyranttable::putcat' from='PECL tokyo_tyrant &gt;= 0.1.0'/>
+ <function name='tokyotyranttable::putnr' from='PECL tokyo_tyrant &gt;= 0.1.0'/>
+ <function name='tokyotyranttable::putshl' from='PECL tokyo_tyrant &gt;= 0.1.0'/>
+ <function name='tokyotyranttable::get' from='PECL tokyo_tyrant &gt;= 0.1.0'/>
+ <function name='tokyotyranttable::out' from='PECL tokyo_tyrant &gt;= 0.1.0'/>
+ <function name='tokyotyranttable::add' from='PECL tokyo_tyrant &gt;= 0.1.0'/>
+ <function name='tokyotyranttable::setindex' from='PECL tokyo_tyrant &gt;= 0.1.0'/>
+ <function name='tokyotyranttable::getquery' from='PECL tokyo_tyrant &gt;= 0.1.0'/>
+ <function name='tokyotyranttable::genuid' from='PECL tokyo_tyrant &gt;= 0.1.0'/>
+ <function name='tokyotyranttable::__construct' from='PECL tokyo_tyrant &gt;= 0.1.0'/>
+ <function name='tokyotyranttable::connect' from='PECL tokyo_tyrant &gt;= 0.1.0'/>
+ <function name='tokyotyranttable::connecturi' from='PECL tokyo_tyrant &gt;= 0.1.0'/>
+ <function name='tokyotyranttable::vanish' from='PECL tokyo_tyrant &gt;= 0.1.0'/>
+ <function name='tokyotyranttable::stat' from='PECL tokyo_tyrant &gt;= 0.1.0'/>
+ <function name='tokyotyranttable::fwmkeys' from='PECL tokyo_tyrant &gt;= 0.1.0'/>
+ <function name='tokyotyranttable::size' from='PECL tokyo_tyrant &gt;= 0.1.0'/>
+ <function name='tokyotyranttable::num' from='PECL tokyo_tyrant &gt;= 0.1.0'/>
+ <function name='tokyotyranttable::sync' from='PECL tokyo_tyrant &gt;= 0.1.0'/>
+ <function name='tokyotyranttable::ext' from='PECL tokyo_tyrant &gt;= 0.1.0'/>
+ <function name='tokyotyranttable::copy' from='PECL tokyo_tyrant &gt;= 0.1.0'/>
+ <function name='tokyotyranttable::restore' from='PECL tokyo_tyrant &gt;= 0.1.0'/>
+ <function name='tokyotyranttable::setmaster' from='PECL tokyo_tyrant &gt;= 0.1.0'/>
+ <function name='tokyotyrantquery::__construct' from='PECL tokyo_tyrant &gt;= 0.1.0'/>
+ <function name='tokyotyrantquery::addcond' from='PECL tokyo_tyrant &gt;= 0.1.0'/>
+ <function name='tokyotyrantquery::setlimit' from='PECL tokyo_tyrant &gt;= 0.1.0'/>
+ <function name='tokyotyrantquery::setorder' from='PECL tokyo_tyrant &gt;= 0.1.0'/>
+ <function name='tokyotyrantquery::search' from='PECL tokyo_tyrant &gt;= 0.1.0'/>
+ <function name='tokyotyrantquery::out' from='PECL tokyo_tyrant &gt;= 0.1.0'/>
+ <function name='tokyotyrantquery::key' from='PECL tokyo_tyrant &gt;= 0.1.0'/>
+ <function name='tokyotyrantquery::next' from='PECL tokyo_tyrant &gt;= 0.1.0'/>
+ <function name='tokyotyrantquery::rewind' from='PECL tokyo_tyrant &gt;= 0.1.0'/>
+ <function name='tokyotyrantquery::current' from='PECL tokyo_tyrant &gt;= 0.1.0'/>
+ <function name='tokyotyrantquery::valid' from='PECL tokyo_tyrant &gt;= 0.1.0'/>
+ <function name='tokyotyrantexception::__clone' from='PECL tokyo_tyrant &gt;= 0.1.0'/>
+ <function name='tokyotyrantexception::__construct' from='PECL tokyo_tyrant &gt;= 0.1.0'/>
+ <function name='tokyotyrantexception::getmessage' from='PECL tokyo_tyrant &gt;= 0.1.0'/>
+ <function name='tokyotyrantexception::getcode' from='PECL tokyo_tyrant &gt;= 0.1.0'/>
+ <function name='tokyotyrantexception::getfile' from='PECL tokyo_tyrant &gt;= 0.1.0'/>
+ <function name='tokyotyrantexception::getline' from='PECL tokyo_tyrant &gt;= 0.1.0'/>
+ <function name='tokyotyrantexception::gettrace' from='PECL tokyo_tyrant &gt;= 0.1.0'/>
+ <function name='tokyotyrantexception::gettraceasstring' from='PECL tokyo_tyrant &gt;= 0.1.0'/>
+ <function name='tokyotyrantexception::__tostring' from='PECL tokyo_tyrant &gt;= 0.1.0'/>
+ <function name='tokyotyrantiterator::__construct' from='PECL tokyo_tyrant &gt;= 0.2.0'/>
+ <function name='tokyotyrantiterator::next' from='PECL tokyo_tyrant &gt;= 0.2.0'/>
+ <function name='tokyotyrantiterator::valid' from='PECL tokyo_tyrant &gt;= 0.2.0'/>
+ <function name='tokyotyrantiterator::rewind' from='PECL tokyo_tyrant &gt;= 0.2.0'/>
+ <function name='tokyotyrantiterator::key' from='PECL tokyo_tyrant &gt;= 0.2.0'/>
+ <function name='tokyotyrantiterator::current' from='PECL tokyo_tyrant &gt;= 0.2.0'/>
+</versions>
+
+<!-- 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
+-->