ModifyDatabaseQueryForRecordListingEvent¶

Example¶

Registration of the event listener in the extension's Services.yaml:

services:
  # Place here the default dependency injection configuration

  MyVendor\MyExtension\Backend\EventListener\MyEventListener:
    tags:
      - name: event.listener
        identifier: 'my-extension/backend/modify-database-query-for-record-list'

Read how to configure dependency injection in extensions.

The corresponding event listener class:

<?php

declare(strict_types=1);

namespace MyVendor\MyExtension\Backend\EventListener;

use TYPO3\CMS\Backend\View\Event\ModifyDatabaseQueryForRecordListingEvent;

final class MyEventListener
{
    public function __invoke(ModifyDatabaseQueryForRecordListingEvent $event): void
    {
        $queryBuilder = $event->getQueryBuilder();

        // ... do something ...

        $event->setQueryBuilder($queryBuilder);
    }
}

API¶

class \TYPO3\CMS\Backend\View\Event\ ModifyDatabaseQueryForRecordListingEvent¶

Use this Event to alter the database query when loading content for a page (usually in the list module) before it is executed.

getQueryBuilder ( ) ¶

returntype

TYPO3\CMS\Core\Database\Query\QueryBuilder

setQueryBuilder ( TYPO3\\CMS\\Core\\Database\\Query\\QueryBuilder $queryBuilder) ¶

param TYPO3\\CMS\\Core\\Database\\Query\\QueryBuilder $queryBuilder

the queryBuilder

getTable ( ) ¶

returntype

string

getPageId ( ) ¶

returntype

int

getFields ( ) ¶

returntype

array

getFirstResult ( ) ¶

returntype

int

getMaxResults ( ) ¶

returntype

int

getDatabaseRecordList ( ) ¶

returntype

TYPO3\CMS\Backend\RecordList\DatabaseRecordList