BeforeSearchInDatabaseRecordProviderEvent¶
New in version 12.1
The TYPO3 backend search (also known as "Live Search") uses the
\TYPO3\CMS\Backend\Search\LiveSearch\DatabaseRecordProvider
to search
for records in database tables, having searchFields
configured in TCA.
In some individual cases it may not be desirable to search in a specific table.
Therefore, the PSR-14 event
\TYPO3\CMS\Backend\Search\Event\BeforeSearchInDatabaseRecordProviderEvent
is available, which allows to exclude / ignore such tables by adding them
to a deny list. Additionally, the PSR-14 event can be used to restrict the
search result on certain page IDs or to modify the search query altogether.
Example¶
<?php
declare(strict_types=1);
namespace MyVendor\MyExtension\Backend\EventListener;
use TYPO3\CMS\Backend\Search\Event\BeforeSearchInDatabaseRecordProviderEvent;
use TYPO3\CMS\Core\Attribute\AsEventListener;
#[AsEventListener(
identifier: 'my-extension/before-search-in-database-record-provider',
)]
final readonly class MyEventListener
{
public function __invoke(BeforeSearchInDatabaseRecordProviderEvent $event): void
{
$event->ignoreTable('my_custom_table');
}
}
New in version 13.0
The PHP attribute \TYPO3\CMS\Core\Attribute\AsEventListener
has been
introduced to tag a PHP class as an event listener. Alternatively, or if you
need to be compatible with older TYPO3 versions, you can also register an
event listener via the Configuration/Services.yaml
file. Switch to
an older version of this page for an example or have a look at the section
Implementing an event listener in your extension.
API¶
- class \TYPO3\CMS\Backend\Search\Event\ BeforeSearchInDatabaseRecordProviderEvent
-
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.
- getSearchPageIds ( )
-
- returntype
-
array
- setSearchPageIds ( array $searchPageIds)
-
- param array $searchPageIds
-
the searchPageIds
- getSearchDemand ( )
-
- returntype
-
TYPO3\CMS\Backend\Search\LiveSearch\SearchDemand\SearchDemand
- setSearchDemand ( TYPO3\\CMS\\Backend\\Search\\LiveSearch\\SearchDemand\\SearchDemand $searchDemand)
-
- param TYPO3\\CMS\\Backend\\Search\\LiveSearch\\SearchDemand\\SearchDemand $searchDemand
-
the searchDemand
- ignoreTable ( string $table)
-
- param string $table
-
the table
- setIgnoredTables ( array $tables)
-
- param array $tables
-
the tables
- isTableIgnored ( string $table)
-
- param string $table
-
the table
- returntype
-
bool
- getIgnoredTables ( )
-
- returntype
-
array
- Returns:
-
string[]