SearchResultInterface
in
Table of Contents
Methods
- createFacet() : array<string|int, mixed>
- Create a single facet array for a faceted class
- getHighlightByID() : string
- Get the highlights for a specific document
- getMatches() : ArrayList
- Get the matches as an ArrayList and add an excerpt if possible.
- getPaginatedMatches() : PaginatedList
- Paginated version of getPaginatedMatches
- getSpellcheck() : mixed
Methods
createFacet()
Create a single facet array for a faceted class
public
createFacet(stdClass|FacetSet $facets, array<string|int, mixed>|stdClass $options, string $class, array<string|int, mixed> $facetArray) : array<string|int, mixed>
Parameters
- $facets : stdClass|FacetSet
- $options : array<string|int, mixed>|stdClass
- $class : string
- $facetArray : array<string|int, mixed>
Return values
array<string|int, mixed>getHighlightByID()
Get the highlights for a specific document
public
getHighlightByID(string|int $docId) : string
Parameters
- $docId : string|int
-
ID of the document to search for
Return values
stringgetMatches()
Get the matches as an ArrayList and add an excerpt if possible.
public
getMatches() : ArrayList
Return values
ArrayListgetPaginatedMatches()
Paginated version of getPaginatedMatches
public
getPaginatedMatches() : PaginatedList
Return values
PaginatedListgetSpellcheck()
public
getSpellcheck() : mixed