IIndexOptions
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
- getOption() : string
- Get the value (as a string) for an option.
- getOptionArray() : array
- 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
string —getOptionArray()
Get the value (as an array) for an option.
public
getOptionArray(string $option[, array $default = [] ]) : array
Parameters
- $option : string
- $default : array = []
Tags
Return values
array —getOptionBool()
Get the value (as an boolean) for an option.
public
getOptionBool(string $option, bool $default) : bool
Parameters
- $option : string
- $default : bool