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

Show:

inherited

Classes
- \Elastica_Query_TopChildren

Table of Contents

Runs the child query with an estimated hits size, and out of the hit docs, aggregates it into parent docs.

Author: Wu Yang
Category: Xodoa
Link: http://www.elasticsearch.org/guide/reference/query-dsl/top-children-query.html
Package: Elastica
Uses: \Elastica_Query_Abstract

\Elastica_Query_TopChildren
jump to top

Package: Elastica

Runs the child query with an estimated hits size, and out of the hit docs, aggregates it into parent docs.

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

Parent(s): \Elastica_Query_Abstract < \Elastica_Param
Author: Wu Yang
Category: Xodoa
Link: http://www.elasticsearch.org/guide/reference/query-dsl/top-children-query.html
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(
          string | \Elastica_Query $query, string $type
              =
              null
          )
        
        :
          void

Parameters

Name	Type	Description
$query	string \| \Elastica_Query	Query string or a Elastica_Query object
$type	string	Parent document type

_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(
          string | \Elastica_Query | \Elastica_Query_Abstract $query
          )
        
        :
          \Elastica_Query_TopChildren

Sets query object

Parameters

Name	Type	Description
$query	string \| \Elastica_Query \| \Elastica_Query_Abstract

Returns

Type	Description
\Elastica_Query_TopChildren

setType(
          string $type
          )
        
        :
          \Elastica_Query_TopChildren

Set type of the parent document

Parameters

Name	Type	Description
$type	string	Parent document type

Returns

Type	Description
\Elastica_Query_TopChildren	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/TopChildren.php

\Elastica_Query_TopChildrenjump to top

Properties

Methods

\Elastica_Query_TopChildren
jump to top