Repository.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\Extbase\Persistence;
 
use ‪TYPO3\CMS\Core\SingletonInterface;
use ‪TYPO3\CMS\Core\Utility\ClassNamingUtility;
use ‪TYPO3\CMS\Extbase\Object\ObjectManagerInterface;
use ‪TYPO3\CMS\Extbase\Persistence\Exception\IllegalObjectTypeException;
use ‪TYPO3\CMS\Extbase\Persistence\Generic\Exception\UnsupportedMethodException;
use ‪TYPO3\CMS\Extbase\Persistence\Generic\QuerySettingsInterface;
 
class ‪Repository implements ‪RepositoryInterface, ‪SingletonInterface
{
    protected ‪$persistenceManager;
 
    protected ‪$objectManager;
 
    protected ‪$objectType;
 
    protected ‪$defaultOrderings = [];
 
    protected ‪$defaultQuerySettings;
 
    public function ‪injectPersistenceManager(‪PersistenceManagerInterface ‪$persistenceManager)
    {
        $this->persistenceManager = ‪$persistenceManager;
    }
 
    public function ‪__construct(‪ObjectManagerInterface ‪$objectManager)
    {
        $this->objectManager = ‪$objectManager;
        $this->objectType = ‪ClassNamingUtility::translateRepositoryNameToModelName($this->‪getRepositoryClassName());
    }
 
    public function ‪add($object)
    {
        if (!$object instanceof $this->objectType) {
            throw new IllegalObjectTypeException('The object given to add() was not of the type (' . $this->objectType . ') this repository manages.', 1248363335);
        }
        $this->persistenceManager->add($object);
    }
 
    public function remove($object)
    {
        if (!$object instanceof $this->objectType) {
            throw new IllegalObjectTypeException('The object given to remove() was not of the type (' . $this->objectType . ') this repository manages.', 1248363336);
        }
        $this->persistenceManager->remove($object);
    }
 
    public function ‪update($modifiedObject)
    {
        if (!$modifiedObject instanceof $this->objectType) {
            throw new IllegalObjectTypeException('The modified object given to update() was not of the type (' . $this->objectType . ') this repository manages.', 1249479625);
        }
        $this->persistenceManager->update($modifiedObject);
    }
 
    public function ‪findAll()
    {
        return $this->‪createQuery()->‪execute();
    }
 
    public function ‪countAll()
    {
        return $this->‪createQuery()->‪execute()->count();
    }
 
    public function ‪removeAll()
    {
        foreach ($this->‪findAll() as $object) {
            $this->remove($object);
        }
    }
 
    public function ‪findByUid($uid)
    {
        return $this->‪findByIdentifier($uid);
    }
 
    public function ‪findByIdentifier($identifier)
    {
        return $this->persistenceManager->getObjectByIdentifier($identifier, $this->objectType);
    }
 
    public function ‪setDefaultOrderings(array ‪$defaultOrderings)
    {
        $this->defaultOrderings = ‪$defaultOrderings;
    }
 
    public function ‪setDefaultQuerySettings(QuerySettingsInterface ‪$defaultQuerySettings)
    {
        $this->defaultQuerySettings = ‪$defaultQuerySettings;
    }
 
    public function ‪createQuery()
    {
        $query = $this->persistenceManager->createQueryForType($this->objectType);
        if ($this->defaultOrderings !== []) {
            $query->‪setOrderings($this->defaultOrderings);
        }
        if ($this->defaultQuerySettings !== null) {
            $query->‪setQuerySettings(clone $this->defaultQuerySettings);
        }
        return $query;
    }
 
    public function ‪__call($methodName, $arguments)
    {
        if (strpos($methodName, 'findBy') === 0 && strlen($methodName) > 7) {
            $propertyName = lcfirst(substr($methodName, 6));
            $query = $this->‪createQuery();
            $result = $query->matching($query->equals($propertyName, $arguments[0]))->execute();
            return $result;
        }
        if (strpos($methodName, 'findOneBy') === 0 && strlen($methodName) > 10) {
            $propertyName = lcfirst(substr($methodName, 9));
            $query = $this->‪createQuery();
 
            $result = $query->matching($query->equals($propertyName, $arguments[0]))->setLimit(1)->execute();
            if ($result instanceof QueryResultInterface) {
                return $result->getFirst();
            }
            if (is_array($result)) {
                return $result[0] ?? null;
            }
        } elseif (strpos($methodName, 'countBy') === 0 && strlen($methodName) > 8) {
            $propertyName = lcfirst(substr($methodName, 7));
            $query = $this->‪createQuery();
            $result = $query->matching($query->equals($propertyName, $arguments[0]))->execute()->count();
            return $result;
        }
        throw new UnsupportedMethodException('The method "' . $methodName . '" is not supported by the repository.', 1233180480);
    }
 
    protected function ‪getRepositoryClassName()
    {
        return static::class;
    }
}