include/SugarSearchEngine/Elastic/Elastica/Query/Nested.php
Show:
inherited
inherited
Classes
Nested query
- Author
- Nicolas Ruflin
- Category
- Xodoa
- Link
- http://www.elasticsearch.org/guide/reference/query-dsl/nested-query.html
- Package
- Elastica
- Uses
- \Elastica_Query_Abstract
\Elastica_Query_Nested
Package: Elastica
Parameters
Returns
Nested 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
- Link
- http://www.elasticsearch.org/guide/reference/query-dsl/nested-query.html
- Uses
- \Elastica_Query_Abstract
Properties
array
$_params= 'array()'
Default value
array()Details- Type
- array
- Inherited_from
- \Elastica_Param::$$_params
- Inherited_from
- \Elastica_Query_Abstract::$$_params
$_rawParams= 'array()'
Default value
array()Details- Type
- n/a
- Inherited_from
- \Elastica_Param::$$_rawParams
- Inherited_from
- \Elastica_Query_Abstract::$$_rawParams
Methods
_setRawParam(
string $key, mixed $value
)
:
\Elastica_Param
inherited
Sets params not inside params array
Inherited from: \Elastica_Param::_setRawParam()\Elastica_Query_Abstract::_setRawParam()
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $key | string | |
| $value | mixed |
| 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
| Name | Type | Description |
|---|---|---|
| $key | string | Param key |
| $value | mixed | Value to set |
| Type | Description |
|---|---|
| \Elastica_Param |
getParam(
string $key
)
:
mixed
inherited
Returns a specific param
Inherited from: \Elastica_Param::getParam()\Elastica_Query_Abstract::getParam()
Parameters
Returns
Throws
| Name | Type | Description |
|---|---|---|
| $key | string | Key to return |
| Type | Description |
|---|---|
| mixed | Key value |
| 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
Returns
| Name | Type | Description |
|---|---|---|
| $params | array | Parameter list |
| Type | Description |
|---|---|
| \Elastica_Param |
setPath(
string $path
)
:
\Elastica_Query_NestedAdds field to mlt query
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $path | string | Nested object path |
| Type | Description |
|---|---|
| \Elastica_Query_Nested |
setQuery(
\Elastica_Query_Abstract $query
)
:
\Elastica_Query_NestedSets nested query
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $query | \Elastica_Query_Abstract |
| Type | Description |
|---|---|
| \Elastica_Query_Nested |
setScoreMode(
string $scoreMode
)
:
\Elastica_Query_Nested
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $scoreMode | string | Options: avg, total, max and none. |
| Type | Description |
|---|---|
| \Elastica_Query_Nested |
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 |