ObjectDatabaseIndexSetting
extends _ObjectDatabaseGenericBasicSetting
in package
Tags
Table of Contents
- SETTING_NUMBER_OF_REPLICAS = 'number_of_replicas'
- SETTING_NUMBER_OF_ROUTING_SHARDS = 'number_of_routing_shards'
- SETTING_NUMBER_OF_SHARDS = 'number_of_shards'
- _getDefinitionCategoryName() : string
- addParameter() : bool
- Adds a parameter for a given key to the tokenizer setting.
- getDefinition() : array<string|int, mixed>
- getParameterForKey() : mixed|null
- Returns a value for the given parameter key.
- getParameters() : array<string|int, ObjectDatabaseParameter>
- Returns all added parameter.
- removeParameterForKey() : bool
- Removes a parameter for a given key of the tokenizer settings.
Constants
SETTING_NUMBER_OF_REPLICAS
public
mixed
SETTING_NUMBER_OF_REPLICAS
= 'number_of_replicas'
Tags
SETTING_NUMBER_OF_ROUTING_SHARDS
public
mixed
SETTING_NUMBER_OF_ROUTING_SHARDS
= 'number_of_routing_shards'
Tags
SETTING_NUMBER_OF_SHARDS
public
mixed
SETTING_NUMBER_OF_SHARDS
= 'number_of_shards'
Tags
Methods
_getDefinitionCategoryName()
public
_getDefinitionCategoryName() : string
Tags
Return values
string —addParameter()
Adds a parameter for a given key to the tokenizer setting.
public
addParameter(ObjectDatabaseParameter $oParameter) : bool
If a parameter with a key already exists in the tokenizer setting the method return false, otherwise true.
Parameters
- $oParameter : ObjectDatabaseParameter
Tags
Return values
bool —getDefinition()
public
getDefinition() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —getParameterForKey()
Returns a value for the given parameter key.
public
getParameterForKey(string $sKey) : mixed|null
The method returns null if no value has been found for the given key.
Parameters
- $sKey : string
Tags
Return values
mixed|null —getParameters()
Returns all added parameter.
public
getParameters() : array<string|int, ObjectDatabaseParameter>
Tags
Return values
array<string|int, ObjectDatabaseParameter> —removeParameterForKey()
Removes a parameter for a given key of the tokenizer settings.
public
removeParameterForKey(string $sKey) : bool
If the parameter does not exist the method returns false, otherwise true.
Parameters
- $sKey : string