class DateRangeSearchQuery implements JsonSerializable, SearchQueryPart (View source)

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.

Methods

mixed
jsonSerialize()

No description

boost(float $boost)

No description

field(string $field)

No description

start(int|string $start, bool $inclusive = true)

No description

end(int|string $end, bool $inclusive = false)

No description

dateTimeParser(string $dateTimeParser)

No description

Details

mixed jsonSerialize()

No description

Return Value

mixed

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

DateRangeSearchQuery boost(float $boost)

No description

Parameters

float $boost

Return Value

DateRangeSearchQuery

DateRangeSearchQuery field(string $field)

No description

Parameters

string $field

Return Value

DateRangeSearchQuery

DateRangeSearchQuery start(int|string $start, bool $inclusive = true)

No description

Parameters

int|string $start

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.

bool $inclusive

Return Value

DateRangeSearchQuery

DateRangeSearchQuery end(int|string $end, bool $inclusive = false)

No description

Parameters

int|string $end

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.

bool $inclusive

Return Value

DateRangeSearchQuery

DateRangeSearchQuery dateTimeParser(string $dateTimeParser)

No description

Parameters

string $dateTimeParser

Return Value

DateRangeSearchQuery