ISearchService
in
Interface ISearchService
Tags
Table of Contents
Methods
- generateSearchRequest() : ISearchRequest
- generate a search request, based on an array:
- search() : array<string|int, ISearchResult>
- Search documents
Methods
generateSearchRequest()
generate a search request, based on an array:
public
generateSearchRequest(array<string|int, mixed> $request) : ISearchRequest
$request = [ 'providers' => (string/array) 'all' 'author' => (string) owner of the document. 'search' => (string) search string, 'size' => (int) number of items to be return 'page' => (int) page 'parts' => (array) parts of document to search within, 'options' = (array) search options, 'tags' => (array) tags, 'metatags' => (array) metatags, 'subtags' => (array) subtags ]
'providers' can be an array of providerIds
Parameters
- $request : array<string|int, mixed>
Tags
Return values
ISearchRequestsearch()
Search documents
public
search(string $userId, ISearchRequest $searchRequest) : array<string|int, ISearchResult>
Parameters
- $userId : string
- $searchRequest : ISearchRequest