\Elastica\QueryPercolate

Class Percolate.

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

Summary

Methods
Properties
Constants
toArray()
setParam()
setParams()
addParam()
getParam()
hasParam()
getParams()
setField()
setDocument()
setDocumentType()
setDocumentIndex()
setExistingDocumentType()
setDocumentId()
setDocumentRouting()
setDocumentPreference()
setDocumentVersion()
No public properties found
No constants found
_convertArrayable()
_getBaseName()
_setRawParam()
$_params
$_rawParams
N/A
No private methods found
No private properties found
N/A

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

setField()

setField(  $field) : $this

The field of type percolator and that holds the indexed queries. This is a required parameter.

Parameters

$field

Returns

$this

setDocument()

setDocument(  $document) : $this

The source of the document being percolated.

Parameters

$document

Returns

$this

setDocumentType()

setDocumentType(  $documentType) : $this

The type / mapping of the document being percolated. This is a required parameter.

Parameters

$documentType

Returns

$this

setDocumentIndex()

setDocumentIndex(  $index) : $this

The index the document resides in.

Parameters

$index

Returns

$this

setExistingDocumentType()

setExistingDocumentType(  $type) : $this

The type of the document to fetch.

Parameters

$type

Returns

$this

setDocumentId()

setDocumentId(  $id) : $this

The id of the document to fetch.

Parameters

$id

Returns

$this

setDocumentRouting()

setDocumentRouting(  $routing) : $this

Optionally, routing to be used to fetch document to percolate.

Parameters

$routing

Returns

$this

setDocumentPreference()

setDocumentPreference(  $preference) : $this

Optionally, preference to be used to fetch document to percolate.

Parameters

$preference

Returns

$this

setDocumentVersion()

setDocumentVersion(  $version) : $this

Optionally, the expected version of the document to be fetched.

Parameters

$version

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