usort.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 5d19b00f2f70fa61eee46fee4049b625a8a9bfd2 Maintainer: hholzgra Status: ready -->
<!-- Reviewed: yes -->
<!-- Rev-Revision: d1df62fe77b6cb0676d064e8e63ee2c3304d4260 Reviewer: samesch -->
<!-- CREDITS: tom, simp -->
<refentry xml:id="function.usort" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>usort</refname>
  <refpurpose>
   Sortiert ein Array nach Werten mittels einer benutzerdefinierten Vergleichsfunktion
  </refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>true</type><methodname>usort</methodname>
   <methodparam><type>array</type><parameter role="reference">array</parameter></methodparam>
   <methodparam><type>callable</type><parameter>callback</parameter></methodparam>
  </methodsynopsis>
  <para>
   Diese Funktion sortiert <parameter>array</parameter> nach seinen Werten
   mittels einer benutzerdefinierten Vergleichsfunktion, um die Reihenfolge
   zu bestimmen.
  </para>
  &note.sort-unstable;
  &note.no-key-association;
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>array</parameter></term>
     <listitem>
      <para>
       Das zu sortierende Array.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>callback</parameter></term>
     <listitem>
      &sort.callback.description;
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.true.always;
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     &return.type.true;
     &array.changelog.by-ref;
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example xml:id="function.usort.examples.basic">
    <title><function>usort</function>-Beispiel</title>
    <programlisting role="php">
<![CDATA[
<?php
function cmp($a, $b)
{
    if ($a == $b) {
        return 0;
    }
    return ($a < $b) ? -1 : 1;
}

$a = array(3, 2, 5, 6, 1);

usort($a, "cmp");

foreach ($a as $key => $value) {
    echo "$key: $value\n";
}
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
0: 1
1: 2
2: 3
3: 5
4: 6
]]>
    </screen>
    <para>
     Der Raumschiff-Operator kann verwendet werden, um den internen Vergleich
     noch weiter zu vereinfachen.
    </para>
    <programlisting role="php">
<![CDATA[
<?php
function cmp($a, $b)
{
    return $a <=> $b;
}

$a = array(3, 2, 5, 6, 1);

usort($a, "cmp");

foreach ($a as $key => $value) {
    echo "$key: $value\n";
}
?>
]]>
    </programlisting>
   </example>
  </para>
  <note>
   <para>
    Für dieses einfache Beispiel wäre die Funktion <function>sort</function>
    offensichtlich die bessere Wahl.
   </para>
  </note>
  <para>
   <example xml:id="function.usort.examples.multi">
    <title>
     <function>usort</function>-Beispiel für mehrdimensionale Arrays
    </title>
    <programlisting role="php">
<![CDATA[
<?php
function cmp($a, $b)
{
    return strcmp($a["frucht"], $b["frucht"]);
}

$fruechte[0]["frucht"] = "Zitronen";
$fruechte[1]["frucht"] = "Aepfel";
$fruechte[2]["frucht"] = "Orangen";

usort($fruechte, "cmp");

foreach ($fruechte as $key => $value) {
    echo "\$fruechte[$key]: " . $value["frucht"] . "\n";
}
?>
]]>
    </programlisting>
    <para>
     Wenn ein mehrdimensionales Array sortiert wird, enthalten
     <varname>$a</varname> und <varname>$b</varname> Verweise auf den
     ersten Index des Arrays.
    </para>
    &example.outputs;
    <screen>
<![CDATA[
$fruechte[0]: Aepfel
$fruechte[1]: Orangen
$fruechte[2]: Zitronen
]]>
    </screen>
   </example>
  </para>
  <para>
   <example xml:id="function.usort.examples.object">
    <title>
     <function>usort</function>-Beispiel, das die Methode eines Objekts benutzt
    </title>
    <programlisting role="php">
<![CDATA[
<?php
class TestObj {
    public string $name;

    function __construct($name)
    {
        $this->name = $name;
    }

    /* Dies ist die statische Vergleichsfunktion */
    static function cmp_obj($a, $b)
    {
        return strtolower($a->name) <=> strtolower($b->name);
    }
}

$a[] = new TestObj("c");
$a[] = new TestObj("b");
$a[] = new TestObj("d");

usort($a, [TestObj::class, "cmp_obj"]);

foreach ($a as $item) {
    echo $item->name . "\n";
}
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
b
c
d
]]>
    </screen>
   </example>
   <example xml:id="function.usort.examples.closure">
    <title>
     <function>usort</function>-Beispiel zum Einsatz einer
     <link linkend="functions.anonymous">Closure</link> zum Sortieren eines
     mehrdimensionalen Arrays
    </title>
    <programlisting role="php">
<![CDATA[
<?php
$array[0] = array('key_a' => 'z', 'key_b' => 'c');
$array[1] = array('key_a' => 'x', 'key_b' => 'b');
$array[2] = array('key_a' => 'y', 'key_b' => 'a');

function build_sorter($key) {
    return function ($a, $b) use ($key) {
        return strnatcmp($a[$key], $b[$key]);
    };
}

usort($array, build_sorter('key_b'));

foreach ($array as $item) {
    echo $item['key_a'] . ', ' . $item['key_b'] . "\n";
}
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
y, a
x, b
z, c
]]>
    </screen>
   </example>
   <example xml:id="function.usort.examples.multiple-axes">
    <title>
     <function>usort</function> Beispiel unter Verwendung des Raumschiff-Operators
    </title>
    <para>
     Der Raumschiff-Operator ermöglicht den einfachen Vergleich von
     zusammengesetzten Werten über mehrere Achsen hinweg. Das folgende
     Beispiel sortiert <literal>$people</literal> nach dem Nachnamen und
     anschließend, wenn der Nachname übereinstimmt, nach dem Vornamen.
    </para>
    <programlisting role="php">
<![CDATA[
<?php
$people[0] = ['first' => 'Adam', 'last' => 'West'];
$people[1] = ['first' => 'Alec', 'last' => 'Baldwin'];
$people[2] = ['first' => 'Adam', 'last' => 'Baldwin'];

function sorter(array $a, array $b) {
    return [$a['last'], $a['first']] <=> [$b['last'], $b['first']];
}

usort($people, 'sorter');

foreach ($people as $person) {
    print $person['last'] . ', ' . $person['first'] . PHP_EOL;
}
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
Baldwin, Adam
Baldwin, Alec
West, Adam
]]>
    </screen>
   </example>
  </para>
 </refsect1>

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