DateRangeSearchQuery implements JsonSerializable, SearchQuery
A FTS query that matches documents on a range of values. At least one bound is required, and the inclusiveness of each bound can be configured.
Table of Contents
jsonSerialize() | mixed | |
---|---|---|
__construct() | mixed | |
boost() | DateRangeSearchQuery | |
field() | DateRangeSearchQuery | |
start() | DateRangeSearchQuery | |
end() | DateRangeSearchQuery | |
dateTimeParser() | DateRangeSearchQuery |
Methods
jsonSerialize()
public
jsonSerialize(
)
: mixed
Return values
mixed__construct()
public
__construct(
)
: mixed
Return values
mixedboost()
public
boost(
$boost :
float
)
: DateRangeSearchQuery
Parameters
- $boost : float
Return values
DateRangeSearchQueryfield()
public
field(
$field :
string
)
: DateRangeSearchQuery
Parameters
- $field : string
Return values
DateRangeSearchQuerystart()
public
start(
$start :
int|string
[, $inclusive :
bool
= false ]
)
: DateRangeSearchQuery
Parameters
- $start : int|string
The strings will be taken verbatim and supposed to be formatted with custom date time formatter (see dateTimeParser). Integers interpreted as unix timestamps and represented as RFC3339 strings.
- $inclusive : bool = false
Return values
DateRangeSearchQueryend()
public
end(
$end :
int|string
[, $inclusive :
bool
= false ]
)
: DateRangeSearchQuery
Parameters
- $end : int|string
The strings will be taken verbatim and supposed to be formatted with custom date time formatter (see dateTimeParser). Integers interpreted as unix timestamps and represented as RFC3339 strings.
- $inclusive : bool = false
Return values
DateRangeSearchQuerydateTimeParser()
public
dateTimeParser(
$dateTimeParser :
string
)
: DateRangeSearchQuery
Parameters
- $dateTimeParser : string