FlexForm-Daten sortiert aus einem Select-Feld ausgeben

Wenn man aber eine Select-Box per selectMultipleSideBySide rendert, um dem Plugin eine Selektion von Datensätzen mitzugeben, wird der Wert dieses Feldes in ein String abgespeichert. Dieser String besteht aus kommaseparierten UIDs der ausgewählten Datensätze und zwar in der Reihenfolge, wie sie in dem Select-Feld sortiert wurden (zum Beispiel "4,2,1,3").
Diese Datensätze möchte man nun auch im Frontend genau in dieser Reihenfolge ausgelesen haben und stößt somit auf das Problem, dass keine geeignete Query in Extbase existiert, um dies zu bewerkstelligen.

TYPO3 bringt zum Glück für solche Probleme eine API für Doctrine DBAL mit, die es uns erlaubt mit dem QueryBuilder entsprechende Queries auf die Datenbank loszulassen. Klar könnte man auch den String in ein Array mittels explode teilen und dann für jede enthaltene UID eine einzelne findByUid-Abfrage erstellen, aber darunter würde die Performance leiden.

<?php
declare(strict_types=1);

namespace Vendor\Package\Domain\Repository;

use Vendor\Package\Domain\Model\Item;
use TYPO3\CMS\Core\Database\ConnectionPool;
use TYPO3\CMS\Core\Database\Query\QueryBuilder;
use TYPO3\CMS\Core\Utility\GeneralUtility;
use TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper;

/**
 * ItemRepository
 */
class ItemRepository
{
    private const TABLE = 'tx_package_domain_model_item';

    /**
     * @var DataMapper
     */
    protected DataMapper $dataMapper;

    /**
     * @var QueryBuilder|null
     */
    protected ?QueryBuilder $queryBuilder = null;

    /**
     * Constructor
     */
    public function __construct(DataMapper $dataMapper)
    {
        $this->dataMapper = $dataMapper;
        $this->queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)->getQueryBuilderForTable(self::TABLE);
    }

    /**
     * @param string $uidList
     * @return array
     */
    public function findByUidList(string $uidList): array
    {
        $uids = GeneralUtility::intExplode(',', $uidList, true);
        if (count($uids) === 0) {
            return [];
        }

        $records = $this->queryBuilder
            ->select('*')
            ->from(self::TABLE)
            ->where($this->queryBuilder->expr()->in('uid', $uids))
            ->add('orderBy', 'FIELD(uid,' . implode(',', $uids) . ')')
            ->execute()
            ->fetchAll();

        return $this->dataMapper->map(Item::class, $records);
    }
}

In der Funktion findByUidList wird eine relativ einfache Query um eine orderBy-Anweisung erweitert, in der die UIDs übergeben werden.

Nicht wundern, dass wir am Anfang der Funktion den String erst per explode auseinandernehmen, ihn dann aber für das orderBy per implode zu einem ähnlichen String zusammenfügen. Mit GeneralUtility::intExplode führen wir nicht nur ein explode aus, sondern casten die dort vorkommenden Werte direkt zu Integer, so dass wir sichergehen können, dass sich in dem String nur UIDs befinden. Mit dem dritten Parameter von intExplode werden sogar noch "leere" Werte direkt entfernt.