\Elastica\ProcessorKv

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

Filter array

setParam()

setParam(string  $key, mixed  $value) : $this

Sets (overwrites) the value at the given key.

Parameters

Returns

setParams()

setParams(array  $params) : $this

Sets (overwrites) all params of this object.

Parameters

Returns

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

Returns

getParam()

getParam(string  $key) : mixed

Returns a specific param.

Parameters

Throws

\Elastica\Exception\InvalidException

If requested key is not set

Returns

Key value

hasParam()

hasParam(string  $key) : boolean

Test if a param is set.

Parameters

Returns

True if the param is set, false otherwise

getParams()

getParams() : array

Returns the params array.

Returns

Params

count()

count() : integer

{@inheritdoc}

Returns

__construct()

__construct(string  $field, string  $fieldSplit, string  $valueSplit) 

Kv constructor.

Parameters

setField()

setField(string  $field) : $this

Set field name.

Parameters

Returns

setFieldSplit()

setFieldSplit(string  $fieldSplit) : $this

Set field_split.

Parameters

Returns

setValueSplit()

setValueSplit(string  $valueSplit) : $this

Set value_split.

Parameters

Returns

setTargetField()

setTargetField(string  $targetField) : $this

Set target_field. Default value null.

Parameters

Returns

setIncludeKeys()

setIncludeKeys(array  $listOfKeys) : $this

Set include_keys.

Parameters

Returns

setExcludeKeys()

setExcludeKeys(array  $listOfKeys) : $this

Set exclude_keys.

Parameters

Returns

setIgnoreMissing()

setIgnoreMissing(boolean  $ignoreMissing) : $this

Set ignore_missing. Default value false.

Parameters

Returns

_convertArrayable()

_convertArrayable(array  $array) : array

Cast objects to arrays.

Parameters

Returns

_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

name

_setRawParam()

_setRawParam(string  $key, mixed  $value) : $this

Sets params not inside params array.

Parameters

Returns