\ElasticaReindex

Class to handle params.

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

Summary

Methods

Properties

Constants

toArray()
setParam()
setParams()
addParam()
getParam()
hasParam()
getParams()
count()
__construct()
run()
setWaitForCompletion()
setWaitForActiveShards()
setTimeout()
setScroll()
setRequestsPerSecond()
setScript()
getTaskId()

No public properties found

VERSION_TYPE
VERSION_TYPE_INTERNAL
VERSION_TYPE_EXTERNAL
OPERATION_TYPE
OPERATION_TYPE_CREATE
CONFLICTS
CONFLICTS_PROCEED
SIZE
QUERY
SORT
SCRIPT
SOURCE
REMOTE
SLICE
REFRESH
WAIT_FOR_COMPLETION
WAIT_FOR_COMPLETION_FALSE
WAIT_FOR_ACTIVE_SHARDS
TIMEOUT
SCROLL
REQUESTS_PER_SECOND

_convertArrayable()
_getBaseName()
_setRawParam()
_getBody()
_getSourcePartBody()
_getDestPartBody()

$_params
$_rawParams
$_oldIndex
$_newIndex
$_lastResponse

N/A

_resolveSourceOptions()
_resolveDestOptions()
_resolveBodyOptions()
_setSourceQuery()
_setBodyScript()

No private properties found

N/A

File: Reindex.php
Package: Default
Class hierarchy: \Elastica\Param

\Elastica\Reindex

Constants

VERSION_TYPE

VERSION_TYPE

VERSION_TYPE_INTERNAL

VERSION_TYPE_INTERNAL

VERSION_TYPE_EXTERNAL

VERSION_TYPE_EXTERNAL

OPERATION_TYPE

OPERATION_TYPE

OPERATION_TYPE_CREATE

OPERATION_TYPE_CREATE

CONFLICTS

CONFLICTS

CONFLICTS_PROCEED

CONFLICTS_PROCEED

SIZE

SIZE

QUERY

QUERY

SORT

SORT

SCRIPT

SCRIPT

SOURCE

SOURCE

REMOTE

REMOTE

SLICE

SLICE

REFRESH

REFRESH

WAIT_FOR_COMPLETION

WAIT_FOR_COMPLETION

WAIT_FOR_COMPLETION_FALSE

WAIT_FOR_COMPLETION_FALSE

WAIT_FOR_ACTIVE_SHARDS

WAIT_FOR_ACTIVE_SHARDS

TIMEOUT

TIMEOUT

SCROLL

SCROLL

REQUESTS_PER_SECOND

REQUESTS_PER_SECOND

Properties

$_params

$_params : array

Params.

Type

array

$_rawParams

$_rawParams : array

Raw Params.

Type

array

$_oldIndex

$_oldIndex : \Elastica\Index

Type

\Elastica\Index

$_newIndex

$_newIndex : \Elastica\Index

Type

\Elastica\Index

$_lastResponse

$_lastResponse : \Elastica\Response|null

Type

\Elastica\Response|null

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\Index  $oldIndex, \Elastica\Index  $newIndex, array  $params = array())

Parameters

\Elastica\Index	$oldIndex
\Elastica\Index	$newIndex
array	$params

run()

run()

setWaitForCompletion()

setWaitForCompletion(  $value)

Parameters

$value

setWaitForActiveShards()

setWaitForActiveShards(  $value)

Parameters

$value

setTimeout()

setTimeout(  $value)

Parameters

$value

setScroll()

setScroll(  $value)

Parameters

$value

setRequestsPerSecond()

setRequestsPerSecond(  $value)

Parameters

$value

setScript()

setScript(\Elastica\Script\Script  $script)

Parameters

\Elastica\Script\Script

$script

getTaskId()

getTaskId()

_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

_getBody()

_getBody(\Elastica\Index  $oldIndex, \Elastica\Index  $newIndex, array  $params)

Parameters

\Elastica\Index	$oldIndex
\Elastica\Index	$newIndex
array	$params

_getSourcePartBody()

_getSourcePartBody(\Elastica\Index  $index, array  $params)

Parameters

\Elastica\Index	$index
array	$params

_getDestPartBody()

_getDestPartBody(\Elastica\Index  $index, array  $params)

Parameters

\Elastica\Index	$index
array	$params

_resolveSourceOptions()

_resolveSourceOptions(array  $params)

Parameters

array

$params

_resolveDestOptions()

_resolveDestOptions(array  $params)

Parameters

array

$params

_resolveBodyOptions()

_resolveBodyOptions(array  $params)

Parameters

array

$params

_setSourceQuery()

_setSourceQuery(array  $sourceBody)

Parameters

array

$sourceBody

_setBodyScript()

_setBodyScript(array  $body)

Parameters

array

$body