PersistenceManager.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\Extbase\Persistence\Generic;
 
use ‪TYPO3\CMS\Core\SingletonInterface;
use ‪TYPO3\CMS\Extbase\Persistence\Exception\UnknownObjectException;
use ‪TYPO3\CMS\Extbase\Persistence\ObjectStorage;
use ‪TYPO3\CMS\Extbase\Persistence\PersistenceManagerInterface;
use ‪TYPO3\CMS\Extbase\Persistence\QueryInterface;
 
class ‪PersistenceManager implements ‪PersistenceManagerInterface, ‪SingletonInterface
{
    protected array ‪$newObjects = [];
    protected ‪ObjectStorage ‪$changedObjects;
    protected ‪ObjectStorage ‪$addedObjects;
    protected ‪ObjectStorage ‪$removedObjects;
    protected ‪QueryFactoryInterface ‪$queryFactory;
    protected ‪BackendInterface ‪$backend;
    protected ‪Session ‪$persistenceSession;
 
    public function ‪__construct(
        ‪QueryFactoryInterface ‪$queryFactory,
        ‪BackendInterface ‪$backend,
        ‪Session ‪$persistenceSession
    ) {
        $this->queryFactory = ‪$queryFactory;
        $this->backend = ‪$backend;
        $this->persistenceSession = ‪$persistenceSession;
 
        $this->addedObjects = new ‪ObjectStorage();
        $this->removedObjects = new ‪ObjectStorage();
        $this->changedObjects = new ‪ObjectStorage();
    }
 
    public function ‪registerRepositoryClassName(string $className): void {}
 
    public function ‪getObjectCountByQuery(‪QueryInterface $query): int
    {
        return $this->backend->getObjectCountByQuery($query);
    }
 
    public function ‪getObjectDataByQuery(‪QueryInterface $query): array
    {
        return $this->backend->getObjectDataByQuery($query);
    }
 
    public function ‪getIdentifierByObject(object $object): ?string
    {
        return $this->backend->getIdentifierByObject($object);
    }
 
    public function ‪getObjectByIdentifier(string|int ‪$identifier, ?string $objectType = null, bool $useLazyLoading = false): ?object
    {
        if (isset($this->newObjects[‪$identifier])) {
            return $this->newObjects[‪$identifier];
        }
        if ($this->persistenceSession->hasIdentifier((string)‪$identifier, $objectType)) {
            return $this->persistenceSession->getObjectByIdentifier((string)‪$identifier, $objectType);
        }
        return $this->backend->getObjectByIdentifier((string)‪$identifier, $objectType);
    }
 
    public function ‪persistAll(): void
    {
        // hand in only aggregate roots, leaving handling of subobjects to
        // the underlying storage layer
        // reconstituted entities must be fetched from the session and checked
        // for changes by the underlying backend as well!
        $this->backend->setAggregateRootObjects($this->addedObjects);
        $this->backend->setChangedEntities($this->changedObjects);
        $this->backend->setDeletedEntities($this->removedObjects);
        $this->backend->commit();
 
        $this->addedObjects = new ‪ObjectStorage();
        $this->removedObjects = new ‪ObjectStorage();
        $this->changedObjects = new ‪ObjectStorage();
    }
 
    public function ‪createQueryForType(string $type): ‪QueryInterface
    {
        return $this->queryFactory->create($type);
    }
 
    public function ‪add(object $object): void
    {
        $this->addedObjects->attach($object);
        $this->removedObjects->detach($object);
    }
 
    public function remove(object $object): void
    {
        if ($this->addedObjects->contains($object)) {
            $this->addedObjects->detach($object);
        } else {
            $this->removedObjects->attach($object);
        }
    }
 
    public function ‪update(object $object): void
    {
        if ($this->‪isNewObject($object)) {
            throw new ‪UnknownObjectException('The object of type "' . get_class($object) . '" given to update must be persisted already, but is new.', 1249479819);
        }
        $this->changedObjects->attach($object);
    }
 
    public function ‪initializeObject(): void
    {
        $this->backend->setPersistenceManager($this);
    }
 
    public function ‪clearState(): void
    {
        $this->newObjects = [];
        $this->addedObjects = new ‪ObjectStorage();
        $this->removedObjects = new ‪ObjectStorage();
        $this->changedObjects = new ‪ObjectStorage();
        $this->persistenceSession->destroy();
    }
 
    public function ‪isNewObject(object $object): bool
    {
        return $this->persistenceSession->hasObject($object) === false;
    }
 
    public function ‪registerNewObject(object $object): void
    {
        ‪$identifier = $this->‪getIdentifierByObject($object);
        $this->newObjects[‪$identifier] = $object;
    }
 
    public function ‪tearDown(): void
    {
        if (method_exists($this->backend, 'tearDown')) {
            $this->backend->tearDown();
        }
    }
}