\Elastica\AggregationGeoDistance

Class GeoDistance.

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

Summary

Methods

Properties

Constants

__construct()
setName()
getName()
getAggs()
addAggregation()
toArray()
setParam()
setParams()
addParam()
getParam()
hasParam()
getParams()
setField()
setOrigin()
addRange()
setUnit()
setDistanceType()

No public properties found

DISTANCE_TYPE_SLOPPY_ARC
DISTANCE_TYPE_ARC
DISTANCE_TYPE_PLANE

_convertArrayable()
_getBaseName()
_setRawParam()

$_name
$_aggs
$_params
$_rawParams

N/A

No private methods found

No private properties found

N/A

Constants

DISTANCE_TYPE_SLOPPY_ARC

DISTANCE_TYPE_SLOPPY_ARC

DISTANCE_TYPE_ARC

DISTANCE_TYPE_ARC

DISTANCE_TYPE_PLANE

DISTANCE_TYPE_PLANE

Properties

$_name

$_name : string

Type

string — The name of this aggregation

$_aggs

$_aggs : array

Type

array — Subaggregations belonging to this aggregation

$_params

$_params : array

Params.

Type

array

$_rawParams

$_rawParams : array

Raw Params.

Type

array

Methods

__construct()

__construct(string  $name, string  $field, string|array  $origin)

Parameters

string	$name	the name if this aggregation
string	$field	the field on which to perform this aggregation
string\|array	$origin	the point from which distances will be calculated

setName()

setName(string  $name) : $this

Set the name of this aggregation.

Parameters

string

$name

Returns

$this

getName()

getName() : string

Retrieve the name of this aggregation.

Returns

string

getAggs()

getAggs() : array

Retrieve all subaggregations belonging to this aggregation.

Returns

array

addAggregation()

addAggregation(\Elastica\Aggregation\AbstractAggregation  $aggregation) : $this

Add a sub-aggregation.

Parameters

\Elastica\Aggregation\AbstractAggregation

$aggregation

Throws

\Elastica\Exception\InvalidException

Returns

$this

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

setField()

setField(string  $field) : $this

Set the field for this aggregation.

Parameters

string

$field

the name of the document field on which to perform this aggregation

Returns

$this

setOrigin()

setOrigin(string|array  $origin) : $this

Set the origin point from which distances will be calculated.

Parameters

string|array

$origin

valid formats are array("lat" => 52.3760, "lon" => 4.894), "52.3760, 4.894", and array(4.894, 52.3760)

Returns

$this

addRange()

addRange(integer  $fromValue = null, integer  $toValue = null) : $this

Add a distance range to this aggregation.

Parameters

integer	$fromValue	a distance
integer	$toValue	a distance

Throws

\Elastica\Exception\InvalidException

Returns

$this

setUnit()

setUnit(string  $unit) : $this

Set the unit of distance measure for this aggregation.

Parameters

string

$unit

defaults to km

Returns

$this

setDistanceType()

setDistanceType(string  $distanceType) : $this

Set the method by which distances will be calculated.

Parameters

string

$distanceType

see DISTANCETYPE* constants for options. Defaults to sloppy_arc.

Returns

$this

_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