MetaSearchProviderInterface
in
Meta Search Provider Interface
Tags
Table of Contents
Methods
- getAllResultsText() : string
- Get text of link to go to all results
- getIsHiddenWhenEmpty() : bool
- getKeyword() : string|null
- Get a current keyword
- getName() : string
- Get name of the Search Provider
- getResults() : array<string|int, mixed>
- Run search process to get results
- getRoute() : string|array<string|int, mixed>
- Get a route to provider page
- getService() : MetaSearchService
- Get a service for searching
- getSortOrder() : int
- Get sort order
Methods
getAllResultsText()
Get text of link to go to all results
public
getAllResultsText() : string
Return values
stringgetIsHiddenWhenEmpty()
public
getIsHiddenWhenEmpty() : bool
Return values
bool —True if provider should be hidden when no results are found
getKeyword()
Get a current keyword
public
getKeyword() : string|null
Return values
string|nullgetName()
Get name of the Search Provider
public
getName() : string
Return values
stringgetResults()
Run search process to get results
public
getResults(int $maxResults) : array<string|int, mixed>
Parameters
- $maxResults : int
Return values
array<string|int, mixed> —'totalCount' - Number of total searched records, 'results' - Array of searched records MetaSearchResultInterface[]
getRoute()
Get a route to provider page
public
getRoute() : string|array<string|int, mixed>
Return values
string|array<string|int, mixed>getService()
Get a service for searching
public
getService() : MetaSearchService
Return values
MetaSearchServicegetSortOrder()
Get sort order
public
getSortOrder() : int