<!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>Add a group sort field (group.sort parameter)</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="solrquery.addgroupquery.html">SolrQuery::addGroupQuery</a></div>
<div class="next" style="text-align: right; float: right;"><a href="solrquery.addhighlightfield.html">SolrQuery::addHighlightField</a></div>
<div class="up"><a href="class.solrquery.html">SolrQuery</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="solrquery.addgroupsortfield" class="refentry">
<div class="refnamediv">
<h1 class="refname">SolrQuery::addGroupSortField</h1>
<p class="verinfo">(PECL solr >= 2.2.0)</p><p class="refpurpose"><span class="refname">SolrQuery::addGroupSortField</span> — <span class="dc-title">Add a group sort field (group.sort parameter)</span></p>
</div>
<div class="refsect1 description" id="refsect1-solrquery.addgroupsortfield-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type"><a href="class.solrquery.html" class="type SolrQuery">SolrQuery</a></span> <span class="methodname"><strong>SolrQuery::addGroupSortField</strong></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$field</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$order</code></span>
] )</div>
<p class="para rdfs-comment">
Allow sorting group documents, using group sort field (group.sort parameter).
</p>
</div>
<div class="refsect1 parameters" id="refsect1-solrquery.addgroupsortfield-parameters">
<h3 class="title">Parameters</h3>
<dl>
<dt>
<code class="parameter">field</code></dt>
<dd>
<p class="para">
Field name
</p>
</dd>
<dt>
<code class="parameter">order</code></dt>
<dd>
<p class="para">
Order ASC/DESC, utilizes SolrQuery::ORDER_* constants
</p>
</dd>
</dl>
</div>
<div class="refsect1 returnvalues" id="refsect1-solrquery.addgroupsortfield-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
</p>
</div>
<div class="refsect1 examples" id="refsect1-solrquery.addgroupsortfield-examples">
<h3 class="title">Examples</h3>
<div class="example" id="example-5889">
<p><strong>Example #1 <span class="function"><strong>SolrQuery::addGroupSortField()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /><br />$solrQuery </span><span style="color: #007700">= new </span><span style="color: #0000BB">SolrQuery</span><span style="color: #007700">(</span><span style="color: #DD0000">'*:*'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$solrQuery<br /> </span><span style="color: #007700">-></span><span style="color: #0000BB">setGroup</span><span style="color: #007700">(</span><span style="color: #0000BB">true</span><span style="color: #007700">)<br /> -></span><span style="color: #0000BB">addGroupSortField</span><span style="color: #007700">(</span><span style="color: #DD0000">'price'</span><span style="color: #007700">, </span><span style="color: #0000BB">SolrQuery</span><span style="color: #007700">::</span><span style="color: #0000BB">ORDER_ASC</span><span style="color: #007700">);<br /> <br />echo </span><span style="color: #0000BB">$solrQuery</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>
q=*:*&group=true&group.sort=price asc
</pre></div>
</div>
</div>
</div>
<div class="refsect1 seealso" id="refsect1-solrquery.addgroupsortfield-seealso">
<h3 class="title">See Also</h3>
<ul class="simplelist">
<li class="member"><span class="methodname"><a href="solrquery.setgroup.html" class="methodname" rel="rdfs-seeAlso">SolrQuery::setGroup()</a> - Enable/Disable result grouping (group parameter)</span></li>
<li class="member"><span class="methodname"><a href="solrquery.addgroupfield.html" class="methodname" rel="rdfs-seeAlso">SolrQuery::addGroupField()</a> - Add a field to be used to group results</span></li>
<li class="member"><span class="methodname"><a href="solrquery.addgroupfunction.html" class="methodname" rel="rdfs-seeAlso">SolrQuery::addGroupFunction()</a> - Allows grouping results based on the unique values of a function query (group.func parameter)</span></li>
<li class="member"><span class="methodname"><a href="solrquery.addgroupquery.html" class="methodname" rel="rdfs-seeAlso">SolrQuery::addGroupQuery()</a> - Allows grouping of documents that match the given query</span></li>
<li class="member"><span class="methodname"><a href="solrquery.setgroupfacet.html" class="methodname" rel="rdfs-seeAlso">SolrQuery::setGroupFacet()</a> - Sets group.facet parameter</span></li>
<li class="member"><span class="methodname"><a href="solrquery.setgroupoffset.html" class="methodname" rel="rdfs-seeAlso">SolrQuery::setGroupOffset()</a> - Sets the group.offset parameter</span></li>
<li class="member"><span class="methodname"><a href="solrquery.setgrouplimit.html" class="methodname" rel="rdfs-seeAlso">SolrQuery::setGroupLimit()</a> - Specifies the number of results to return for each group. The server default value is 1</span></li>
<li class="member"><span class="methodname"><a href="solrquery.setgroupmain.html" class="methodname" rel="rdfs-seeAlso">SolrQuery::setGroupMain()</a> - If true, the result of the first field grouping command is used as the main result list in the response, using group.format=simple</span></li>
<li class="member"><span class="methodname"><a href="solrquery.setgroupngroups.html" class="methodname" rel="rdfs-seeAlso">SolrQuery::setGroupNGroups()</a> - If true, Solr includes the number of groups that have matched the query in the results</span></li>
<li class="member"><span class="methodname"><a href="solrquery.setgrouptruncate.html" class="methodname" rel="rdfs-seeAlso">SolrQuery::setGroupTruncate()</a> - If true, facet counts are based on the most relevant document of each group matching the query</span></li>
<li class="member"><span class="methodname"><a href="solrquery.setgroupformat.html" class="methodname" rel="rdfs-seeAlso">SolrQuery::setGroupFormat()</a> - Sets the group format, result structure (group.format parameter)</span></li>
<li class="member"><span class="methodname"><a href="solrquery.setgroupcachepercent.html" class="methodname" rel="rdfs-seeAlso">SolrQuery::setGroupCachePercent()</a> - Enables caching for result grouping</span></li>
</ul>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="solrquery.addgroupquery.html">SolrQuery::addGroupQuery</a></div>
<div class="next" style="text-align: right; float: right;"><a href="solrquery.addhighlightfield.html">SolrQuery::addHighlightField</a></div>
<div class="up"><a href="class.solrquery.html">SolrQuery</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
