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

SearchSortField

class SearchSortField implements JsonSerializable, SearchSort (View source)

Sort by a field in the hits.

Methods

mixed
jsonSerialize()

Specify data which should be serialized to JSON

__construct(string $field)

No description

SearchSortField
descending(bool $descending)

Direction of the sort

SearchSortField
type(string $type)

Set type of the field

SearchSortField
mode(string $mode)

Set mode of the sort

SearchSortField
missing(string $missing)

Set where the hits with missing field will be inserted

Details

at line 3033
mixed jsonSerialize()

Specify data which should be serialized to JSON

Return Value

mixed

data which can be serialized by json_encode, which is a value of any type other than a resource.

at line 3035
__construct(string $field)

No description

Parameters

string $field

at line 3044
SearchSortField descending(bool $descending)

Direction of the sort

Parameters

bool $descending

Return Value

SearchSortField

at line 3056
SearchSortField type(string $type)

Set type of the field

Parameters

string $type

Return Value

SearchSortField

See also

SearchSortType::AUTO
SearchSortType::STRING
SearchSortType::NUMBER
SearchSortType::DATE

at line 3066
SearchSortField mode(string $mode)

Set mode of the sort

Parameters

string $mode

Return Value

SearchSortField

See also

SearchSortMode::MIN
SearchSortMode::MAX

at line 3076
SearchSortField missing(string $missing)

Set where the hits with missing field will be inserted

Parameters

string $missing

Return Value

SearchSortField

See also

SearchSortMissing::FIRST
SearchSortMissing::LAST