include/SugarSearchEngine/Elastic/Elastica/Param.php
Show:
inherited
inherited
Classes
Class to handle params
This function can be used to handle params for queries, filter, facets
- Author
- Nicolas Ruflin
- Category
- Xodoa
- Package
- Elastica
\Elastica_Param
Package: Elastica
Parameters
Returns
Class to handle params
This function can be used to handle params for queries, filter, facets
- Children
- \Elastica_Facet_Abstract
- \Elastica_Query_Abstract
- \Elastica_Filter_Abstract
- \Elastica_Query
- Author
- Nicolas Ruflin
- Category
- Xodoa
Properties
array
$_params= 'array()'
Params
Default value
array()Details- Type
- array
$_rawParams= 'array()'
Default value
array()Details- Type
- n/a
Methods
_setRawParam(
string $key, mixed $value
)
:
\Elastica_ParamSets params not inside params array
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $key | string | |
| $value | mixed |
| Type | Description |
|---|---|
| \Elastica_Param |
addParam(
string $key, mixed $value
)
:
\Elastica_ParamAdds a param to the list
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
)
:
mixedReturns a specific param
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(
)
:
arrayReturns the params array
Returns
| Type | Description |
|---|---|
| array | Params |
setParam(
string $key, mixed $value
)
:
voidSets (overwrites) the value at the given key
Parameters
| Name | Type | Description |
|---|---|---|
| $key | string | Key to set |
| $value | mixed | Key Value |
setParams(
array $params
)
:
\Elastica_ParamSets (overwrites) all params of this object
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $params | array | Parameter list |
| Type | Description |
|---|---|
| \Elastica_Param |
toArray(
)
:
arrayConverts 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
Returns
| Type | Description |
|---|---|
| array | Filter array |