Suilven\FreeTextSearch\Index
Synopsis
class Index
{
- // members
- private string $clazz = '';
- private array<string> $fields = ;
- private array<string> $storedFields = ;
- private array<string> $tokens = ;
- private array<string $hasOneFields = ;
- private array<string $hasManyFields = ;
- private array<string> $highlightedFields = ;
- private $name;
- private string $tokenizer = TokenizerTypes::NONE;
- private string $language = LanguageTypes::ENGLISH;
- // methods
- public void getName()
- public void setName()
- public void setClass()
- public void getClass()
- public array<string> getFields()
- public array<string> getStoredFields()
- public array<string> getHighlightedFields()
- public array<string getHasOneFields()
- public array<string getHasManyFields()
- public array<string> getTokens()
- public void getTokenizer()
- public void getLanguage()
- public void addField()
- public void addHighlightedField()
- public void addStoredField()
- public void addHasOneField()
- public void addHasManyField()
- public void addToken()
- public void setTokenizer()
Members
private
- $clazz — string
- $fields — Suilven\FreeTextSearch\array<string>
- $hasManyFields — Suilven\FreeTextSearch\array<string
- $hasOneFields — Suilven\FreeTextSearch\array<string
- $highlightedFields — Suilven\FreeTextSearch\array<string>
- $language — string
- $name — string
- $storedFields — Suilven\FreeTextSearch\array<string>
- $tokenizer — string
- $tokens — Suilven\FreeTextSearch\array<string>
Methods
public
- addField() — Add a full text fieldname to the index
- addHasManyField() — Add a has many to the index
- addHasOneField() — Add a has one field to the index
- addHighlightedField() — Register a field to be used for the purposes of highlighting
- addStoredField() — Add a stored field to the index. This is not indexed for free text search, but it used for convenience when rendering search results. e.g. the thumbnail URL for a third party image service
- addToken() — Add a token to the index - not full text searchable but filterable and facetable
- getClass()
- getFields()
- getHasManyFields()
- getHasOneFields()
- getHighlightedFields()
- getLanguage()
- getName()
- getStoredFields()
- getTokenizer()
- getTokens()
- setClass()
- setName()
- setTokenizer()