Elastica
\
Elastica
Aggregation
Bulk
Action
Cluster
Health
Connection
Strategy
Exception
Bulk
Response
Connection
Filter
Index
Multi
Node
Query
QueryBuilder
DSL
Version
Rescore
ResultSet
Script
Suggest
CandidateGenerator
Tool
Transport
Type

\Elastica\FilterGeoShapeProvided

geo_shape filter or provided shapes.

Filter provided shape definitions

Summary

Methods
Properties
Constants
setRelation()
getRelation()
setCached()
setCacheKey()
setName()
toArray()
setParam()
setParams()
addParam()
getParam()
hasParam()
getParams()
__construct()
No public properties found
RELATION_INTERSECT
RELATION_DISJOINT
RELATION_CONTAINS
TYPE_ENVELOPE
TYPE_MULTIPOINT
TYPE_POINT
TYPE_MULTIPOLYGON
TYPE_LINESTRING
TYPE_POLYGON
_convertArrayable()
_getBaseName()
_setRawParam()
$_path
$_relation
$_params
$_rawParams
$_shapeType
$_coordinates
N/A
No private methods found
No private properties found
N/A

Constants

RELATION_INTERSECT

RELATION_INTERSECT

RELATION_DISJOINT

RELATION_DISJOINT

RELATION_CONTAINS

RELATION_CONTAINS

TYPE_ENVELOPE

TYPE_ENVELOPE

TYPE_MULTIPOINT

TYPE_MULTIPOINT

TYPE_POINT

TYPE_POINT

TYPE_MULTIPOLYGON

TYPE_MULTIPOLYGON

TYPE_LINESTRING

TYPE_LINESTRING

TYPE_POLYGON

TYPE_POLYGON

Properties

$_path

$_path : string

Type

string — elasticsearch path of the pre-indexed shape

$_relation

$_relation : string

Type

string — the relation of the 2 shaped: intersects, disjoint, within

$_params

$_params : array

Params.

Type

array

$_rawParams

$_rawParams : array

Raw Params.

Type

array

$_shapeType

$_shapeType : string

Type of the geo_shape.

Type

string

$_coordinates

$_coordinates : array

Coordinates making up geo_shape.

Type

array — Coordinates making up geo_shape

Methods

setRelation()

setRelation(string  $relation) : $this

Parameters

string $relation

Returns

$this

getRelation()

getRelation() : string

Returns

string

setCached()

setCached(boolean  $cached = true) : $this

Sets the filter cache.

Parameters

boolean $cached

Cached

Returns

$this

setCacheKey()

setCacheKey(string  $cacheKey) : $this

Sets the filter cache key.

Parameters

string $cacheKey

Cache key

Throws

\Elastica\Exception\InvalidException

If given key is empty

Returns

$this

setName()

setName(string  $name) : $this

Sets the filter name.

Parameters

string $name

Name

Returns

$this

toArray()

toArray() : array

Converts filter to array.

Returns

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

__construct()

__construct(string  $path, array  $coordinates, string  $shapeType = self::TYPE_ENVELOPE)

Construct geo_shape filter.

Parameters

string $path

The path/field of the shape searched
array $coordinates

Points making up the shape
string $shapeType

Type of the geo_shape: point, envelope, linestring, polygon, multipoint or multipolygon

_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