<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Set the sorting criteria</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="mysql-xdevapi-collectionfind.offset.html">CollectionFind::offset</a></div>
<div class="next" style="text-align: right; float: right;"><a href="class.mysql-xdevapi-collectionmodify.html">mysql_xdevapi\CollectionModify</a></div>
<div class="up"><a href="class.mysql-xdevapi-collectionfind.html">mysql_xdevapi\CollectionFind</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="mysql-xdevapi-collectionfind.sort" class="refentry">
<div class="refnamediv">
<h1 class="refname">CollectionFind::sort</h1>
<p class="verinfo">(No version information available, might only be in Git)</p><p class="refpurpose"><span class="refname">CollectionFind::sort</span> — <span class="dc-title">Set the sorting criteria</span></p>
</div>
<div class="refsect1 description" id="refsect1-mysql-xdevapi-collectionfind.sort-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type"><span class="type mysql_xdevapi\CollectionFind">mysql_xdevapi\CollectionFind</span></span> <span class="methodname"><strong>mysql_xdevapi\CollectionFind::sort</strong></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$sort_expr</code></span>
)</div>
<p class="para rdfs-comment">
Sort the result set by the field selected in the sort_expr argument. The allowed
orders are ASC (Ascending) or DESC (Descending). This operation is equivalent to the 'ORDER BY' SQL operation
and it follows the same set of rules.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-mysql-xdevapi-collectionfind.sort-parameters">
<h3 class="title">Parameters</h3>
<dl>
<dt>
<code class="parameter">sort_expr</code></dt>
<dd>
<p class="para">
One or more sorting expressions can be provided. The evaluation is from left to right,
and each expression is separated by a comma.
</p>
</dd>
</dl>
</div>
<div class="refsect1 returnvalues" id="refsect1-mysql-xdevapi-collectionfind.sort-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
A CollectionFind object that can be used to execute the command, or to add additional operations.
</p>
</div>
<div class="refsect1 examples" id="refsect1-mysql-xdevapi-collectionfind.sort-examples">
<h3 class="title">Examples</h3>
<div class="example" id="example-2007">
<p><strong>Example #1 <span class="function"><strong>mysql_xdevapi\CollectionFind::sort()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$session </span><span style="color: #007700">= </span><span style="color: #0000BB">mysql_xdevapi</span><span style="color: #007700">\</span><span style="color: #0000BB">getSession</span><span style="color: #007700">(</span><span style="color: #DD0000">"mysqlx://user:password@localhost"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$session</span><span style="color: #007700">-></span><span style="color: #0000BB">sql</span><span style="color: #007700">(</span><span style="color: #DD0000">"DROP DATABASE IF EXISTS addressbook"</span><span style="color: #007700">)-></span><span style="color: #0000BB">execute</span><span style="color: #007700">();<br /></span><span style="color: #0000BB">$session</span><span style="color: #007700">-></span><span style="color: #0000BB">sql</span><span style="color: #007700">(</span><span style="color: #DD0000">"CREATE DATABASE addressbook"</span><span style="color: #007700">)-></span><span style="color: #0000BB">execute</span><span style="color: #007700">();<br /><br /></span><span style="color: #0000BB">$schema </span><span style="color: #007700">= </span><span style="color: #0000BB">$session</span><span style="color: #007700">-></span><span style="color: #0000BB">getSchema</span><span style="color: #007700">(</span><span style="color: #DD0000">"addressbook"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$create </span><span style="color: #007700">= </span><span style="color: #0000BB">$schema</span><span style="color: #007700">-></span><span style="color: #0000BB">createCollection</span><span style="color: #007700">(</span><span style="color: #DD0000">"people"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$create<br /> </span><span style="color: #007700">-></span><span style="color: #0000BB">add</span><span style="color: #007700">(</span><span style="color: #DD0000">'{"name": "Alfred", "age": 18, "job": "Butler"}'</span><span style="color: #007700">)<br /> -></span><span style="color: #0000BB">execute</span><span style="color: #007700">();<br /></span><span style="color: #0000BB">$create<br /> </span><span style="color: #007700">-></span><span style="color: #0000BB">add</span><span style="color: #007700">(</span><span style="color: #DD0000">'{"name": "Reginald", "age": 42, "job": "Butler"}'</span><span style="color: #007700">)<br /> -></span><span style="color: #0000BB">execute</span><span style="color: #007700">();<br /><br /></span><span style="color: #FF8000">// ...<br /><br /></span><span style="color: #0000BB">$collection </span><span style="color: #007700">= </span><span style="color: #0000BB">$schema</span><span style="color: #007700">-></span><span style="color: #0000BB">getCollection</span><span style="color: #007700">(</span><span style="color: #DD0000">"people"</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$result </span><span style="color: #007700">= </span><span style="color: #0000BB">$collection<br /> </span><span style="color: #007700">-></span><span style="color: #0000BB">find</span><span style="color: #007700">()<br /> -></span><span style="color: #0000BB">sort</span><span style="color: #007700">(</span><span style="color: #DD0000">'job desc'</span><span style="color: #007700">, </span><span style="color: #DD0000">'age asc'</span><span style="color: #007700">)<br /> -></span><span style="color: #0000BB">execute</span><span style="color: #007700">();<br /><br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$result</span><span style="color: #007700">-></span><span style="color: #0000BB">fetchAll</span><span style="color: #007700">());<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
<div class="example-contents"><p>The above example will output
something similar to:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
array(2) {
[0]=>
array(4) {
["_id"]=>
string(28) "00005b6b53610000000000000106"
["age"]=>
int(18)
["job"]=>
string(6) "Butler"
["name"]=>
string(6) "Alfred"
}
[1]=>
array(4) {
["_id"]=>
string(28) "00005b6b53610000000000000107"
["age"]=>
int(42)
["job"]=>
string(6) "Butler"
["name"]=>
string(8) "Reginald"
}
}
</pre></div>
</div>
</div>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="mysql-xdevapi-collectionfind.offset.html">CollectionFind::offset</a></div>
<div class="next" style="text-align: right; float: right;"><a href="class.mysql-xdevapi-collectionmodify.html">mysql_xdevapi\CollectionModify</a></div>
<div class="up"><a href="class.mysql-xdevapi-collectionfind.html">mysql_xdevapi\CollectionFind</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
