\Elastica\QueryImage

Image query.

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

Summary

Methods

Properties

Constants

toArray()
setParam()
setParams()
addParam()
getParam()
hasParam()
getParams()
__construct()
setFieldParam()
setFieldBoost()
setFieldFeature()
setFieldHash()
setFieldImage()
setFieldIndex()
setFieldType()
setFieldId()
setFieldPath()
setImageByReference()

No public properties found

No constants found

_convertArrayable()
_getBaseName()
_setRawParam()

$_params
$_rawParams

N/A

No private methods found

No private properties found

N/A

File: Query/Image.php
Package: Default
Class hierarchy: \Elastica\Param

\Elastica\Query\AbstractQuery

\Elastica\Query\Image
See also: To use this feature you have to call the following command in the elasticsearch directory: <code> ./bin/plugin --url https://github.com/Jmoati/elasticsearch-image/releases/download/1.7.1/elasticsearch-image-1.7.1.zip --install image </code> This installs the image plugin. More infos can be found here: {@link https://github.com/Jmoati/elasticsearch-image}

Properties

$_params

$_params : array

Params.

Type

array

$_rawParams

$_rawParams : array

Raw Params.

Type

array

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

__construct()

__construct(array  $image = array())

Parameters

array

$image

setFieldParam()

setFieldParam(string  $field, string  $key, string  $value) : $this

Sets a param for the given field.

Parameters

string	$field
string	$key
string	$value

Returns

$this

setFieldBoost()

setFieldBoost(string  $field, float  $boost = 1.0) : $this

Set field boost value.

If not set, defaults to 1.0.

Parameters

string	$field
float	$boost

Returns

$this

setFieldFeature()

setFieldFeature(string  $field, string  $feature = 'CEDD') : $this

Set field feature value.

If not set, defaults CEDD.

Parameters

string	$field
string	$feature

Returns

$this

setFieldHash()

setFieldHash(string  $field, string  $hash = 'BIT_SAMPLING') : $this

Set field hash value.

If not set, defaults BIT_SAMPLING.

Parameters

string	$field
string	$hash

Returns

$this

setFieldImage()

setFieldImage(string  $field, string  $path) : $this

Set field image value.

Parameters

string	$field
string	$path	File will be base64_encode

Throws

\Exception

Returns

$this

setFieldIndex()

setFieldIndex(string  $field, string  $index) : $this

Set field index value.

Parameters

string	$field
string	$index

Returns

$this

setFieldType()

setFieldType(string  $field, string  $type) : $this

Set field type value.

Parameters

string	$field
string	$type

Returns

$this

setFieldId()

setFieldId(string  $field, string  $id) : $this

Set field id value.

Parameters

string	$field
string	$id

Returns

$this

setFieldPath()

setFieldPath(string  $field, string  $path) : $this

Set field path value.

Parameters

string	$field
string	$path

Returns

$this

setImageByReference()

setImageByReference(string  $field, string  $index, string  $type, string  $id, string  $path = null) : $this

Define quickly a reference image already in your elasticsearch database.

If not set, path will be the same as $field.

Parameters

string	$field
string	$index
string	$type
string	$id
string	$path

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