1. interface
  2. XELOS
  3. \
  4. Modules
  5. \
  6. Search
  7. \
  8. Interfaces
  9. \
  10. SearchAdapterInterface

SearchAdapterInterface

interface SearchAdapterInterface

Interface Class for Search Adapters

Methods

addToIndex(SearchIndexRecord $searchIndexRecord)

No description

cleanIndex()

Cleans the index (removes all data) and setups structure.

array
getIndexInfo()

Returns an array that contains information about the search index.

UIComponent|null
getMaintenanceUI()

Return Optional UI Component for advanced maintenance UI

removeFromIndex(DocumentIndex $DocumentIndex)

No description

Details

at line 29
addToIndex(SearchIndexRecord $searchIndexRecord)

No description

Parameters

SearchIndexRecord $searchIndexRecord

at line 24
cleanIndex()

Cleans the index (removes all data) and setups structure.

at line 19
array getIndexInfo()

Returns an array that contains information about the search index.

Return Value

array

Array contains information with keys: document_count, instance_list, index_size

at line 41
UIComponent|null getMaintenanceUI()

Return Optional UI Component for advanced maintenance UI

Return Value

UIComponent|null

at line 34
removeFromIndex(DocumentIndex $DocumentIndex)

No description

Parameters

DocumentIndex $DocumentIndex