Feature: #105833 - Extended page tree filter functionality
See forge#105833
Description
The page tree is one of the central components in the TYPO3 backend, particularly for editors. However, in large installations, the page tree can quickly become overwhelming and difficult to navigate. To maintain a clear overview, the page tree can be filtered using basic terms, such as the page title or ID.
To enhance the filtering capabilities, the new PSR-14 event
\TYPO3\
has been introduced. This event allows developers to extend the filter
functionality and process the given search phrase in more advanced ways.
Using this event, it is for example possible to evaluate a given URL or to
add additional field matchings, such as filtering pages by their
doktype or their configured backend layout.
The event provides the following public properties:
$search:Parts - The search parts to be used for filtering
$search:Uids - The uids to be used for filtering by a special search part, which is added by Core always after listener evaluation
$searchPhrase - The complete search phrase, as entered by the user
$query:Builder - The current
Queryinstance to provide context and to be used to create search partsBuilder
Important
The
Query instance is
provided solely for context and to simplify the creation of search parts
by using the
Expression
via
$query. The instance itself must not be
modified by event listeners and is not considered part of the public API.
TYPO3 reserves the right to change the instance at any time without prior
notice.
Example
The following event listener class demonstrates how to add additional
conditions to the page tree filter using the PHP attribute
# for registration.
use TYPO3\CMS\Backend\Tree\Repository\BeforePageTreeIsFilteredEvent;
use TYPO3\CMS\Core\Attribute\AsEventListener;
use TYPO3\CMS\Core\Database\Connection;
final class MyEventListener
{
#[AsEventListener]
public function removeFetchedPageContent(BeforePageTreeIsFilteredEvent $event): void
{
// Add an additional UID to the filter
$event->searchUids[] = 123;
// Add evaluation of doktypes to the filter
if (preg_match('/doktype:([0-9]+)/i', $event->searchPhrase, $match)) {
$doktype = $match[1];
$event->searchParts = $event->searchParts->with(
$event->queryBuilder->expr()->eq(
'doktype',
$event->queryBuilder->createNamedParameter($doktype, Connection::PARAM_INT)
)
);
}
}
}
Impact
With the new PSR-14 event
Before,
custom functionality and advanced evaluations can now be added to enhance the
page tree filter.