ReactionRepository.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
/*
 * This file is part of the TYPO3 CMS project.
 *
 * It is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License, either version 2
 * of the License, or any later version.
 *
 * For the full copyright and license information, please read the
 * LICENSE.txt file that was distributed with this source code.
 *
 * The TYPO3 project - inspiring people to share!
 */
 
namespace ‪TYPO3\CMS\Reactions\Repository;
 
use TYPO3\CMS\Backend\Utility\BackendUtility;
use ‪TYPO3\CMS\Core\Database\ConnectionPool;
use TYPO3\CMS\Core\Database\Query\QueryBuilder;
use ‪TYPO3\CMS\Core\Database\Query\Restriction\DeletedRestriction;
use ‪TYPO3\CMS\Core\Database\Query\Restriction\EndTimeRestriction;
use ‪TYPO3\CMS\Core\Database\Query\Restriction\HiddenRestriction;
use ‪TYPO3\CMS\Core\Database\Query\Restriction\StartTimeRestriction;
use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
use ‪TYPO3\CMS\Reactions\Model\ReactionInstruction;
 
class ‪ReactionRepository
{
    public function ‪findAll(): array
    {
        return $this->‪map($this->‪getQueryBuilder()
            ->executeQuery()
            ->fetchAllAssociative());
    }
 
    public function ‪countAll(): int
    {
        return (int)$this->‪getQueryBuilder(false)
            ->count('*')
            ->executeQuery()
            ->fetchOne();
    }
 
    public function ‪getReactionRecords(?‪ReactionDemand $demand = null): array
    {
        return $demand !== null ? $this->‪findByDemand($demand) : $this->‪findAll();
    }
 
    public function ‪getReactionRecordByIdentifier(string ‪$identifier): ?‪ReactionInstruction
    {
        $queryBuilder = $this->‪getQueryBuilder();
        $queryBuilder
            ->getRestrictions()
            ->add(GeneralUtility::makeInstance(HiddenRestriction::class))
            ->add(GeneralUtility::makeInstance(StartTimeRestriction::class))
            ->add(GeneralUtility::makeInstance(EndTimeRestriction::class));
        $result = $queryBuilder
            ->where(
                $queryBuilder->expr()->eq('identifier', $queryBuilder->createNamedParameter(‪$identifier))
            )
            ->executeQuery()
            ->fetchAssociative();
        if (!empty($result)) {
            return $this->‪mapSingleRow($result);
        }
        return null;
    }
 
    public function ‪findByDemand(‪ReactionDemand $demand): array
    {
        return $this->‪map($this->‪getQueryBuilderForDemand($demand)
            ->setMaxResults($demand->‪getLimit())
            ->setFirstResult($demand->‪getOffset())
            ->executeQuery()
            ->fetchAllAssociative());
    }
 
    protected function ‪getQueryBuilderForDemand(‪ReactionDemand $demand): QueryBuilder
    {
        $queryBuilder = $this->‪getQueryBuilder(false);
        $queryBuilder->orderBy(
            $demand->‪getOrderField(),
            $demand->‪getOrderDirection()
        );
        // Ensure deterministic ordering.
        if ($demand->‪getOrderField() !== 'uid') {
            $queryBuilder->addOrderBy('uid', 'asc');
        }
 
        $constraints = [];
        if ($demand->‪hasName()) {
            $escapedLikeString = '%' . $queryBuilder->escapeLikeWildcards($demand->‪getName()) . '%';
            $constraints[] = $queryBuilder->expr()->like(
                'name',
                $queryBuilder->createNamedParameter($escapedLikeString)
            );
        }
        if ($demand->‪hasReactionType()) {
            $constraints[] = $queryBuilder->expr()->eq(
                'reaction_type',
                $queryBuilder->createNamedParameter($demand->‪getReactionType())
            );
        }
 
        if (!empty($constraints)) {
            $queryBuilder->where(...$constraints);
        }
        return $queryBuilder;
    }
 
    protected function ‪map(array $rows): array
    {
        $items = [];
        foreach ($rows as $row) {
            $items[] = $this->‪mapSingleRow($row);
        }
        return $items;
    }
 
    protected function ‪mapSingleRow(array $row): ‪ReactionInstruction
    {
        $row = BackendUtility::convertDatabaseRowValuesToPhp('sys_reaction', $row);
        return new ‪ReactionInstruction($row);
    }
 
    protected function ‪getQueryBuilder(bool $addDefaultOrderByClause = true): QueryBuilder
    {
        // @todo ConnectionPool could be injected
        $queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)
            ->getQueryBuilderForTable('sys_reaction');
        $queryBuilder->getRestrictions()
            ->removeAll()
            ->add(GeneralUtility::makeInstance(DeletedRestriction::class));
        $queryBuilder->select('*')->from('sys_reaction');
        if ($addDefaultOrderByClause) {
            $queryBuilder
                ->orderBy('name', 'asc')
                // Ensure deterministic ordering.
                ->addOrderBy('uid', 'asc');
        }
        return $queryBuilder;
    }
}