BeforeSearchInDatabaseRecordProviderEvent
final class \
PSR-14 event to modify the incoming input about which tables should be searched for within the live search results. This allows adding additional DB tables to be excluded / ignored, to further limit the search result on certain page IDs or to modify the search query altogether.
Table of Contents
Methods
- __construct() : mixed
- getIgnoredTables() : string[]
- getSearchDemand() : SearchDemand
- getSearchPageIds() : array
- ignoreTable() : void
- isTableIgnored() : bool
- setIgnoredTables() : void
- setSearchDemand() : void
- setSearchPageIds() : void
Methods
__construct()
public
__construct(array $searchPageIds, SearchDemand $searchDemand) : mixed
Parameters
- $searchPageIds : array
- $searchDemand : SearchDemand
getIgnoredTables()
public
getIgnoredTables() : string[]
Return values
string[]getSearchDemand()
public
getSearchDemand() : SearchDemand
Return values
SearchDemandgetSearchPageIds()
public
getSearchPageIds() : array
Return values
arrayignoreTable()
public
ignoreTable(string $table) : void
Parameters
- $table : string
isTableIgnored()
public
isTableIgnored(string $table) : bool
Parameters
- $table : string
Return values
boolsetIgnoredTables()
public
setIgnoredTables(array $tables) : void
Parameters
- $tables : array
setSearchDemand()
public
setSearchDemand(SearchDemand $searchDemand) : void
Parameters
- $searchDemand : SearchDemand
setSearchPageIds()
public
setSearchPageIds(array $searchPageIds) : void
Parameters
- $searchPageIds : array