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

Show:

inherited

Classes
- \Elastica_Query_Ids

Table of Contents

Ids Query

Author: Lee Parker
Author: Nicolas Ruflin
Author: Tim Rupp
Category: Xodoa
Link: http://www.elasticsearch.org/guide/reference/query-dsl/ids-query.html
Package: Elastica
Uses: \Elastica_Query_Abstract

\Elastica_Query_Ids
jump to top

Package: Elastica

Ids Query

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

Parent(s): \Elastica_Query_Abstract < \Elastica_Param
Author: Lee Parker
Author: Nicolas Ruflin
Author: Tim Rupp
Category: Xodoa
Link: http://www.elasticsearch.org/guide/reference/query-dsl/ids-query.html
Uses: \Elastica_Query_Abstract

Properties

array
                 $_params= 'array()'

Params

Default valuearray()Details

Type: array


                 $_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 | \Elastica_Type $type
              =
              null, array $ids
              =
              array()
          )
        
        :
          void

Creates filter object

Parameters

Name	Type	Description
$type	string \| \Elastica_Type	Type to filter on
$ids	array	List of ids

_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

addId(
          string $id
          )
        
        :
          \Elastica_Query_Ids

Adds one more filter to the and filter

Parameters

Name	Type	Description
$id	string	Adds id to filter

Returns

Type	Description
\Elastica_Query_Ids	Current object

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

addType(
          string $type
          )
        
        :
          \Elastica_Query_Ids

Adds one more type to query

Parameters

Name	Type	Description
$type	string	Adds type to query

Returns

Type	Description
\Elastica_Query_Ids	Current object

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

setIds(
          array | string $ids
          )
        
        :
          \Elastica_Query_Ids

Sets the ids to filter

Parameters

Name	Type	Description
$ids	array \| string	List of ids

Returns

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

setType(
          string | \Elastica_Type $type
          )
        
        :
          \Elastica_Query_Ids

Parameters

Name	Type	Description
$type	string \| \Elastica_Type	Type name or object

Returns

Type	Description
\Elastica_Query_Ids	Current object

toArray(
          
          )
        
        :
          array

Converts filter to array

Returns

Type	Description
array	Query array

Details

See: \Elastica_Query_Abstract::toArray()

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

\Elastica_Query_Idsjump to top

Properties

Methods

\Elastica_Query_Ids
jump to top