Documentation

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.

Interfaces, Classes and Traits

JsonSerializable
SearchQuery
Common interface for all classes, which could be used as a body of SearchQuery

Table of Contents

__construct()  : mixed
boost()  : DateRangeSearchQuery
dateTimeParser()  : DateRangeSearchQuery
end()  : DateRangeSearchQuery
field()  : DateRangeSearchQuery
jsonSerialize()  : mixed
start()  : DateRangeSearchQuery

Methods

__construct()

public __construct() : mixed
Return values
mixed

end()

public end(int|string $end[, bool $inclusive = 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
DateRangeSearchQuery

jsonSerialize()

public jsonSerialize() : mixed
Return values
mixed

start()

public start(int|string $start[, bool $inclusive = 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
DateRangeSearchQuery

Search results