Feature: #99409 - New PSR-14 BeforeLiveSearchFormIsBuiltEvent

Description

A new PSR-14 event \TYPO3\CMS\Backend\Search\Event\BeforeLiveSearchFormIsBuiltEvent has been added.

To modify the live search form data, the following methods are available:

addHint(): Adds a single hint.
addHints(): Adds one or multiple hints.
setHints(): Sets hints and can be used to reset or overwrite the current ones.
getHints(): Returns all current hints.
getRequest(): Returns the current PSR-7 request.
getSearchDemand(): Returns the SearchDemand used by the live search.
setSearchDemand(): Sets a custom SearchDemand object.
getAdditionalViewData(): Returns the additional view data set to be used in the template.
setAdditionalViewData(): Sets the additional view data to be used in the template.

Note

The method setAdditionalViewData() is useful to provide additional data to the template without the need to cross-class (XCLASS) the controller. The additional view data can then be used in an overridden backend template of the live search form.

Example

The corresponding event listener class:

<?php

namespace MyVendor\MyPackage\Backend\Search\EventListener;

use TYPO3\CMS\Backend\Search\Event\BeforeLiveSearchFormIsBuiltEvent;
use TYPO3\CMS\Core\Attribute\AsEventListener;

final class BeforeLiveSearchFormIsBuiltEventListener
{
    #[AsEventListener(
        identifier: 'my-package/backend/search/modify-live-search-form-data'
    )]
    public function __invoke(BeforeLiveSearchFormIsBuiltEvent $event): void
    {
        $event->addHints(...[
            'my-extension.messages:identifier',
        ]);
    }
}

Impact

With the new PSR-14 event BeforeLiveSearchFormIsBuiltEvent, it is now possible to modify the form data for the backend live search.