_ObjectDatabaseGenericExtendedSetting
extends _ObjectDatabaseGenericBasicSetting
in package
Tags
Table of Contents
- addParameter() : bool
- Adds a parameter for a given key to the tokenizer setting.
- getDefinition() : array<string|int, mixed>
- getName() : string
- getParameterForKey() : mixed|null
- Returns a value for the given parameter key.
- getParameters() : array<string|int, ObjectDatabaseParameter>
- Returns all added parameter.
- getType() : int|null
- removeParameterForKey() : bool
- Removes a parameter for a given key of the tokenizer settings.
- setName() : void
- setType() : void
Methods
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> —getName()
public
getName() : string
Tags
Return values
string —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> —getType()
public
getType() : int|null
Tags
Return values
int|null —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
Tags
Return values
bool —setName()
public
setName(string $sName) : void
Parameters
- $sName : string
Tags
Return values
void —setType()
public
setType(int $iType) : void
Parameters
- $iType : int