<!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>Sorts the fields in the document</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="solrdocument.set.html">SolrDocument::__set</a></div>
<div class="next" style="text-align: right; float: right;"><a href="solrdocument.toarray.html">SolrDocument::toArray</a></div>
<div class="up"><a href="class.solrdocument.html">SolrDocument</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="solrdocument.sort" class="refentry">
<div class="refnamediv">
<h1 class="refname">SolrDocument::sort</h1>
<p class="verinfo">(PECL solr >= 0.9.2)</p><p class="refpurpose"><span class="refname">SolrDocument::sort</span> — <span class="dc-title">Sorts the fields in the document</span></p>
</div>
<div class="refsect1 description" id="refsect1-solrdocument.sort-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><strong>SolrDocument::sort</strong></span>
( <span class="methodparam"><span class="type">int</span> <code class="parameter">$sortOrderBy</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$sortDirection</code><span class="initializer"> = SolrDocument::SORT_ASC</span></span>
] )</div>
<p class="para rdfs-comment">
<div class="descriptioncode"><pre class="descriptioncode">The fields are rearranged according to the specified criteria and sort direction
Fields can be sorted by boost values, field names and number of values.
The sortOrderBy parameter must be one of :
* SolrDocument::SORT_FIELD_NAME
* SolrDocument::SORT_FIELD_BOOST_VALUE
* SolrDocument::SORT_FIELD_VALUE_COUNT
The sortDirection can be one of :
* SolrDocument::SORT_DEFAULT
* SolrDocument::SORT_ASC
* SolrDocument::SORT_DESC
The default way is to sort in ascending order.</pre>
</div>
</p>
</div>
<div class="refsect1 parameters" id="refsect1-solrdocument.sort-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">sortOrderBy</code></em></span>
<dd>
<p class="para">
The sort criteria.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">sortDirection</code></em></span>
<dd>
<p class="para">
The sort direction.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-solrdocument.sort-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns <strong><code>TRUE</code></strong> on success or <strong><code>FALSE</code></strong> on failure.
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="solrdocument.set.html">SolrDocument::__set</a></div>
<div class="next" style="text-align: right; float: right;"><a href="solrdocument.toarray.html">SolrDocument::toArray</a></div>
<div class="up"><a href="class.solrdocument.html">SolrDocument</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
