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

Show:

inherited

Classes
- \Elastica_Query_Array

Table of Contents

Array query Pure php array query. Can be used to create any not existing type of query.

Author: Nicolas Ruflin
Category: Xodoa
Package: Elastica
Uses: \Elastica_Query_Abstract

\Elastica_Query_Array
jump to top

Package: Elastica

Array query Pure php array query. Can be used to create any not existing type of 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
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


                 $_query= 'array()'

Default valuearray()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(
          array $query
          )
        
        :
          void

Constructs a query based on an array

Parameters

Name	Type	Description
$query	array	Query 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

setQuery(
          array $query
          )
        
        :
          \Elastica_Query_Array

Sets new query array

Parameters

Name	Type	Description
$query	array	Query array

Returns

Type	Description
\Elastica_Query_Array	Current object

toArray(
          
          )
        
        :
          array

Converts query to array

Returns

Type	Description
array	Query array

Details

See: \Elastica_Query_Abstract::toArray()

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

\Elastica_Query_Arrayjump to top

Properties

Methods

\Elastica_Query_Array
jump to top