IIndexOptions
in
Interface IIndexOptions
IndexOptions are created in FullTextSearch when an admin initiate an index from the command line:
./occ fulltextsearch:index "{"option1": "value", "option2": true}"
Tags
Table of Contents
Methods
- getOption() : string
- Get the value (as a string) for an option.
- getOptionArray() : array<string|int, mixed>
- Get the value (as an array) for an option.
- getOptionBool() : bool
- Get the value (as an boolean) for an option.
Methods
getOption()
Get the value (as a string) for an option.
public
getOption(string $option[, string $default = '' ]) : string
Parameters
- $option : string
- $default : string = ''
Tags
Return values
stringgetOptionArray()
Get the value (as an array) for an option.
public
getOptionArray(string $option[, array<string|int, mixed> $default = [] ]) : array<string|int, mixed>
Parameters
- $option : string
- $default : array<string|int, mixed> = []
Tags
Return values
array<string|int, mixed>getOptionBool()
Get the value (as an boolean) for an option.
public
getOptionBool(string $option, bool $default) : bool
Parameters
- $option : string
- $default : bool