SearchSortField
in package
implements
JsonSerializable, SearchSort
Sort by a field in the hits.
Interfaces, Classes and Traits
- JsonSerializable
- SearchSort
- Base interface for all FTS sort options in querying.
Table of Contents
- __construct() : mixed
- descending() : SearchSortField
- Direction of the sort
- jsonSerialize() : mixed
- missing() : SearchSortField
- Set where the hits with missing field will be inserted
- mode() : SearchSortField
- Set mode of the sort
- type() : SearchSortField
- Set type of the field
Methods
__construct()
public
__construct(string $field) : mixed
Parameters
- $field : string
Return values
mixed —descending()
Direction of the sort
public
descending(bool $descending) : SearchSortField
Parameters
- $descending : bool
Return values
SearchSortField —jsonSerialize()
public
jsonSerialize() : mixed
Return values
mixed —missing()
Set where the hits with missing field will be inserted
public
missing(string $missing) : SearchSortField
Parameters
- $missing : string
Tags
Return values
SearchSortField —mode()
Set mode of the sort
public
mode(string $mode) : SearchSortField
Parameters
- $mode : string
Tags
Return values
SearchSortField —type()
Set type of the field
public
type(string $type) : SearchSortField
Parameters
- $type : string