include/SugarSearchEngine/Elastic/Elastica/Query/FuzzyLikeThis.php

Show: inherited
Table of Contents

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

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

Propertyprotected  $_boost= '1.0'
Default value1.0Details
Type
n/a
Propertyprotected  $_fields= 'array()'
Default valuearray()Details
Type
n/a
Propertyprotected  $_likeText= 'null'
Default valuenullDetails
Type
n/a
Propertyprotected  $_maxQueryTerms= '25'
Default value25Details
Type
n/a
Propertyprotected  $_minSimilarity= '0.5'
Default value0.5Details
Type
n/a
Propertyprotectedarray  $_params= 'array()'
Default valuearray()Details
Type
array
Inherited_from
\Elastica_Param::$$_params  
Inherited_from
\Elastica_Query_Abstract::$$_params  
Propertyprotected  $_prefixLength= '0'
Default value0Details
Type
n/a
Propertyprotected  $_rawParams= 'array()'
Default valuearray()Details
Type
n/a
Inherited_from
\Elastica_Param::$$_rawParams  
Inherited_from
\Elastica_Query_Abstract::$$_rawParams  

Methods

methodprotected_setRawParam( string $key, mixed $value ) : \Elastica_Param
inherited

Sets params not inside params array

Inherited from: \Elastica_Param::_setRawParam()\Elastica_Query_Abstract::_setRawParam()
Parameters
Name Type Description
$key string
$value mixed
Returns
Type Description
\Elastica_Param
methodpublicaddFields( array $fields ) : \Elastica_Query_FuzzyLikeThis

Adds field to flt query

Parameters
Name Type Description
$fields array

Field names

Returns
Type Description
\Elastica_Query_FuzzyLikeThis Current object
methodpublicaddParam( 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

Parameters
Name Type Description
$key string

Param key

$value mixed

Value to set

Returns
Type Description
\Elastica_Param
methodpublicgetParam( string $key ) : mixed
inherited

Returns a specific param

Inherited from: \Elastica_Param::getParam()\Elastica_Query_Abstract::getParam()
Parameters
Name Type Description
$key string

Key to return

Returns
Type Description
mixed Key value
Throws
Exception Description
\Elastica_Exception_Invalid If requested key is not set
methodpublicgetParams( ) : array
inherited

Returns the params array

Inherited from: \Elastica_Param::getParams()\Elastica_Query_Abstract::getParams()
Returns
Type Description
array Params
methodpublicsetBoost( float $value ) : \Elastica_Query_FuzzyLikeThis

Parameters
Name Type Description
$value float

Boost value

Returns
Type Description
\Elastica_Query_FuzzyLikeThis Query object
methodpublicsetLikeText( string $text ) : \Elastica_Query_FuzzyLikeThis

Set the "like_text" value

Parameters
Name Type Description
$text string
Returns
Type Description
\Elastica_Query_FuzzyLikeThis This current object
methodpublicsetMaxQueryTerms( int $value ) : \Elastica_Query_FuzzyLikeThis

Set max_query_terms

Parameters
Name Type Description
$value int

Max query terms value

Returns
Type Description
\Elastica_Query_FuzzyLikeThis
methodpublicsetMinSimilarity( int $value ) : \Elastica_Query_FuzzyLikeThis

Set the minimum similarity

Parameters
Name Type Description
$value int
Returns
Type Description
\Elastica_Query_FuzzyLikeThis This current object
methodpublicsetParam( 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

methodpublicsetParams( array $params ) : \Elastica_Param
inherited

Sets (overwrites) all params of this object

Inherited from: \Elastica_Param::setParams()\Elastica_Query_Abstract::setParams()
Parameters
Name Type Description
$params array

Parameter list

Returns
Type Description
\Elastica_Param
methodpublicsetPrefixLength( int $value ) : \Elastica_Query_FuzzyLikeThis

Set Prefix Length

Parameters
Name Type Description
$value int

Prefix length

Returns
Type Description
\Elastica_Query_FuzzyLikeThis
methodpublictoArray( ) : array

Converts fuzzy like this query to array

Returns
Type Description
array Query array
Details
See
\Elastica_Query_Abstract::toArray()  
Documentation was generated by DocBlox 0.18.1.