# SolrDocument::sort

(PECL solr >= 0.9.2)

SolrDocument::sort — Sorts the fields in the document

### Description

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

    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.

### Parameters

`sortOrderBy`

  The sort criteria.

`sortDirection`

  The sort direction.

### Return Values

Returns `TRUE` on success or `FALSE` on failure.