Elastica
\
Elastica
Aggregation
Bulk
Action
Cluster
Health
Connection
Strategy
Exception
Bulk
Response
Connection
Filter
Index
Multi
Node
Query
QueryBuilder
DSL
Version
Rescore
ResultSet
Script
Suggest
CandidateGenerator
Tool
Transport
Type

\Elastica\QueryMatchPhrasePrefix

Match Phrase Prefix query.

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

Summary

Methods
Properties
Constants
__construct()
setField()
setFieldParam()
setFieldQuery()
setFieldType()
setFieldOperator()
setFieldAnalyzer()
setFieldBoost()
setFieldMinimumShouldMatch()
setFieldFuzziness()
setFieldFuzzyRewrite()
setFieldPrefixLength()
setFieldMaxExpansions()
setFieldZeroTermsQuery()
setFieldCutoffFrequency()
toArray()
setParam()
setParams()
addParam()
getParam()
hasParam()
getParams()
No public properties found
ZERO_TERM_NONE
ZERO_TERM_ALL
_convertArrayable()
_getBaseName()
_setRawParam()
$_params
$_rawParams
N/A
No private methods found
No private properties found
N/A

Constants

ZERO_TERM_NONE

ZERO_TERM_NONE

ZERO_TERM_ALL

ZERO_TERM_ALL

Properties

$_params

$_params : array

Params.

Type

array

$_rawParams

$_rawParams : array

Raw Params.

Type

array

Methods

__construct()

__construct(string  $field = null, mixed  $values = null)

Parameters

string $field
mixed $values

setField()

setField(string  $field, mixed  $values) : $this

Sets a param for the message array.

Parameters

string $field
mixed $values

Returns

$this

setFieldParam()

setFieldParam(string  $field, string  $key, string  $value) : $this

Sets a param for the given field.

Parameters

string $field
string $key
string $value

Returns

$this

setFieldQuery()

setFieldQuery(string  $field, string  $query) : $this

Sets the query string.

Parameters

string $field
string $query

Returns

$this

setFieldType()

setFieldType(string  $field, string  $type) : $this

Set field type.

Parameters

string $field
string $type

Returns

$this

setFieldOperator()

setFieldOperator(string  $field, string  $operator) : $this

Set field operator.

Parameters

string $field
string $operator

Returns

$this

setFieldAnalyzer()

setFieldAnalyzer(string  $field, string  $analyzer) : $this

Set field analyzer.

Parameters

string $field
string $analyzer

Returns

$this

setFieldBoost()

setFieldBoost(string  $field, float  $boost = 1.0) : $this

Set field boost value.

If not set, defaults to 1.0.

Parameters

string $field
float $boost

Returns

$this

setFieldMinimumShouldMatch()

setFieldMinimumShouldMatch(string  $field, integer|string  $minimumShouldMatch) : $this

Set field minimum should match.

Parameters

string $field
integer|string $minimumShouldMatch

Returns

$this

setFieldFuzziness()

setFieldFuzziness(string  $field, mixed  $fuzziness) : $this

Set field fuzziness.

Parameters

string $field
mixed $fuzziness

Returns

$this

setFieldFuzzyRewrite()

setFieldFuzzyRewrite(string  $field, string  $fuzzyRewrite) : $this

Set field fuzzy rewrite.

Parameters

string $field
string $fuzzyRewrite

Returns

$this

setFieldPrefixLength()

setFieldPrefixLength(string  $field, integer  $prefixLength) : $this

Set field prefix length.

Parameters

string $field
integer $prefixLength

Returns

$this

setFieldMaxExpansions()

setFieldMaxExpansions(string  $field, integer  $maxExpansions) : $this

Set field max expansions.

Parameters

string $field
integer $maxExpansions

Returns

$this

setFieldZeroTermsQuery()

setFieldZeroTermsQuery(string  $field, string  $zeroTermQuery = 'none') : $this

Set zero terms query.

If not set, default to 'none'

Parameters

string $field
string $zeroTermQuery

Returns

$this

setFieldCutoffFrequency()

setFieldCutoffFrequency(string  $field, float  $cutoffFrequency) : $this

Set cutoff frequency.

Parameters

string $field
float $cutoffFrequency

Returns

$this

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

_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