[PHP-DOC] cvs: phpdoc /en/functions array.xml From: Hartmut Holzgraefe (hartmut <email protected>)
Date: 08/04/00

hholzgra Fri Aug 4 02:38:31 2000 EDT

  Modified files:
    /phpdoc/en/functions array.xml
  Log:
  added short documentation for ioptional second sort() parameter
  ( see bug id #5867 )
  
  
Index: phpdoc/en/functions/array.xml
diff -u phpdoc/en/functions/array.xml:1.16 phpdoc/en/functions/array.xml:1.17
--- phpdoc/en/functions/array.xml:1.16 Sat Jul 29 14:12:26 2000
+++ phpdoc/en/functions/array.xml Fri Aug 4 02:38:31 2000
@@ -1086,6 +1086,7 @@
      <funcprototype>
       <funcdef>void <function>arsort</function></funcdef>
       <paramdef>array <parameter>array</parameter></paramdef>
+ <paramdef>int <parameter><optional>sort_flags</optional></parameter></paramdef>
      </funcprototype>
     </funcsynopsis>
     <para>
@@ -1123,6 +1124,11 @@
      the index associated with each element has been maintained.
     </para>
     <para>
+ You may modify the behavior of the sort using the optional
+ parameter <parameter>sort_flags</parameter>, for details
+ see <function>sort</function>.
+ </para>
+ <para>
      See also: <function>asort</function>, <function>rsort</function>,
      <function>ksort</function>, and <function>sort</function>.
     </para>
@@ -1140,6 +1146,7 @@
      <funcprototype>
       <funcdef>void <function>asort</function></funcdef>
       <paramdef>array <parameter>array</parameter></paramdef>
+ <paramdef>int <parameter><optional>sort_flags</optional></parameter></paramdef>
      </funcprototype>
     </funcsynopsis>
     <para>
@@ -1177,6 +1184,11 @@
      associated with each element has been maintained.
     </para>
     <para>
+ You may modify the behavior of the sort using the optional
+ parameter <parameter>sort_flags</parameter>, for details
+ see <function>sort</function>.
+ </para>
+ <para>
      See also <function>arsort</function>, <function>rsort</function>,
      <function>ksort</function>, and <function>sort</function>.
     </para>
@@ -1641,6 +1653,7 @@
      <funcprototype>
       <funcdef>int <function>krsort</function></funcdef>
       <paramdef>array <parameter>array</parameter></paramdef>
+ <paramdef>int <parameter><optional>sort_flags</optional></parameter></paramdef>
      </funcprototype>
     </funcsynopsis>
     <para>
@@ -1671,6 +1684,11 @@
       </programlisting>
      </informalexample>
     </para>
+ <para>
+ You may modify the behavior of the sort using the optional
+ parameter <parameter>sort_flags</parameter>, for details
+ see <function>sort</function>.
+ </para>
     <simpara>
      See also <function>asort</function>, <function>arsort</function>,
      <function>ksort</function> <function>sort</function>, and
@@ -1690,6 +1708,7 @@
      <funcprototype>
       <funcdef>int <function>ksort</function></funcdef>
       <paramdef>array <parameter>array</parameter></paramdef>
+ <paramdef>int <parameter><optional>sort_flags</optional></parameter></paramdef>
      </funcprototype>
     </funcsynopsis>
     <para>
@@ -1720,6 +1739,11 @@
       </programlisting>
      </informalexample>
     </para>
+ <para>
+ You may modify the behavior of the sort using the optional
+ parameter <parameter>sort_flags</parameter>, for details
+ see <function>sort</function>.
+ </para>
     <simpara>
      See also <function>asort</function>, <function>arsort</function>,
      <function>sort</function>, and <function>rsort</function>.
@@ -1952,6 +1976,7 @@
      <funcprototype>
       <funcdef>void <function>rsort</function></funcdef>
       <paramdef>array <parameter>array</parameter></paramdef>
+ <paramdef>int <parameter><optional>sort_flags</optional></parameter></paramdef>
      </funcprototype>
     </funcsynopsis>
     <para>
@@ -1985,6 +2010,11 @@
      The fruits have been sorted in reverse alphabetical order.
     </para>
     <para>
+ You may modify the behavior of the sort using the optional
+ parameter <parameter>sort_flags</parameter>, for details
+ see <function>sort</function>.
+ </para>
+ <para>
      See also: <function>arsort</function>,
      <function>asort</function>, <function>ksort</function>,
      <function>sort</function>, and <function>usort</function>.
@@ -2061,6 +2091,7 @@
      <funcprototype>
       <funcdef>void <function>sort</function></funcdef>
       <paramdef>array <parameter>array</parameter></paramdef>
+ <paramdef>int <parameter><optional>sort_flags</optional></parameter></paramdef>
      </funcprototype>
     </funcsynopsis>
     <para>
@@ -2093,6 +2124,35 @@
     </para>
     <para>
      The fruits have been sorted in alphabetical order.
+ </para>
+ <para>
+ The optional second parameter <parameter>sort_flags</parameter>
+ may be used to modify the sorting behavior using theese valies:
+ </para>
+ <para>
+ Sorting order flags:
+ <itemizedlist>
+ <listitem>
+ <simpara>SORT_ASC - sort in ascending order</simpara>
+ </listitem>
+ <listitem>
+ <simpara>SORT_DESC - sort in descending order</simpara>
+ </listitem>
+ </itemizedlist>
+ </para>
+ <para>
+ Sorting type flags:
+ <itemizedlist>
+ <listitem>
+ <simpara>SORT_REGULAR - compare items normally</simpara>
+ </listitem>
+ <listitem>
+ <simpara>SORT_NUMERIC - compare items numerically</simpara>
+ </listitem>
+ <listitem>
+ <simpara>SORT_STRING - compare items as strings</simpara>
+ </listitem>
+ </itemizedlist>
     </para>
     <para>
      See also: <function>arsort</function>,