<!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 within the document</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="solrinputdocument.setfieldboost.html">SolrInputDocument::setFieldBoost</a></div>
<div class="next" style="text-align: right; float: right;"><a href="solrinputdocument.toarray.html">SolrInputDocument::toArray</a></div>
<div class="up"><a href="class.solrinputdocument.html">SolrInputDocument</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="solrinputdocument.sort" class="refentry">
<div class="refnamediv">
<h1 class="refname">SolrInputDocument::sort</h1>
<p class="verinfo">(PECL solr >= 0.9.2)</p><p class="refpurpose"><span class="refname">SolrInputDocument::sort</span> — <span class="dc-title">Sorts the fields within the document</span></p>
</div>
<div class="refsect1 description" id="refsect1-solrinputdocument.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>SolrInputDocument::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"> = SolrInputDocument::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 $order_by parameter must be one of :
* SolrInputDocument::SORT_FIELD_NAME
* SolrInputDocument::SORT_FIELD_BOOST_VALUE
* SolrInputDocument::SORT_FIELD_VALUE_COUNT
The sort direction can be one of :
* SolrInputDocument::SORT_DEFAULT
* SolrInputDocument::SORT_ASC
* SolrInputDocument::SORT_DESC</pre>
</div>
</p>
</div>
<div class="refsect1 parameters" id="refsect1-solrinputdocument.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-solrinputdocument.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="solrinputdocument.setfieldboost.html">SolrInputDocument::setFieldBoost</a></div>
<div class="next" style="text-align: right; float: right;"><a href="solrinputdocument.toarray.html">SolrInputDocument::toArray</a></div>
<div class="up"><a href="class.solrinputdocument.html">SolrInputDocument</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
