GeoBoundingBoxSearchQuery
in package
implements
JsonSerializable, SearchQuery
A FTS query which allows to match geo bounding boxes.
Interfaces, Classes, Traits and Enums
- JsonSerializable
- SearchQuery
- Common interface for all classes, which could be used as a body of SearchQuery
Table of Contents
- $boost : float|null
- $bottomRightLatitude : float
- $bottomRightLongitude : float
- $field : string|null
- $topLeftLatitude : float
- $topLeftLongitude : float
- __construct() : mixed
- boost() : GeoBoundingBoxSearchQuery
- Sets the boost for this query.
- build() : GeoBoundingBoxSearchQuery
- Static helper to keep code more readable
- field() : GeoBoundingBoxSearchQuery
- Sets the field for this query.
Properties
$boost
private
float|null
$boost
= null
$bottomRightLatitude
private
float
$bottomRightLatitude
$bottomRightLongitude
private
float
$bottomRightLongitude
$field
private
string|null
$field
= null
$topLeftLatitude
private
float
$topLeftLatitude
$topLeftLongitude
private
float
$topLeftLongitude
Methods
__construct()
public
__construct(float $topLeftLongitude, float $topLeftLatitude, float $bottomRightLongitude, float $bottomRightLatitude) : mixed
Parameters
- $topLeftLongitude : float
- $topLeftLatitude : float
- $bottomRightLongitude : float
- $bottomRightLatitude : float
Tags
Return values
mixed —boost()
Sets the boost for this query.
public
boost(float $boost) : GeoBoundingBoxSearchQuery
Parameters
- $boost : float
-
the boost value to use.
Tags
Return values
GeoBoundingBoxSearchQuery —build()
Static helper to keep code more readable
public
static build(float $topLeftLongitude, float $topLeftLatitude, float $bottomRightLongitude, float $bottomRightLatitude) : GeoBoundingBoxSearchQuery
Parameters
- $topLeftLongitude : float
- $topLeftLatitude : float
- $bottomRightLongitude : float
- $bottomRightLatitude : float
Tags
Return values
GeoBoundingBoxSearchQuery —field()
Sets the field for this query.
public
field(string $field) : GeoBoundingBoxSearchQuery
Parameters
- $field : string
-
the field to use.