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

SearchSortGeoDistance

class SearchSortGeoDistance extends SearchSort implements JsonSerializable (View source)

Sort by a location and unit in the hits.

Methods

static SearchSortId
id()

Sort by the document identifier.

from  SearchSort
static SearchSortScore
score()

Sort by the hit score.

from  SearchSort
static SearchSortField
field(string $field)

Sort by a field in the hits.

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

Sort by geo location.

from  SearchSort
SearchSortGeoDistance
descending(bool $descending)

Direction of the sort

SearchSortGeoDistance
unit(string $unit)

Name of the units

Details

in SearchSort at line 3452
static SearchSortId id()

Sort by the document identifier.

Return Value

SearchSortId

in SearchSort at line 3459
static SearchSortScore score()

Sort by the hit score.

Return Value

SearchSortScore

in SearchSort at line 3468
static SearchSortField field(string $field)

Sort by a field in the hits.

Parameters

string $field

the field name

Return Value

SearchSortField

in SearchSort 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

at line 3589
SearchSortGeoDistance descending(bool $descending)

Direction of the sort

Parameters

bool $descending

Return Value

SearchSortGeoDistance

at line 3598
SearchSortGeoDistance unit(string $unit)

Name of the units

Parameters

string $unit

Return Value

SearchSortGeoDistance