include/SugarSearchEngine/Elastic/Elastica/Query.php

Show:

inherited

Classes
- \Elastica_Query

Table of Contents

Elastica query object

Creates different types of queries

Author: Nicolas Ruflin
Category: Xodoa
Link: http://www.elasticsearch.com/docs/elasticsearch/rest_api/search/
Package: Elastica

\Elastica_Query
jump to top

Package: Elastica

Elastica query object

Creates different types of queries

Parent(s): \Elastica_Param
Author: Nicolas Ruflin
Category: Xodoa
Link: http://www.elasticsearch.com/docs/elasticsearch/rest_api/search/

Properties

array
                 $_params= 'array()'

Params

Default valuearray()Details

Type: array


                 $_rawParams= 'array()'

inheritedInherited from: \Elastica_Param::$$_rawParams

Default valuearray()Details

Type: n/a
Inherited_from: \Elastica_Param::$$_rawParams

Methods

__construct(
          array | \Elastica_Query_Abstract $query
              =
              null
          )
        
        :
          void

Creates a query object

Parameters

Name	Type	Description
$query	array \| \Elastica_Query_Abstract	OPTIONAL Query object (default = null)

_setRawParam(
          string $key, mixed $value
          )
        
        :
          \Elastica_Param

inherited

Sets params not inside params array

Inherited from: \Elastica_Param::_setRawParam()

Parameters

Name	Type	Description
$key	string
$value	mixed

Returns

Type	Description
\Elastica_Param

addFacet(
          \Elastica_Facet_Abstract $facet
          )
        
        :
          \Elastica_Query

Adds a Facet to the query

Parameters

Name	Type	Description
$facet	\Elastica_Facet_Abstract	Facet object

Returns

Type	Description
\Elastica_Query	Query object

addHighlight(
          mixed $highlight
          )
        
        :
          \Elastica_Query

Adds a highlight argument

Parameters

Name	Type	Description
$highlight	mixed	Add highlight argument

Returns

Type	Description
\Elastica_Query	Query object

Details

Link: http://www.elasticsearch.com/docs/elasticsearch/rest_api/search/highlighting/

addParam(
          string $key, mixed $value
          )
        
        :
          \Elastica_Param

inherited

Adds a param to the list

Inherited from: \Elastica_Param::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

addSort(
          mixed $sort
          )
        
        :
          \Elastica_Query

Adds a sort param to the query

Parameters

Name	Type	Description
$sort	mixed	Sort parameter

Returns

Type	Description
\Elastica_Query	Query object

Details

Link: http://www.elasticsearch.org/guide/reference/api/search/sort.html

create(
          mixed $query
          )
        
        :
          \Elastica_Query

static

Transforms a string or an array to a query object

If query is empty,

Parameters

Name	Type	Description
$query	mixed

Returns

Type	Description
\Elastica_Query

getParam(
          string $key
          )
        
        :
          mixed

inherited

Returns a specific param

Inherited from: \Elastica_Param::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()

Returns

Type	Description
array	Params

getQuery(
          
          )
        
        :
          array

Gets the query array

Returns

Type	Description
array

setExplain(
          bool $explain
              =
              true
          )
        
        :
          \Elastica_Query

Enables explain on the query

Parameters

Name	Type	Description
$explain	bool	OPTIONAL Enabled or disable explain (default = true)

Returns

Type	Description
\Elastica_Query	Current object

Details

Link: http://www.elasticsearch.com/docs/elasticsearch/rest_api/search/explain/

setFacets(
          array $facets
          )
        
        :
          \Elastica_Query

Sets all facets for this query object. Replaces existing facets

Parameters

Name	Type	Description
$facets	array	List of facet objects

Returns

Type	Description
\Elastica_Query	Query object

Details

Link: http://www.elasticsearch.com/docs/elasticsearch/rest_api/search/facets

setFields(
          array $fields
          )
        
        :
          \Elastica_Query

Sets the fields to be returned by the search

Parameters

Name	Type	Description
$fields	array	Fields to be returne

Returns

Type	Description
\Elastica_Query	Current object

Details

Link: http://www.elasticsearch.com/docs/elasticsearch/rest_api/search/fields/

setFilter(
          \Elastica_Filter_Abstract $filter
          )
        
        :
          \Elastica_Query

Parameters

Name	Type	Description
$filter	\Elastica_Filter_Abstract	Filter object

Returns

Type	Description
\Elastica_Query	Current object

setFrom(
          int $from
          )
        
        :
          \Elastica_Query

Sets the start from which the search results should be returned

Parameters

Name	Type	Description
$from	int

Returns

Type	Description
\Elastica_Query	Query object

setHighlight(
          array $highlightArgs
          )
        
        :
          \Elastica_Query

Sets highlight arguments for the query

Parameters

Name	Type	Description
$highlightArgs	array	Set all highlight arguments

Returns

Type	Description
\Elastica_Query	Query object

Details

Link: http://www.elasticsearch.org/guide/reference/api/search/highlighting.html

setLimit(
          int $limit
              =
              10
          )
        
        :
          \Elastica_Query

Sets maximum number of results for this query

Setting the limit to 0, means no limit

Parameters

Name	Type	Description
$limit	int	OPTIONAL Maximal number of results for query (default = 10)

Returns

Type	Description
\Elastica_Query	Query object

setMinScore(
          int | double $minScore
          )
        
        :
          \Elastica_Query

Allows filtering of documents based on a minimum score

Parameters

Name	Type	Description
$minScore	int \| double	Minimum score to filter documents by

Returns

Type	Description
\Elastica_Query	Query object

setParam(
          string $key, mixed $value
          )
        
        :
          void

inherited

Sets (overwrites) the value at the given key

Inherited from: \Elastica_Param::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()

Parameters

Name	Type	Description
$params	array	Parameter list

Returns

Type	Description
\Elastica_Param

setQuery(
          \Elastica_Query_Abstract $query
          )
        
        :
          \Elastica_Query

Sets the query

Parameters

Name	Type	Description
$query	\Elastica_Query_Abstract	Query object

Returns

Type	Description
\Elastica_Query	Query object

setRawQuery(
          array $query
          )
        
        :
          \Elastica_Query

Sets query as raw array. Will overwrite all already set arguments

Parameters

Name	Type	Description
$query	array	Query array

Returns

Type	Description
\Elastica_Query	Query object

setScriptFields(
          array $scriptFields
          )
        
        :
          \Elastica_Query

Set script fields

Parameters

Name	Type	Description
$scriptFields	array	Script fields

Returns

Type	Description
\Elastica_Query	Current object

Details

Link: http://www.elasticsearch.com/docs/elasticsearch/rest_api/search/script_fields/

setSize(
          int $limit
              =
              10
          )
        
        :
          \Elastica_Query

Alias for setLimit

Parameters

Name	Type	Description
$limit	int	OPTIONAL Maximal number of results for query (default = 10)

Returns

Type	Description
\Elastica_Query	Query object

setSort(
          array $sortArgs
          )
        
        :
          \Elastica_Query

Sets sort arguments for the query Replaces existing values

Parameters

Name	Type	Description
$sortArgs	array	Sorting arguments

Returns

Type	Description
\Elastica_Query	Query object

Details

Link: http://www.elasticsearch.org/guide/reference/api/search/sort.html

setVersion(
          bool $version
              =
              true
          )
        
        :
          \Elastica_Query

Enables version on the query

Parameters

Name	Type	Description
$version	bool	OPTIONAL Enabled or disable version (default = true)

Returns

Type	Description
\Elastica_Query	Current object

Details

Link: http://www.elasticsearch.com/docs/elasticsearch/rest_api/search/version/

toArray(
          
          )
        
        :
          array

Converts all query params to an array

Returns

Type	Description
array	Query array

include/SugarSearchEngine/Elastic/Elastica/Query.php

\Elastica_Queryjump to top

Properties

Methods

\Elastica_Query
jump to top