AbstractRepository.php

Go to the documentation of this file.

<?php
namespace TYPO3\CMS\Core\Resource;

/*
 * 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!
 */

abstract class AbstractRepository implements \TYPO3\CMS\Extbase\Persistence\RepositoryInterface, \TYPO3\CMS\Core\SingletonInterface
{
    protected $table = '';

    protected $factory;

    protected $typeField = '';

    protected $type = '';

    public function __construct()
    {
        $this->factory = \TYPO3\CMS\Core\Utility\GeneralUtility::makeInstance(\TYPO3\CMS\Core\Resource\ResourceFactory::class);
    }

    public function add($object)
    {
    }

    public function remove($object)
    {
    }

    public function replace($existingObject, $newObject)
    {
    }

    public function update($modifiedObject)
    {
    }

    public function getAddedObjects()
    {
    }

    public function getRemovedObjects()
    {
    }

    public function findAll()
    {
        $itemList = [];
        $whereClause = '1=1';
        if ($this->type != '') {
            $whereClause .= ' AND ' . $this->typeField . ' = ' . $GLOBALS['TYPO3_DB']->fullQuoteStr($this->type, $this->table) . ' ';
        }
        $whereClause .= $this->getWhereClauseForEnabledFields();
        $res = $GLOBALS['TYPO3_DB']->exec_SELECTquery('*', $this->table, $whereClause);
        while ($row = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($res)) {
            $itemList[] = $this->createDomainObject($row);
        }
        $GLOBALS['TYPO3_DB']->sql_free_result($res);
        return $itemList;
    }

    abstract protected function createDomainObject(array $databaseRow);

    public function countAll()
    {
    }

    public function removeAll()
    {
    }

    public function findByUid($uid)
    {
        if (!\TYPO3\CMS\Core\Utility\MathUtility::canBeInterpretedAsInteger($uid)) {
            throw new \InvalidArgumentException('The UID has to be an integer. UID given: "' . $uid . '"', 1316779798);
        }
        $row = $GLOBALS['TYPO3_DB']->exec_SELECTgetSingleRow('*', $this->table, 'uid=' . (int)$uid . $this->getWhereClauseForEnabledFields());
        if (empty($row) || !is_array($row)) {
            throw new \RuntimeException('Could not find row with UID "' . $uid . '" in table "' . $this->table . '"', 1314354065);
        }
        return $this->createDomainObject($row);
    }

    protected function getWhereClauseForEnabledFields()
    {
        if ($this->getEnvironmentMode() === 'FE' && $GLOBALS['TSFE']->sys_page) {
            // frontend context
            $whereClause = $GLOBALS['TSFE']->sys_page->enableFields($this->table);
            $whereClause .= $GLOBALS['TSFE']->sys_page->deleteClause($this->table);
        } else {
            // backend context
            $whereClause = \TYPO3\CMS\Backend\Utility\BackendUtility::BEenableFields($this->table);
            $whereClause .= \TYPO3\CMS\Backend\Utility\BackendUtility::deleteClause($this->table);
        }
        return $whereClause;
    }

    public function setDefaultOrderings(array $defaultOrderings)
    {
        throw new \BadMethodCallException('Repository does not support the setDefaultOrderings() method.', 1313185906);
    }

    public function setDefaultQuerySettings(\TYPO3\CMS\Extbase\Persistence\Generic\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 TYPO3_MODE;
    }

    protected function getDatabaseConnection()
    {
        return $GLOBALS['TYPO3_DB'];
    }
}