mirror of
https://github.com/php/doc-en.git
synced 2026-03-24 07:42:10 +01:00
2226ad08fd
Create an XML sort.callback.description entity which contains the description of this parameter with the caution Co-authored-by: George Peter Banyard <girgias@php.net>
133 lines
3.1 KiB
XML
133 lines
3.1 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xml:id="arrayobject.uksort" xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>ArrayObject::uksort</refname>
|
|
<refpurpose>Sort the entries by keys using a user-defined comparison function</refpurpose>
|
|
</refnamediv>
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis role="ArrayObject">
|
|
<modifier>public</modifier> <type>true</type><methodname>ArrayObject::uksort</methodname>
|
|
<methodparam><type>callable</type><parameter>callback</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
This function sorts the keys of the entries using a user-supplied
|
|
comparison function. The key to entry correlations will be maintained.
|
|
</para>
|
|
¬e.sort-unstable;
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<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;
|
|
<para>
|
|
<informaltable>
|
|
<tgroup cols="2">
|
|
<thead>
|
|
<row>
|
|
<entry>&Version;</entry>
|
|
<entry>&Description;</entry>
|
|
</row>
|
|
</thead>
|
|
<tbody>
|
|
&return.type.true;
|
|
</tbody>
|
|
</tgroup>
|
|
</informaltable>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example>
|
|
<title><function>ArrayObject::uksort</function> example</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
function cmp($a, $b) {
|
|
$a = preg_replace('@^(a|an|the) @', '', $a);
|
|
$b = preg_replace('@^(a|an|the) @', '', $b);
|
|
return strcasecmp($a, $b);
|
|
}
|
|
|
|
$array = array("John" => 1, "the Earth" => 2, "an apple" => 3, "a banana" => 4);
|
|
$arrayObject = new ArrayObject($array);
|
|
$arrayObject->uksort('cmp');
|
|
|
|
foreach ($arrayObject as $key => $value) {
|
|
echo "$key: $value\n";
|
|
}
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
&example.outputs;
|
|
<screen>
|
|
<![CDATA[
|
|
an apple: 3
|
|
a banana: 4
|
|
the Earth: 2
|
|
John: 1
|
|
]]>
|
|
</screen>
|
|
</example>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><methodname>ArrayObject::asort</methodname></member>
|
|
<member><methodname>ArrayObject::ksort</methodname></member>
|
|
<member><methodname>ArrayObject::natsort</methodname></member>
|
|
<member><methodname>ArrayObject::natcasesort</methodname></member>
|
|
<member><methodname>ArrayObject::uasort</methodname></member>
|
|
<member><function>uksort</function></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
|
|
-->
|