ModifyResultItemInLiveSearchEvent¶
New in version 12.2.
The PSR-14 event \TYPO3\CMS\Backend\Search\Event\ModifyResultItemInLiveSearchEvent
is available to allow extension developers to take control over search result
items rendered in the backend search.
Example¶
Warning
Some code in this example is experimental API and may change until TYPO3 v12 LTS.
Registration of the event in your extension's Services.yaml:
EXT:my_extension/Configuration/Services.yaml¶
MyVendor\MyExtension\Search\EventListener\AddLiveSearchResultActionsListener:
tags:
- name: event.listener
identifier: 'my-vendor/my-extension/add-live-search-result-actions-listener'
The corresponding event listener class:
EXT:my_extension/Search/EventListener/AddLiveSearchResultActionsListener.php¶
namespace MyVendor\MyExtension\Search\EventListener;
use TYPO3\CMS\Backend\Search\Event\ModifyResultItemInLiveSearchEvent;
use TYPO3\CMS\Backend\Search\LiveSearch\DatabaseRecordProvider;
use TYPO3\CMS\Backend\Search\LiveSearch\ResultItemAction;
use TYPO3\CMS\Core\Imaging\Icon;
use TYPO3\CMS\Core\Imaging\IconFactory;
final class AddLiveSearchResultActionsListener
{
protected LanguageService $languageService;
public function __construct(
protected readonly IconFactory $iconFactory,
protected readonly LanguageServiceFactory $languageServiceFactory,
protected readonly UriBuilder $uriBuilder
) {
$this->languageService = $this->languageServiceFactory->createFromUserPreferences($GLOBALS['BE_USER']);
}
public function __invoke(ModifyResultItemInLiveSearchEvent $event): void
{
$resultItem = $event->getResultItem();
if ($resultItem->getProviderClassName() !== DatabaseRecordProvider::class) {
return;
}
if (($resultItem->getExtraData()['table'] ?? null) === 'tt_content') {
/**
* WARNING: THIS EXAMPLE OMITS ANY ACCESS CHECK FOR SIMPLICITY REASONS - DO NOT USE AS-IS
*/
$showHistoryAction = (new ResultItemAction('view_history'))
->setLabel($this->languageService->sL('LLL:EXT:core/Resources/Private/Language/locallang_mod_web_list.xlf:history'))
->setIcon($this->iconFactory->getIcon('actions-document-history-open', Icon::SIZE_SMALL))
->setUrl((string)$this->uriBuilder->buildUriFromRoute('record_history', [
'element' => $resultItem->getExtraData()['table'] . ':' . $resultItem->getExtraData()['uid']
]));
$resultItem->addAction($showHistoryAction);
}
}
}