array-multisort.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 6a6f43d1c490a57b452656db285de6d136055ed2 Maintainer: HonestQiao Status: ready -->
<refentry xml:id="function.array-multisort" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>array_multisort</refname>
  <refpurpose>对多个数组或多维数组进行排序</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>array_multisort</methodname>
   <methodparam><type>array</type><parameter role="reference">array1</parameter></methodparam>
   <methodparam choice="opt"><type>mixed</type><parameter>array1_sort_order</parameter><initializer>SORT_ASC</initializer></methodparam>
   <methodparam choice="opt"><type>mixed</type><parameter>array1_sort_flags</parameter><initializer>SORT_REGULAR</initializer></methodparam>
   <methodparam rep="repeat"><type>mixed</type><parameter>rest</parameter></methodparam>
  </methodsynopsis>
  <para>
   <function>array_multisort</function>
   可以用来一次对多个数组进行排序，或者根据某一维或多维对多维数组进行排序。
  </para>
  <para>
   关联（<type>string</type>）键名保持不变，但数字键名会被重新索引。
  </para>
  &note.sort-unstable;
 </refsect1>
 
 <refsect1 role="parameters">
  &reftitle.parameters;
  &note.reset-index;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>array1</parameter></term>
     <listitem>
      <para>
       要排序的 <type>array</type>。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>array1_sort_order</parameter></term>
     <listitem>
      <para>
       之前 <type>array</type>  参数要排列的顺序。
       <constant>SORT_ASC</constant> 按照上升顺序排序， <constant>SORT_DESC</constant> 按照下降顺序排序。
      </para>
      <para>
       此参数可以和 <parameter>array1_sort_flags</parameter> 互换，也可以完全删除，默认是 <constant>SORT_ASC</constant> 。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>array1_sort_flags</parameter></term>
     <listitem>
      <para>
       为 <type>array</type> 参数设定选项：
      </para>
      <para>
       排序类型标志：
       <itemizedlist>
        <listitem>
         <simpara><constant>SORT_REGULAR</constant> - 
          将项目按照通常方法比较（不修改类型）
         </simpara>
        </listitem>
        <listitem>
         <simpara><constant>SORT_NUMERIC</constant> - 按照数字大小比较</simpara>
        </listitem>
        <listitem>
         <simpara><constant>SORT_STRING</constant> -  按照字符串比较</simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>SORT_LOCALE_STRING</constant> -  根据当前的本地化设置，按照字符串比较。 
          它会使用 locale 信息，可以通过 <function>setlocale</function> 修改此信息。
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>SORT_NATURAL</constant> - 以字符串的"自然排序"，类似 <function>natsort</function>
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>SORT_FLAG_CASE</constant> - 可以组合
          (按位或 OR) 
          <constant>SORT_STRING</constant> 或者
          <constant>SORT_NATURAL</constant> 大小写不敏感的方式排序字符串。
         </simpara>
        </listitem>
       </itemizedlist>
      </para>
      <para>
       参数可以和 <parameter>array1_sort_order</parameter> 交换或者省略，默认情况下是 <constant>SORT_REGULAR</constant>。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>rest</parameter></term>
     <listitem>
      <para>
       可选的选项，可提供更多数组，跟随在 sort order 和 sort flag 之后。
       提供的数组和之前的数组要有相同数量的元素。
       换言之，排序是按字典顺序排列的。
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.success;
  </para>
 </refsect1>
 
 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>多个数组排序</title>
    <programlisting role="php">
<![CDATA[
<?php
$ar1 = array(10, 100, 100, 0);
$ar2 = array(1, 3, 2, 4);
array_multisort($ar1, $ar2);

var_dump($ar1);
var_dump($ar2);
?>
]]>
    </programlisting>
    <para>
     这个例子里，排序后，第一个数组会包含  0、
     10、 100、 100。
     第二个数组会包含 4、1、 2、 3。
     第二个数组里的项目对应第一个数组后也进行了排序（100 和 100）。
    </para>
    <screen>
<![CDATA[
array(4) {
  [0]=> int(0)
  [1]=> int(10)
  [2]=> int(100)
  [3]=> int(100)
}
array(4) {
  [0]=> int(4)
  [1]=> int(1)
  [2]=> int(2)
  [3]=> int(3)
}
]]>
    </screen>
   </example>
  </para>
  <para>
   <example>
    <title>排序多维数组</title>
    <programlisting role="php">
<![CDATA[
<?php
$ar = array(
       array("10", 11, 100, 100, "a"),
       array(   1,  2, "2",   3,   1)
      );
array_multisort($ar[0], SORT_ASC, SORT_STRING,
                $ar[1], SORT_NUMERIC, SORT_DESC);
var_dump($ar);
?>
]]>
    </programlisting>
    <para>
     本例中在排序后，第一个数组将变成
     "10"，100，100，11，"a"（被当作字符串以升序排列）。第二个数组将包含
     1, 3, "2", 2, 1（被当作数字以降序排列）。
    </para>
    <screen>
<![CDATA[
array(2) {
  [0]=> array(5) {
    [0]=> string(2) "10"
    [1]=> int(100)
    [2]=> int(100)
    [3]=> int(11)
    [4]=> string(1) "a"
  }
  [1]=> array(5) {
    [0]=> int(1)
    [1]=> int(3)
    [2]=> string(1) "2"
    [3]=> int(2)
    [4]=> int(1)
  }
}
]]>
    </screen>
   </example>
  </para>
  <para>
   <example>
    <title>对数据库结果进行排序</title>
    <para>
     本例中 <varname>data</varname>
     数组中的每个单元表示一个表中的一行。这是典型的数据库记录的数据集合。
    </para>
    <para>
     例子中的数据如下：
    </para>
    <screen>
<![CDATA[
volume | edition
-------+--------
    67 |       2
    86 |       1
    85 |       6
    98 |       2
    86 |       6
    67 |       7
]]>
    </screen>
    <para>
     数据全都存放在名为 <varname>data</varname>
     的数组中。这通常是通过循环从数据库取得的结果，例如
     <function>mysql_fetch_assoc</function>。
    </para>
    <programlisting role="php">
<![CDATA[
<?php
$data[] = array('volume' => 67, 'edition' => 2);
$data[] = array('volume' => 86, 'edition' => 1);
$data[] = array('volume' => 85, 'edition' => 6);
$data[] = array('volume' => 98, 'edition' => 2);
$data[] = array('volume' => 86, 'edition' => 6);
$data[] = array('volume' => 67, 'edition' => 7);
?>
]]>
    </programlisting>
    <para>
     本例中将把 <varname>volume</varname> 降序排列，把
     <varname>edition</varname> 升序排列。
    </para>
    <para>
     现在有了包含有行的数组，但是 <function>array_multisort</function>
     需要一个包含列的数组，因此用以下代码来取得列，然后排序。
    </para>
    <programlisting role="php">
<![CDATA[
<?php
// 取得列的列表
foreach ($data as $key => $row) {
    $volume[$key]  = $row['volume'];
    $edition[$key] = $row['edition'];
}

// 你可以使用 array_column() 代替上面的代码
$volume  = array_column($data, 'volume');
$edition = array_column($data, 'edition');

// 将数据根据 volume 降序排列，根据 edition 升序排列
// 把 $data 作为最后一个参数，以通用键排序
array_multisort($volume, SORT_DESC, $edition, SORT_ASC, $data);
?>
]]>
    </programlisting>
    <para>
     数据集合现在排好序了，结果如下：
    </para>
    <screen>
<![CDATA[
volume | edition
-------+--------
    98 |       2
    86 |       1
    86 |       6
    85 |       6
    67 |       2
    67 |       7
]]>
    </screen>
   </example>
  </para>
  <para>
   <example>
    <title>不区分大小写字母排序</title>
    <para>
     <constant>SORT_STRING</constant> 和
     <constant>SORT_REGULAR</constant>
     都是区分大小写字母的，大写字母会排在小写字母之前。
    </para>
    <para>
     要进行不区分大小写的排序，就要按照原数组的小写字母拷贝来排序。
    </para>
    <programlisting role="php">
<![CDATA[
<?php
$array = array('Alpha', 'atomic', 'Beta', 'bank');
$array_lowercase = array_map('strtolower', $array);

array_multisort($array_lowercase, SORT_ASC, SORT_STRING, $array);

print_r($array);
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
Array
(
    [0] => Alpha
    [1] => atomic
    [2] => bank
    [3] => Beta
)
]]>
    </screen>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>usort</function></member>
    <member>&seealso.array.sorting;</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
-->