php-doc-en/reference/spl/arrayobject/asort.xml
Jakub Vrana 81ee02feed Methods visibility
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@322381 c90b9560-bf6c-de11-be94-00142212c4b1
2012-01-17 08:20:53 +00:00

104 lines
2.5 KiB
XML

<?xml version="1.0" encoding="UTF-8"?>
<!-- $Revision$ -->
<refentry xml:id="arrayobject.asort" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>ArrayObject::asort</refname>
<refpurpose>Sort the entries by value</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>ArrayObject::asort</methodname>
<void/>
</methodsynopsis>
<para>
Sorts the entries such that the keys maintain
their correlation with the entries they are associated
with. This is used mainly when sorting associative arrays where
the actual element order is significant.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>ArrayObject::asort</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$fruits = array("d" => "lemon", "a" => "orange", "b" => "banana", "c" => "apple");
$fruitArrayObject = new ArrayObject($fruits);
$fruitArrayObject->asort();
foreach ($fruitArrayObject as $key => $val) {
echo "$key = $val\n";
}
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
c = apple
b = banana
d = lemon
a = orange
]]>
</screen>
<para>
The fruits have been sorted in alphabetical order, and the key
associated with each entry has been maintained.
</para>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<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><methodname>ArrayObject::uksort</methodname></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
-->