<!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 grouping 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.fields.html">CollectionFind::fields</a></div> <div class="next" style="text-align: right; float: right;"><a href="mysql-xdevapi-collectionfind.having.html">CollectionFind::having</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.groupby" class="refentry"> <div class="refnamediv"> <h1 class="refname">CollectionFind::groupBy</h1> <p class="verinfo">(No version information available, might only be in Git)</p><p class="refpurpose"><span class="refname">CollectionFind::groupBy</span> — <span class="dc-title">Set grouping criteria</span></p> </div> <div class="refsect1 description" id="refsect1-mysql-xdevapi-collectionfind.groupby-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::groupBy</strong></span> ( <span class="methodparam"><span class="type">string</span> <code class="parameter">$sort_expr</code></span> )</div> <p class="para rdfs-comment"> This function can be used to group the result-set by one more columns, frequently this is used with aggregate functions like COUNT,MAX,MIN,SUM etc. </p> </div> <div class="refsect1 parameters" id="refsect1-mysql-xdevapi-collectionfind.groupby-parameters"> <h3 class="title">Parameters</h3> <dl> <dt> <code class="parameter">sort_expr</code></dt> <dd> <p class="para"> The columns or columns that have to be used for the group operation, this can either be a single string or an array of string arguments, one for each column. </p> </dd> </dl> </div> <div class="refsect1 returnvalues" id="refsect1-mysql-xdevapi-collectionfind.groupby-returnvalues"> <h3 class="title">Return Values</h3> <p class="para"> A CollectionFind that can be used for further processing </p> </div> <div class="refsect1 examples" id="refsect1-mysql-xdevapi-collectionfind.groupby-examples"> <h3 class="title">Examples</h3> <div class="example" id="example-2001"> <p><strong>Example #1 <span class="function"><strong>mysql_xdevapi\CollectionFind::groupBy()</strong></span> example</strong></p> <div class="example-contents"> <div class="phpcode"><code><span style="color: #000000"> <span style="color: #0000BB"><?php<br /><br /></span><span style="color: #FF8000">//Assuming $coll is a valid Collection object<br /><br />//Extract all the documents from the Collection and group the results by the 'name' field<br /></span><span style="color: #0000BB">$res </span><span style="color: #007700">= </span><span style="color: #0000BB">$coll</span><span style="color: #007700">-></span><span style="color: #0000BB">find</span><span style="color: #007700">()-></span><span style="color: #0000BB">groupBy</span><span style="color: #007700">(</span><span style="color: #DD0000">'name'</span><span style="color: #007700">)-></span><span style="color: #0000BB">execute</span><span style="color: #007700">();<br /><br /></span><span style="color: #0000BB">?></span> </span> </code></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.fields.html">CollectionFind::fields</a></div> <div class="next" style="text-align: right; float: right;"><a href="mysql-xdevapi-collectionfind.having.html">CollectionFind::having</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>