PHP 7.0.6 Released

SolrInputDocument::sort

(PECL solr >= 0.9.2)

SolrInputDocument::sortSorts the fields within the document

Description

public bool SolrInputDocument::sort ( int $sortOrderBy [, int $sortDirection = SolrInputDocument::SORT_ASC ] )

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

Parameters

sortOrderBy

The sort criteria

sortDirection

The sort direction

Return Values

Returns TRUE on success or FALSE on failure.

User Contributed Notes

There are no user contributed notes for this page.
To Top