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

Show:

inherited

Classes
- \Elastica_Query_Abstract

Table of Contents

Abstract query object. Should be extended by all query types.

Author: Nicolas Ruflin
Category: Xodoa
Package: Elastica

\Elastica_Query_Abstract
jump to top

Package: Elastica

Abstract query object. Should be extended by all query types.

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

Parent(s): \Elastica_Param
Children: \Elastica_Query_Builder; \Elastica_Query_CustomScore; \Elastica_Query_Wildcard; \Elastica_Query_QueryString; \Elastica_Query_Text; \Elastica_Query_Bool; \Elastica_Query_Field; \Elastica_Query_Ids; \Elastica_Query_Fuzzy; \Elastica_Query_FuzzyLikeThis; \Elastica_Query_Range; \Elastica_Query_Terms; \Elastica_Query_ConstantScore; \Elastica_Query_HasChild; \Elastica_Query_TopChildren; \Elastica_Query_Array; \Elastica_Query_MatchAll; \Elastica_Query_CustomFiltersScore; \Elastica_Query_Filtered; \Elastica_Query_Term; \Elastica_Query_MoreLikeThis; \Elastica_Query_Nested
Author: Nicolas Ruflin
Category: Xodoa
Used_by: Elastica_Query_Builder
Used_by: \Elastica_Query_Builder
Used_by: Elastica_Query_CustomScore
Used_by: \Elastica_Query_CustomScore
Used_by: Elastica_Query_Wildcard
Used_by: \Elastica_Query_Wildcard
Used_by: Elastica_Query_QueryString
Used_by: \Elastica_Query_QueryString
Used_by: Elastica_Query_Text
Used_by: \Elastica_Query_Text
Used_by: Elastica_Query_Bool
Used_by: \Elastica_Query_Bool
Used_by: Elastica_Query_Field
Used_by: \Elastica_Query_Field
Used_by: Elastica_Query_Ids
Used_by: \Elastica_Query_Ids
Used_by: Elastica_Query_Fuzzy
Used_by: \Elastica_Query_Fuzzy
Used_by: Elastica_Query_FuzzyLikeThis
Used_by: \Elastica_Query_FuzzyLikeThis
Used_by: Elastica_Query_Range
Used_by: \Elastica_Query_Range
Used_by: Elastica_Query_Terms
Used_by: \Elastica_Query_Terms
Used_by: Elastica_Query_ConstantScore
Used_by: \Elastica_Query_ConstantScore
Used_by: Elastica_Query_HasChild
Used_by: \Elastica_Query_HasChild
Used_by: Elastica_Query_TopChildren
Used_by: \Elastica_Query_TopChildren
Used_by: Elastica_Query_Array
Used_by: \Elastica_Query_Array
Used_by: Elastica_Query_MatchAll
Used_by: \Elastica_Query_MatchAll
Used_by: Elastica_Query_CustomFiltersScore
Used_by: \Elastica_Query_CustomFiltersScore
Used_by: Elastica_Query_Filtered
Used_by: \Elastica_Query_Filtered
Used_by: Elastica_Query_Term
Used_by: \Elastica_Query_Term
Used_by: Elastica_Query_MoreLikeThis
Used_by: \Elastica_Query_MoreLikeThis
Used_by: Elastica_Query_Nested
Used_by: \Elastica_Query_Nested
Used_by: Elastica_Filter_Prefix
Used_by: \Elastica_Filter_Prefix
Used_by: Elastica_Filter_Exists
Used_by: \Elastica_Filter_Exists
Used_by: Elastica_Filter_GeoPolygon
Used_by: \Elastica_Filter_GeoPolygon
Used_by: Elastica_Filter_Terms
Used_by: \Elastica_Filter_Terms
Used_by: Elastica_Filter_GeoBoundingBox
Used_by: \Elastica_Filter_GeoBoundingBox
Used_by: Elastica_Filter_Term
Used_by: \Elastica_Filter_Term

Properties

array
                 $_params= 'array()'

inherited

Params

Inherited from: \Elastica_Param::$$_params

Default valuearray()Details

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


                 $_rawParams= 'array()'

inheritedInherited from: \Elastica_Param::$$_rawParams

Default valuearray()Details

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

Methods

_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

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

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

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

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

Returns

Type	Description
array	Filter array

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

\Elastica_Query_Abstractjump to top

Properties

Methods

\Elastica_Query_Abstract
jump to top