\Elastica\QueryGeohashCell

Class GeohashCell.

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

Summary

Methods

Properties

Constants

setKey()
setLocation()
setLatitude()
setLongitude()
setGeohash()
toArray()
setParam()
setParams()
addParam()
getParam()
hasParam()
getParams()
__construct()
setPrecision()
setNeighbors()

No public properties found

LOCATION_TYPE_GEOHASH
LOCATION_TYPE_LATLON

_getLocationData()
_convertArrayable()
_getBaseName()
_setRawParam()

$_locationType
$_key
$_latitude
$_longitude
$_geohash
$_params
$_rawParams

N/A

No private methods found

No private properties found

N/A

Constants

LOCATION_TYPE_GEOHASH

LOCATION_TYPE_GEOHASH

LOCATION_TYPE_LATLON

LOCATION_TYPE_LATLON

Properties

$_locationType

$_locationType : string

Location type.

Decides if this query uses latitude/longitude or geohash for the location. Values are "latlon" or "geohash".

Type

string

$_key

$_key : string

Key.

Type

string

$_latitude

$_latitude : float

Latitude.

Type

float

$_longitude

$_longitude : float

Longitude.

Type

float

$_geohash

$_geohash : string

Geohash.

Type

string

$_params

$_params : array

Params.

Type

array

$_rawParams

$_rawParams : array

Raw Params.

Type

array

Methods

setKey()

setKey(string  $key) : $this

Parameters

string

$key

Returns

$this

setLocation()

setLocation(array|string  $location) : $this

Parameters

array|string

$location

Throws

\Elastica\Exception\InvalidException

Returns

$this

setLatitude()

setLatitude(float  $latitude) : $this

Parameters

float

$latitude

Returns

$this

setLongitude()

setLongitude(float  $longitude) : $this

Parameters

float

$longitude

Returns

$this

setGeohash()

setGeohash(string  $geohash) : $this

Parameters

string

$geohash

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

__construct()

__construct(string  $key, array|string  $location, string|integer  $precision = -1, boolean  $neighbors = false)

Parameters

string	$key	The field on which to query
array\|string	$location	Location as coordinates array or geohash string ['lat' => 40.3, 'lon' => 45.2]
string\|integer	$precision	Integer length of geohash prefix or distance (3, or "50m")
boolean	$neighbors	If true, queries cells next to the given cell.

setPrecision()

setPrecision(string|integer  $precision) : $this

Set the precision for this query.

Parameters

string|integer

$precision

Integer length of geohash prefix or distance (3, or "50m")

Returns

$this

setNeighbors()

setNeighbors(boolean  $neighbors) : $this

Set the neighbors option for this query.

Parameters

boolean

$neighbors

If true, queries cells next to the given cell.

Returns

$this

_getLocationData()

_getLocationData() : array|string

Throws

\Elastica\Exception\InvalidException

Returns

array|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