include/SugarSearchEngine/Elastic/Elastica/Query/FuzzyLikeThis.php
Fuzzy Like This query
- Author
- Raul Martinez, Jr
- Category
- Xodoa
- Link
- http://www.elasticsearch.org/guide/reference/query-dsl/flt-query.html
- Package
- Elastica
- Uses
- \Elastica_Query_Abstract
\Elastica_Query_FuzzyLikeThis
Package: Elastica
Parameters
Returns
Fuzzy Like This query
This function can be used to handle params for queries, filter, facets
- Parent(s)
- \Elastica_Query_Abstract < \Elastica_Param
- Author
- Raul Martinez, Jr
- Category
- Xodoa
- Link
- http://www.elasticsearch.org/guide/reference/query-dsl/flt-query.html
- Uses
- \Elastica_Query_Abstract
Properties
array
$_params= 'array()'
Default value
array()
Details- Type
- array
- Inherited_from
- \Elastica_Param::$$_params
- Inherited_from
- \Elastica_Query_Abstract::$$_params
$_rawParams= 'array()'
Default value
array()
Details- Type
- n/a
- Inherited_from
- \Elastica_Param::$$_rawParams
- Inherited_from
- \Elastica_Query_Abstract::$$_rawParams
Methods
_setRawParam(
string $key, mixed $value
)
:
\Elastica_Param
inherited
Sets params not inside params array
Inherited from: \Elastica_Param::_setRawParam()\Elastica_Query_Abstract::_setRawParam()
Parameters
Returns
Name | Type | Description |
---|---|---|
$key | string | |
$value | mixed |
Type | Description |
---|---|
\Elastica_Param |
addFields(
array $fields
)
:
\Elastica_Query_FuzzyLikeThis
Adds field to flt query
Parameters
Returns
Name | Type | Description |
---|---|---|
$fields | array | Field names |
Type | Description |
---|---|
\Elastica_Query_FuzzyLikeThis | Current object |
addParam(
string $key, mixed $value
)
:
\Elastica_Param
inherited
Adds a param to the list
Inherited from: \Elastica_Param::addParam()\Elastica_Query_Abstract::addParam()This function can be used to add an array of params
Name | Type | Description |
---|---|---|
$key | string | Param key |
$value | mixed | Value to set |
Type | Description |
---|---|
\Elastica_Param |
getParam(
string $key
)
:
mixed
inherited
Returns a specific param
Inherited from: \Elastica_Param::getParam()\Elastica_Query_Abstract::getParam()
Parameters
Returns
Throws
Name | Type | Description |
---|---|---|
$key | string | Key to return |
Type | Description |
---|---|
mixed | Key value |
Exception | Description |
---|---|
\Elastica_Exception_Invalid | If requested key is not set |
getParams(
)
:
array
inherited
Returns the params array
Inherited from: \Elastica_Param::getParams()\Elastica_Query_Abstract::getParams()
Returns
Type | Description |
---|---|
array | Params |
setBoost(
float $value
)
:
\Elastica_Query_FuzzyLikeThis
Parameters
Returns
Name | Type | Description |
---|---|---|
$value | float | Boost value |
Type | Description |
---|---|
\Elastica_Query_FuzzyLikeThis | Query object |
setLikeText(
string $text
)
:
\Elastica_Query_FuzzyLikeThis
Set the "like_text" value
Parameters
Returns
Name | Type | Description |
---|---|---|
$text | string |
Type | Description |
---|---|
\Elastica_Query_FuzzyLikeThis | This current object |
setMaxQueryTerms(
int $value
)
:
\Elastica_Query_FuzzyLikeThis
Set max_query_terms
Parameters
Returns
Name | Type | Description |
---|---|---|
$value | int | Max query terms value |
Type | Description |
---|---|
\Elastica_Query_FuzzyLikeThis |
setMinSimilarity(
int $value
)
:
\Elastica_Query_FuzzyLikeThis
Set the minimum similarity
Parameters
Returns
Name | Type | Description |
---|---|---|
$value | int |
Type | Description |
---|---|
\Elastica_Query_FuzzyLikeThis | This current object |
setParam(
string $key, mixed $value
)
:
void
inherited
Sets (overwrites) the value at the given key
Inherited from: \Elastica_Param::setParam()\Elastica_Query_Abstract::setParam()
Parameters
Name | Type | Description |
---|---|---|
$key | string | Key to set |
$value | mixed | Key Value |
setParams(
array $params
)
:
\Elastica_Param
inherited
Sets (overwrites) all params of this object
Inherited from: \Elastica_Param::setParams()\Elastica_Query_Abstract::setParams()
Parameters
Returns
Name | Type | Description |
---|---|---|
$params | array | Parameter list |
Type | Description |
---|---|
\Elastica_Param |
setPrefixLength(
int $value
)
:
\Elastica_Query_FuzzyLikeThis
Set Prefix Length
Parameters
Returns
Name | Type | Description |
---|---|---|
$value | int | Prefix length |
Type | Description |
---|---|
\Elastica_Query_FuzzyLikeThis |