‪TYPO3CMS  ‪main
TYPO3\CMS\Backend\Search\Event\BeforeSearchInDatabaseRecordProviderEvent Class Reference

Public Member Functions

 __construct (private array $searchPageIds, private SearchDemand $searchDemand)
 
 getSearchPageIds ()
 
 setSearchPageIds (array $searchPageIds)
 
 getSearchDemand ()
 
 setSearchDemand (SearchDemand $searchDemand)
 
 ignoreTable (string $table)
 
 setIgnoredTables (array $tables)
 
 isTableIgnored (string $table)
 
string[] getIgnoredTables ()
 

Private Attributes

array $ignoredTables = []
 

Detailed Description

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.

Definition at line 27 of file BeforeSearchInDatabaseRecordProviderEvent.php.

Constructor & Destructor Documentation

◆ __construct()

TYPO3\CMS\Backend\Search\Event\BeforeSearchInDatabaseRecordProviderEvent::__construct ( private array  $searchPageIds,
private SearchDemand  $searchDemand 
)

Member Function Documentation

◆ getIgnoredTables()

string [] TYPO3\CMS\Backend\Search\Event\BeforeSearchInDatabaseRecordProviderEvent::getIgnoredTables ( )

◆ getSearchDemand()

TYPO3\CMS\Backend\Search\Event\BeforeSearchInDatabaseRecordProviderEvent::getSearchDemand ( )

◆ getSearchPageIds()

TYPO3\CMS\Backend\Search\Event\BeforeSearchInDatabaseRecordProviderEvent::getSearchPageIds ( )

◆ ignoreTable()

TYPO3\CMS\Backend\Search\Event\BeforeSearchInDatabaseRecordProviderEvent::ignoreTable ( string  $table)

◆ isTableIgnored()

TYPO3\CMS\Backend\Search\Event\BeforeSearchInDatabaseRecordProviderEvent::isTableIgnored ( string  $table)

◆ setIgnoredTables()

TYPO3\CMS\Backend\Search\Event\BeforeSearchInDatabaseRecordProviderEvent::setIgnoredTables ( array  $tables)

◆ setSearchDemand()

TYPO3\CMS\Backend\Search\Event\BeforeSearchInDatabaseRecordProviderEvent::setSearchDemand ( SearchDemand  $searchDemand)

◆ setSearchPageIds()

TYPO3\CMS\Backend\Search\Event\BeforeSearchInDatabaseRecordProviderEvent::setSearchPageIds ( array  $searchPageIds)

Member Data Documentation

◆ $ignoredTables

array TYPO3\CMS\Backend\Search\Event\BeforeSearchInDatabaseRecordProviderEvent::$ignoredTables = []
private