1. class
  2. Couchbase
  3. \
  4. SearchSort

SearchSort

class SearchSort (View source)

Base class for all FTS sort options in querying.

Methods

static SearchSortId
id()

Sort by the document identifier.

static SearchSortScore
score()

Sort by the hit score.

static SearchSortField
field(string $field)

Sort by a field in the hits.

static SearchSortGeoDistance
geoDistance(string $field, float $longitude, float $latitude)

Sort by geo location.

Details

at line 3452
static SearchSortId id()

Sort by the document identifier.

Return Value

SearchSortId

at line 3459
static SearchSortScore score()

Sort by the hit score.

Return Value

SearchSortScore

at line 3468
static SearchSortField field(string $field)

Sort by a field in the hits.

Parameters

string $field

the field name

Return Value

SearchSortField

at line 3479
static SearchSortGeoDistance geoDistance(string $field, float $longitude, float $latitude)

Sort by geo location.

Parameters

string $field

the field name
float $longitude

the longitude of the location
float $latitude

the latitude of the location

Return Value

SearchSortGeoDistance