AbstractRepository.php

Go to the documentation of this file.

<?php
 
/*
 * 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\Core\Resource;
 
use ‪TYPO3\CMS\Core\Database\Connection;
use ‪TYPO3\CMS\Core\Database\ConnectionPool;
use ‪TYPO3\CMS\Core\Database\Query\Restriction\FrontendRestrictionContainer;
use ‪TYPO3\CMS\Core\SingletonInterface;
use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
use ‪TYPO3\CMS\Core\Utility\MathUtility;
use ‪TYPO3\CMS\Extbase\Persistence\Generic\QuerySettingsInterface;
use ‪TYPO3\CMS\Extbase\Persistence\RepositoryInterface;
use ‪TYPO3\CMS\Frontend\Controller\TypoScriptFrontendController;
 
abstract class ‪AbstractRepository implements ‪RepositoryInterface, ‪SingletonInterface
{
    protected ‪$table = '';
 
    protected ‪$factory;
 
    protected ‪$typeField = '';
 
    protected ‪$type = '';
 
    protected ‪$objectType;
 
    public function ‪__construct()
    {
        $this->factory = GeneralUtility::makeInstance(ResourceFactory::class);
    }
 
    public function ‪add($object)
    {
    }
 
    public function remove($object)
    {
    }
 
    public function ‪replace($existingObject, $newObject)
    {
    }
 
    public function ‪update($modifiedObject)
    {
    }
 
    public function ‪getAddedObjects()
    {
        return [];
    }
 
    public function ‪getRemovedObjects()
    {
        return [];
    }
 
    public function ‪findAll()
    {
        $items = [];
        $queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)->getQueryBuilderForTable($this->table);
        if ($this->‪getEnvironmentMode() === 'FE') {
            $queryBuilder->setRestrictions(GeneralUtility::makeInstance(FrontendRestrictionContainer::class));
        }
        $queryBuilder
            ->select('*')
            ->from($this->table);
 
        if (!empty($this->type)) {
            $queryBuilder->where(
                $queryBuilder->expr()->eq(
                    $this->typeField,
                    $queryBuilder->createNamedParameter($this->type)
                )
            );
        }
        $result = $queryBuilder->executeQuery();
 
        // fetch all records and create objects out of them
        while ($row = $result->fetchAssociative()) {
            $items[] = $this->‪createDomainObject($row);
        }
        return $items;
    }
 
    abstract protected function ‪createDomainObject(array $databaseRow);
 
    public function ‪countAll()
    {
        return 0;
    }
 
    public function ‪removeAll()
    {
    }
 
    public function ‪findByUid(‪$uid)
    {
        if (!‪MathUtility::canBeInterpretedAsInteger(‪$uid)) {
            throw new \InvalidArgumentException('The UID has to be an integer. UID given: "' . ‪$uid . '"', 1316779798);
        }
        $queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)->getQueryBuilderForTable($this->table);
        if ($this->‪getEnvironmentMode() === 'FE') {
            $queryBuilder->setRestrictions(GeneralUtility::makeInstance(FrontendRestrictionContainer::class));
        }
        $row = $queryBuilder
            ->select('*')
            ->from($this->table)
            ->where(
                $queryBuilder->expr()->eq('uid', $queryBuilder->createNamedParameter(‪$uid, ‪Connection::PARAM_INT))
            )
            ->executeQuery()
            ->fetchAssociative();
        if (!is_array($row)) {
            throw new \RuntimeException('Could not find row with UID "' . ‪$uid . '" in table "' . $this->table . '"', 1314354065);
        }
        return $this->‪createDomainObject($row);
    }
 
    public function ‪setDefaultOrderings(array $defaultOrderings)
    {
        throw new \BadMethodCallException('Repository does not support the setDefaultOrderings() method.', 1313185906);
    }
 
    public function ‪setDefaultQuerySettings(QuerySettingsInterface $defaultQuerySettings)
    {
        throw new \BadMethodCallException('Repository does not support the setDefaultQuerySettings() method.', 1313185907);
    }
 
    public function ‪createQuery()
    {
        throw new \BadMethodCallException('Repository does not support the createQuery() method.', 1313185908);
    }
 
    public function ‪findByIdentifier(‪$identifier)
    {
        return $this->‪findByUid(‪$identifier);
    }
 
    public function ‪__call($method, $arguments)
    {
        throw new \BadMethodCallException('Repository method "' . $method . '" is not implemented.', 1378918410);
    }
 
    public function ‪getEntityClassName()
    {
        return ‪$this->objectType;
    }
 
    protected function ‪getEnvironmentMode()
    {
        return (‪$GLOBALS['TSFE'] ?? null) instanceof TypoScriptFrontendController ? 'FE' : 'BE';
    }
}