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

Show:

inherited

Classes
- \Elastica_Query_MoreLikeThis

Table of Contents

\Elastica_Query_MoreLikeThis
jump to top

Package: Elastica

Properties

array
                 $_params= 'array()'

inherited

Params

Inherited from: \Elastica_Param::$$_params \Elastica_Query_Abstract::$$_params

Default valuearray()Details

Type: array
Inherited_from: \Elastica_Param::$$_params
Inherited_from: \Elastica_Query_Abstract::$$_params


                 $_rawParams= 'array()'

inheritedInherited from: \Elastica_Param::$$_rawParams \Elastica_Query_Abstract::$$_rawParams

Default valuearray()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

Name	Type	Description
$key	string
$value	mixed

Returns

Type	Description
\Elastica_Param

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

Parameters

Name	Type	Description
$key	string	Param key
$value	mixed	Value to set

Returns

Type	Description
\Elastica_Param

getParam(
          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

getParams(
          
          )
        
        :
          array

inherited

Returns the params array

Inherited from: \Elastica_Param::getParams()\Elastica_Query_Abstract::getParams()

Returns

Type	Description
array	Params

setAnalyzer(
          string $analyzer
          )
        
        :
          \Elastica_Query_MoreLikeThis

Parameters

Name	Type	Description
$analyzer	string

Returns

Type	Description
\Elastica_Query_MoreLikeThis

setBoost(
          float $boost
          )
        
        :
          \Elastica_Query_MoreLikeThis

Parameters

Name	Type	Description
$boost	float	Boost value

Returns

Type	Description
\Elastica_Query_MoreLikeThis	Query object

setBoostTerms(
          bool $boostTerms
          )
        
        :
          \Elastica_Query_MoreLikeThis

Parameters

Name	Type	Description
$boostTerms	bool

Returns

Type	Description
\Elastica_Query_MoreLikeThis

Details

Link: http://www.elasticsearch.org/guide/reference/query-dsl/mlt-query.html

setFields(
          array $fields
          )
        
        :
          \Elastica_Query_MoreLikeThis

Adds field to mlt query

Parameters

Name	Type	Description
$fields	array	Field names

Returns

Type	Description
\Elastica_Query_MoreLikeThis	Current object

setLikeText(
          string $likeText
          )
        
        :
          \Elastica_Query_MoreLikeThis

Set the "like_text" value

Parameters

Name	Type	Description
$likeText	string

Returns

Type	Description
\Elastica_Query_MoreLikeThis	This current object

setMaxDocFrequency(
          int $maxDocFreq
          )
        
        :
          \Elastica_Query_MoreLikeThis

Parameters

Name	Type	Description
$maxDocFreq	int

Returns

Type	Description
\Elastica_Query_MoreLikeThis

setMaxQueryTerms(
          int $maxQueryTerms
          )
        
        :
          \Elastica_Query_MoreLikeThis

Set max_query_terms

Parameters

Name	Type	Description
$maxQueryTerms	int	Max query terms value

Returns

Type	Description
\Elastica_Query_MoreLikeThis

setMaxWordLength(
          int $maxWordLength
          )
        
        :
          \Elastica_Query_MoreLikeThis

Parameters

Name	Type	Description
$maxWordLength	int

Returns

Type	Description
\Elastica_Query_MoreLikeThis

setMinDocFrequency(
          int $minDocFreq
          )
        
        :
          \Elastica_Query_MoreLikeThis

Parameters

Name	Type	Description
$minDocFreq	int

Returns

Type	Description
\Elastica_Query_MoreLikeThis

setMinTermFrequency(
          int $minTermFreq
          )
        
        :
          \Elastica_Query_MoreLikeThis

Parameters

Name	Type	Description
$minTermFreq	int

Returns

Type	Description
\Elastica_Query_MoreLikeThis

setMinWordLength(
          int $minWordLength
          )
        
        :
          \Elastica_Query_MoreLikeThis

Parameters

Name	Type	Description
$minWordLength	int

Returns

Type	Description
\Elastica_Query_MoreLikeThis

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

Name	Type	Description
$params	array	Parameter list

Returns

Type	Description
\Elastica_Param

setPercentTermsToMatch(
          float $percentTermsToMatch
          )
        
        :
          \Elastica_Query_MoreLikeThis

Parameters

Name	Type	Description
$percentTermsToMatch	float	Percentage

Returns

Type	Description
\Elastica_Query_MoreLikeThis

setStopWords(
          array $stopWords
          )
        
        :
          \Elastica_Query_MoreLikeThis

Parameters

Name	Type	Description
$stopWords	array

Returns

Type	Description
\Elastica_Query_MoreLikeThis

toArray(
          
          )
        
        :
          array

inherited

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

Inherited from: \Elastica_Param::toArray()\Elastica_Query_Abstract::toArray()

Returns

Type	Description
array	Filter array

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

\Elastica_Query_MoreLikeThisjump to top

Properties

Methods

\Elastica_Query_MoreLikeThis
jump to top