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

Show:

inherited

Classes
- \Elastica_Query_QueryString

Table of Contents

QueryString query

Author: Nicolas Ruflin , Jasper van Wanrooy
Category: Xodoa
Link: http://www.elasticsearch.org/guide/reference/query-dsl/query-string-query.html
Package: Elastica
Uses: \Elastica_Query_Abstract

\Elastica_Query_QueryString
jump to top

Package: Elastica

QueryString query

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

Parent(s): \Elastica_Query_Abstract < \Elastica_Param
Author: Nicolas Ruflin , Jasper van Wanrooy
Category: Xodoa
Link: http://www.elasticsearch.org/guide/reference/query-dsl/query-string-query.html
Uses: \Elastica_Query_Abstract

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


                 $_queryString= ''''

Default value''Details

Type: n/a


                 $_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

__construct(
          string $queryString
              =
              ''
          )
        
        :
          void

Creates query string object. Calls setQuery with argument

Parameters

Name	Type	Description
$queryString	string	OPTIONAL Query string for object

_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

setAllowLeadingWildcard(
          bool $allow
              =
              true
          )
        
        :
          \Elastica_Query_QueryString

Sets the parameter to allow * and ? as first characters.

If not set, defaults to true.

Parameters

Name	Type	Description
$allow	bool

Returns

Type	Description
\Elastica_Query_QueryString	Current object

setAnalyzeWildcard(
          bool $analyze
              =
              true
          )
        
        :
          \Elastica_Query_QueryString

Allows analyzing of wildcard terms.

If not set, defaults to false

Parameters

Name	Type	Description
$analyze	bool

Returns

Type	Description
\Elastica_Query_QueryString	Current object

setAnalyzer(
          string $analyzer
          )
        
        :
          \Elastica_Query_QueryString

Sets the analyzer to analyze the query with.

Parameters

Name	Type	Description
$analyzer	string	Analyser to use

Returns

Type	Description
\Elastica_Query_QueryString	Current object

setAutoGeneratePhraseQueries(
          bool $autoGenerate
              =
              true
          )
        
        :
          \Elastica_Query_QueryString

Sets the param to automatically generate phrase queries.

If not set, defaults to false.

Parameters

Name	Type	Description
$autoGenerate	bool

Returns

Type	Description
\Elastica_Query_QueryString	Current object

setBoost(
          float $boost
              =
              1.0
          )
        
        :
          \Elastica_Query_QueryString

Sets the boost value of the query.

If not set, defaults to 1.0.

Parameters

Name	Type	Description
$boost	float

Returns

Type	Description
\Elastica_Query_QueryString	Current object

setDefaultField(
          string $field
          )
        
        :
          \Elastica_Query_QueryString

Sets the default field

If no field is set, _all is chosen

Parameters

Name	Type	Description
$field	string	Field

Returns

Type	Description
\Elastica_Query_QueryString	Current object

setDefaultOperator(
          string $operator
          )
        
        :
          \Elastica_Query_QueryString

Sets the default operator AND or OR

If no operator is set, OR is chosen

Parameters

Name	Type	Description
$operator	string	Operator

Returns

Type	Description
\Elastica_Query_QueryString	Current object

setEnablePositionIncrements(
          bool $enabled
              =
              true
          )
        
        :
          \Elastica_Query_QueryString

Sets the paramater to enable the position increments in result queries.

If not set, defaults to true.

Parameters

Name	Type	Description
$enabled	bool

Returns

Type	Description
\Elastica_Query_QueryString	Current object

setFields(
          array $fields
          )
        
        :
          \Elastica_Query_QueryString

Sets the fields

If no fields are set, _all is chosen

Parameters

Name	Type	Description
$fields	array	Fields

Returns

Type	Description
\Elastica_Query_QueryString	Current object

setFuzzyMinSim(
          float $minSim
              =
              0.5
          )
        
        :
          \Elastica_Query_QueryString

Sets the fuzzy minimal similarity parameter.

If not set, defaults to 0.5

Parameters

Name	Type	Description
$minSim	float

Returns

Type	Description
\Elastica_Query_QueryString	Current object

setFuzzyPrefixLength(
          int $length
              =
              0
          )
        
        :
          \Elastica_Query_QueryString

Sets the fuzzy prefix length parameter.

If not set, defaults to 0.

Parameters

Name	Type	Description
$length	int

Returns

Type	Description
\Elastica_Query_QueryString	Current object

setLowercaseExpandedTerms(
          bool $lowercase
              =
              true
          )
        
        :
          \Elastica_Query_QueryString

Sets the parameter to auto-lowercase terms of some queries.

If not set, defaults to true.

Parameters

Name	Type	Description
$lowercase	bool

Returns

Type	Description
\Elastica_Query_QueryString	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

Name	Type	Description
$params	array	Parameter list

Returns

Type	Description
\Elastica_Param

setPhraseSlop(
          int $phraseSlop
              =
              0
          )
        
        :
          \Elastica_Query_QueryString

Sets the phrase slop.

If zero, exact phrases are required. If not set, defaults to zero.

Parameters

Name	Type	Description
$phraseSlop	int

Returns

Type	Description
\Elastica_Query_QueryString	Current object

setQuery(
          string $query
              =
              ''
          )
        
        :
          \Elastica_Query_QueryString

Sets a new query string for the object

Parameters

Name	Type	Description
$query	string	Query string

Returns

Type	Description
\Elastica_Query_QueryString	Current object

setQueryString(
          string $queryString
          )
        
        :
          \Elastica_Query_QueryString

Sets the default operator AND or OR

If no operator is set, OR is chosen

Parameters

Name	Type	Description
$queryString	string	Query string

Returns

Type	Description
\Elastica_Query_QueryString	Current object

Details

Deprecated: Please use setQuery instead

setRewrite(
          string $rewrite
              =
              ""
          )
        
        :
          \Elastica_Param

Set a re-write condition. See https://github.com/elasticsearch/elasticsearch/issues/1186 for additional information

Parameters

Name	Type	Description
$rewrite	string

Returns

Type	Description
\Elastica_Param

Details

Author: Andreas Sandberg @sugarcrm Added pull request https://github.com/ruflin/Elastica/pull/141

setTieBraker(
          int $tieBreaker
              =
              0
          )
        
        :
          \Elastica_Query_QueryString

When using dis_max, the disjunction max tie breaker.

If not set, defaults to 0.

Parameters

Name	Type	Description
$tieBreaker	int

Returns

Type	Description
\Elastica_Query_QueryString	Current object

setUseDisMax(
          bool $value
              =
              true
          )
        
        :
          \Elastica_Query_QueryString

Whether to use bool or dis_max quueries to internally combine results for multi field search.

Parameters

Name	Type	Description
$value	bool	Determines whether to use

Returns

Type	Description
\Elastica_Query_QueryString	Current object

toArray(
          
          )
        
        :
          array

Converts query to array

Returns

Type	Description
array	Query array

Details

See: \Elastica_Param::toArray()

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

\Elastica_Query_QueryStringjump to top

Properties

Methods

\Elastica_Query_QueryString
jump to top