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

Show:

inherited

Classes
- \Elastica_Query_Term

Table of Contents

Term query

Author: Nicolas Ruflin
Category: Xodoa
Link: http://www.elasticsearch.com/docs/elasticsearch/rest_api/query_dsl/term_query/
Package: Elastica
Uses: \Elastica_Query_Abstract

\Elastica_Query_Term
jump to top

Package: Elastica

Term query

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

Parent(s): \Elastica_Query_Abstract < \Elastica_Param
Author: Nicolas Ruflin
Category: Xodoa
Link: http://www.elasticsearch.com/docs/elasticsearch/rest_api/query_dsl/term_query/
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


                 $_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(
          array $term
              =
              array()
          )
        
        :
          void

Constructs the Term query object

Parameters

Name	Type	Description
$term	array	OPTIONAL Calls setTerm with the given $term array

_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

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

setRawTerm(
          array $term
          )
        
        :
          \Elastica_Query_Term

Set term can be used instead of addTerm if some more special values for a term have to be set.

Parameters

Name	Type	Description
$term	array	Term array

Returns

Type	Description
\Elastica_Query_Term	Current object

setTerm(
          string $key, string | array $value, float $boost
              =
              1.0
          )
        
        :
          \Elastica_Query_Term

Adds a term to the term query

Parameters

Name	Type	Description
$key	string	Key to query
$value	string \| array	Values(s) for the query. Boost can be set with array
$boost	float	OPTIONAL Boost value (default = 1.0)

Returns

Type	Description
\Elastica_Query_Term	Current object

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/Term.php

\Elastica_Query_Termjump to top

Properties

Methods

\Elastica_Query_Term
jump to top