\ElasticaPipeline

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(\Elastica\Client  $client) 

Create a new Pipeline Object.

Parameters

create()

create() : \Elastica\Response

Create a Pipeline.

Returns

getPipeline()

getPipeline(string  $id) : \Elastica\Response

Get a Pipeline Object.

Parameters

Returns

deletePipeline()

deletePipeline(string  $id) : \Elastica\Response

Delete a Pipeline.

Parameters

Returns

simulate()

simulate() 

setRawProcessors()

setRawProcessors(array  $processors) : $this

Sets query as raw array. Will overwrite all already set arguments.

Parameters

Returns

addProcessor()

addProcessor(\Elastica\Processor\AbstractProcessor  $processor) : $this

Add a processor.

Parameters

Returns

setId()

setId(string  $id) 

Set pipeline id.

Parameters

setProcessors()

setProcessors(array  $processors) : $this

Sets the processors.

Parameters

Returns

setDescription()

setDescription(string  $description) : $this

Set Description.

Parameters

Returns

getClient()

getClient() : \Elastica\Client

Returns index client.

Returns

Index client object

requestEndpoint()

requestEndpoint(\Elasticsearch\Endpoints\AbstractEndpoint  $endpoint) : \Elastica\Response

Makes calls to the elasticsearch server with usage official client Endpoint based on this index.

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