\ElasticaTask

Represents elasticsearch task.

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

Summary

Methods

Properties

Constants

toArray()
setParam()
setParams()
addParam()
getParam()
hasParam()
getParams()
count()
__construct()
getId()
getData()
getResponse()
refresh()
isCompleted()
cancel()

No public properties found

WAIT_FOR_COMPLETION
WAIT_FOR_COMPLETION_FALSE
WAIT_FOR_COMPLETION_TRUE

_convertArrayable()
_getBaseName()
_setRawParam()

$_params
$_rawParams
$_id
$_response
$_data
$_client

N/A

No private methods found

No private properties found

N/A

Constants

WAIT_FOR_COMPLETION

WAIT_FOR_COMPLETION

WAIT_FOR_COMPLETION_FALSE

WAIT_FOR_COMPLETION_FALSE

WAIT_FOR_COMPLETION_TRUE

WAIT_FOR_COMPLETION_TRUE

Properties

$_params

$_params : array

Params.

Type

array

$_rawParams

$_rawParams : array

Raw Params.

Type

array

$_id

$_id : string

Task id, e.g. in form of nodeNumber:taskId.

Type

string

$_response

$_response : \Elastica\Response

Contains all status infos.

Type

\Elastica\Response — Response object

$_data

$_data : array

Data.

Type

array — Data

$_client

$_client : \Elastica\Client

Client object.

Type

\Elastica\Client — Client object

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, \Elastica\string  $id)

Parameters

\Elastica\Client	$client
\Elastica\string	$id

getId()

getId() : string

Returns task id.

Returns

string

getData()

getData() : array

Returns task data.

Returns

array —

Task data

getResponse()

getResponse() : \Elastica\Response

Returns response object.

Returns

\Elastica\Response

refresh()

refresh(array  $options = array())

Refresh task status.

Parameters

array

$options

Options for endpoint

isCompleted()

isCompleted() : boolean

Returns

boolean

cancel()

cancel()

_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