mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-19 10:28:54 +00:00
3ce14fde5c
Normalizing parameter names in docs first to later update arginfos from that. git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@331477 c90b9560-bf6c-de11-be94-00142212c4b1
390 lines
10 KiB
XML
390 lines
10 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xml:id="function.array-multisort" xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>array_multisort</refname>
|
|
<refpurpose>Sort multiple or multi-dimensional arrays</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 choice="opt"><type>mixed</type><parameter>...</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
<function>array_multisort</function> can be used to sort several
|
|
arrays at once, or a multi-dimensional array by one or more
|
|
dimensions.
|
|
</para>
|
|
<para>
|
|
Associative (<type>string</type>) keys will be maintained, but numeric
|
|
keys will be re-indexed.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>array1</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
An <type>array</type> being sorted.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>array1_sort_order</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The order used to sort the previous <type>array</type> argument. Either
|
|
<constant>SORT_ASC</constant> to sort ascendingly or <constant>SORT_DESC</constant>
|
|
to sort descendingly.
|
|
</para>
|
|
<para>
|
|
This argument can be swapped with <parameter>array1_sort_flags</parameter>
|
|
or omitted entirely, in which case <constant>SORT_ASC</constant> is assumed.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>array1_sort_flags</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Sort options for the previous <type>array</type> argument:
|
|
</para>
|
|
<para>
|
|
Sorting type flags:
|
|
<itemizedlist>
|
|
<listitem>
|
|
<simpara><constant>SORT_REGULAR</constant> - compare items normally
|
|
(don't change types)</simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara><constant>SORT_NUMERIC</constant> - compare items numerically</simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara><constant>SORT_STRING</constant> - compare items as strings</simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara>
|
|
<constant>SORT_LOCALE_STRING</constant> - compare items as
|
|
strings, based on the current locale. It uses the locale,
|
|
which can be changed using <function>setlocale</function>
|
|
</simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara>
|
|
<constant>SORT_NATURAL</constant> - compare items as strings
|
|
using "natural ordering" like <function>natsort</function>
|
|
</simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara>
|
|
<constant>SORT_FLAG_CASE</constant> - can be combined
|
|
(bitwise OR) with
|
|
<constant>SORT_STRING</constant> or
|
|
<constant>SORT_NATURAL</constant> to sort strings case-insensitively
|
|
</simpara>
|
|
</listitem>
|
|
</itemizedlist>
|
|
</para>
|
|
<para>
|
|
This argument can be swapped with <parameter>array1_sort_order</parameter>
|
|
or omitted entirely, in which case <constant>SORT_REGULAR</constant> is assumed.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>...</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
More arrays, optionally followed by sort order and flags.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
&return.success;
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="changelog">
|
|
&reftitle.changelog;
|
|
<para>
|
|
<informaltable>
|
|
<tgroup cols="2">
|
|
<thead>
|
|
<row>
|
|
<entry>&Version;</entry>
|
|
<entry>&Description;</entry>
|
|
</row>
|
|
</thead>
|
|
<tbody>
|
|
<row>
|
|
<entry>5.4.0</entry>
|
|
<entry>
|
|
The <constant>SORT_NATURAL</constant> and <constant>SORT_FLAG_CASE</constant>
|
|
were added to <parameter>array1_sort_flags</parameter> as possible sort flags.
|
|
</entry>
|
|
</row>
|
|
<row>
|
|
<entry>5.3.0</entry>
|
|
<entry>
|
|
The <constant>SORT_LOCALE_STRING</constant> was added to
|
|
<parameter>array1_sort_flags</parameter> as possible sort flags.
|
|
</entry>
|
|
</row>
|
|
</tbody>
|
|
</tgroup>
|
|
</informaltable>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example>
|
|
<title>Sorting multiple arrays</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>
|
|
In this example, after sorting, the first array will contain 0,
|
|
10, 100, 100. The second array will contain 4, 1, 2, 3. The
|
|
entries in the second array corresponding to the identical
|
|
entries in the first array (100 and 100) were sorted as well.
|
|
</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>Sorting multi-dimensional array</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>
|
|
In this example, after sorting, the first array will transform to
|
|
"10", 100, 100, 11, "a" (it was sorted as strings in ascending
|
|
order). The second will contain 1, 3, "2", 2, 1 (sorted as numbers,
|
|
in descending order).
|
|
</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>Sorting database results</title>
|
|
<para>
|
|
For this example, each element in the <varname>data</varname>
|
|
array represents one row in a table. This type of dataset is typical
|
|
of database records.
|
|
</para>
|
|
<para>
|
|
Example data:
|
|
</para>
|
|
<screen>
|
|
<![CDATA[
|
|
volume | edition
|
|
-------+--------
|
|
67 | 2
|
|
86 | 1
|
|
85 | 6
|
|
98 | 2
|
|
86 | 6
|
|
67 | 7
|
|
]]>
|
|
</screen>
|
|
<para>
|
|
The data as an array, called <varname>data</varname>. This would usually,
|
|
for example, be obtained by looping with <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>
|
|
In this example, we will order by <varname>volume</varname> descending,
|
|
<varname>edition</varname> ascending.
|
|
</para>
|
|
<para>
|
|
We have an array of rows, but <function>array_multisort</function>
|
|
requires an array of columns, so we use the below code to obtain the
|
|
columns, then perform the sorting.
|
|
</para>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
// Obtain a list of columns
|
|
foreach ($data as $key => $row) {
|
|
$volume[$key] = $row['volume'];
|
|
$edition[$key] = $row['edition'];
|
|
}
|
|
|
|
// Sort the data with volume descending, edition ascending
|
|
// Add $data as the last parameter, to sort by the common key
|
|
array_multisort($volume, SORT_DESC, $edition, SORT_ASC, $data);
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
<para>
|
|
The dataset is now sorted, and will look like this:
|
|
</para>
|
|
<screen>
|
|
<![CDATA[
|
|
volume | edition
|
|
-------+--------
|
|
98 | 2
|
|
86 | 1
|
|
86 | 6
|
|
85 | 6
|
|
67 | 2
|
|
67 | 7
|
|
]]>
|
|
</screen>
|
|
</example>
|
|
</para>
|
|
<para>
|
|
<example>
|
|
<title>Case insensitive sorting</title>
|
|
<para>
|
|
Both <constant>SORT_STRING</constant> and
|
|
<constant>SORT_REGULAR</constant> are case sensitive, strings
|
|
starting with a capital letter will come before strings starting
|
|
with a lowercase letter.
|
|
</para>
|
|
<para>
|
|
To perform a case insensitive search, force the sorting order to be
|
|
determined by a lowercase copy of the original array.
|
|
</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
|
|
-->
|