GeoPolygonQuery
in package
implements
JsonSerializable, SearchQuery
A FTS query that finds all matches within the given polygon area.
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
- $coordinates : array<string|int, mixed>
- $field : string|null
- __construct() : mixed
- boost() : GeoPolygonQuery
- Sets the boost for this query.
- field() : GeoPolygonQuery
- Sets the field for this query.
Properties
$boost
private
float|null
$boost
= null
$coordinates
private
array<string|int, mixed>
$coordinates
$field
private
string|null
$field
= null
Methods
__construct()
public
__construct(array<string|int, mixed> $coordinates) : mixed
Parameters
- $coordinates : array<string|int, mixed>
-
list of objects of type Coordinate
Tags
Return values
mixed —boost()
Sets the boost for this query.
public
boost(float $boost) : GeoPolygonQuery
Parameters
- $boost : float
-
the boost value to use.
Tags
Return values
GeoPolygonQuery —field()
Sets the field for this query.
public
field(string $field) : GeoPolygonQuery
Parameters
- $field : string
-
the field to use.