Properties

$_params

$_params : array

Params.

Type

array

$_rawParams

$_rawParams : array

Raw Params.

Type

array

$id

$id : string

Type

string — name of the pipeline

$_client

$_client : \Elastica\Client

Client Object.

Type

\Elastica\Client — Client object

$_processors

$_processors : array

Processors array.

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

count()

count() : integer

{@inheritdoc}

Returns

integer

__construct()

__construct(\Elastica\Client  $client) 

Create a new Pipeline Object.

Parameters

\Elastica\Client $client

getPipeline()

getPipeline(string  $id) : \Elastica\Response

Get a Pipeline Object.

Parameters

string $id

Pipeline name

Returns

\Elastica\Response

deletePipeline()

deletePipeline(string  $id) : \Elastica\Response

Delete a Pipeline.

Parameters

string $id

Pipeline name

Returns

\Elastica\Response

simulate()

simulate() 

setRawProcessors()

setRawProcessors(array  $processors) : $this

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

Parameters

array $processors

array

Returns

$this

setId()

setId(string  $id) 

Set pipeline id.

Parameters

string $id

setProcessors()

setProcessors(array  $processors) : $this

Sets the processors.

Parameters

array $processors

array of AbstractProcessor object

Returns

$this

setDescription()

setDescription(string  $description) : $this

Set Description.

Parameters

string $description

Returns

$this

getClient()

getClient() : \Elastica\Client

Returns index client.

Returns

\Elastica\Client

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

\Elasticsearch\Endpoints\AbstractEndpoint $endpoint

Returns

\Elastica\Response

_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