\Elastica\QueryAbstractGeoShape

geo_shape query.

This function can be used to handle params for queries, filter

Summary

Methods
Properties
Constants
toArray()
setParam()
setParams()
addParam()
getParam()
hasParam()
getParams()
setRelation()
getRelation()
No public properties found
RELATION_INTERSECT
RELATION_DISJOINT
RELATION_WITHIN
RELATION_CONTAINS
_convertArrayable()
_getBaseName()
_setRawParam()
$_params
$_rawParams
$_path
$_relation
N/A
No private methods found
No private properties found
N/A

Constants

RELATION_INTERSECT

RELATION_INTERSECT

Return all documents whose geo_shape field intersects the query geometry. (default behavior)

RELATION_DISJOINT

RELATION_DISJOINT

Return all documents whose geo_shape field has nothing in common with the query geometry.

RELATION_WITHIN

RELATION_WITHIN

Return all documents whose geo_shape field is within the query geometry.

RELATION_CONTAINS

RELATION_CONTAINS

Return all documents whose geo_shape field contains the query geometry.

Properties

$_params

$_params : array

Params.

Type

array

$_rawParams

$_rawParams : array

Raw Params.

Type

array

$_path

$_path : string

Elasticsearch path of the geo_shape field.

Type

string

$_relation

$_relation : string

Type

string

Methods

toArray()

toArray() : array

Converts the params to an array. A default implementation exist to create the an array out of the class name (last part of the class name) and the params.

Returns

array —

Filter array

setParam()

setParam(string  $key, mixed  $value) : $this

Sets (overwrites) the value at the given key.

Parameters

string $key

Key to set

mixed $value

Key Value

Returns

$this

setParams()

setParams(array  $params) : $this

Sets (overwrites) all params of this object.

Parameters

array $params

Parameter list

Returns

$this

addParam()

addParam(string  $key, mixed  $value) : $this

Adds a param to the list.

This function can be used to add an array of params

Parameters

string $key

Param key

mixed $value

Value to set

Returns

$this

getParam()

getParam(string  $key) : mixed

Returns a specific param.

Parameters

string $key

Key to return

Throws

\Elastica\Exception\InvalidException

If requested key is not set

Returns

mixed —

Key value

hasParam()

hasParam(string  $key) : boolean

Test if a param is set.

Parameters

string $key

Key to test

Returns

boolean —

True if the param is set, false otherwise

getParams()

getParams() : array

Returns the params array.

Returns

array —

Params

setRelation()

setRelation(string  $relation) : $this

Sets the relation of the geo_shape field and the query geometry.

Possible values: intersects, disjoint, within, contains (see constants).

Parameters

string $relation

Returns

$this

getRelation()

getRelation() : string

Gets the relation of the geo_shape field and the query geometry.

Returns

string

_convertArrayable()

_convertArrayable(array  $array) : array

Cast objects to arrays.

Parameters

array $array

Returns

array

_getBaseName()

_getBaseName() : string

Param's name Picks the last part of the class name and makes it snake_case You can override this method if you want to change the name.

Returns

string —

name

_setRawParam()

_setRawParam(string  $key, mixed  $value) : $this

Sets params not inside params array.

Parameters

string $key
mixed $value

Returns

$this