sigmasternchen/php-doc-en
1
0
Fork 0
mirror of https://github.com/sigmasternchen/php-doc-en synced 2025-03-16 00:48:54 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Explain the fields array better.

Browse source 
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@321508 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Derick Rethans 2011-12-29 14:51:09 +00:00
parent e1dd919618
commit 255568b4c9
1 changed files with 15 additions and 33 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

48
reference/mongo/mongocursor/sort.xml
View file

@ -25,7 +25,15 @@
</term>
<listitem>
<para>
The fields by which to sort.
An array of fields by which to sort. Each element in the array has as
key the field name, and as value either <literal>1</literal> for
ascending sort, or <literal>-1</literal> for descending sort.
</para>
<para>
Each result is first sorted on the first field in the array, then (if
it exists) on the second field in the array, etc. This means that the
order of the fields in the <parameter>fields</parameter> array is
important. See also the examples section.
</para>
</listitem>
</varlistentry>
@ -36,7 +44,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns this cursor.
Returns the same cursor that this method was called on.
</para>
</refsect1>
@ -47,32 +55,6 @@
</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>1.3.0</entry>
<entry>
The <parameter>options</parameter> parameter does no longer accept
just a boolean to signify a safe insert. Instead, this now has to be done
with <literal>array('safe' => true)</literal>.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<example>
@ -80,16 +62,16 @@
<programlisting role="php">
<![CDATA[
<?php
// sort x ascending
// Sort on field x, ascending
$cursor->sort(array('x' => 1));
// the associative array is ordered, for instance, these two
// examples might yield different results:
// The order in the associative array is important. For instance, these two
// examples will yield different results:
// sort date ascending and age descending
// Sort on date ascending and age descending
$cursor->sort(array('date' => 1, 'age' => -1));
// sort age descending and date ascending
// Sort on age descending and date ascending
$cursor->sort(array('age' => -1, 'date' => 1));
?>
]]>