src/Core/Framework/DataAbstractionLayer/EntityRepository.php line 91

  1. <?php declare(strict_types=1);
  3. namespace Shopware\Core\Framework\DataAbstractionLayer;
  5. use Shopware\Core\Framework\Adapter\Database\ReplicaConnection;
  6. use Shopware\Core\Framework\Context;
  7. use Shopware\Core\Framework\DataAbstractionLayer\Event\EntityAggregationResultLoadedEvent;
  8. use Shopware\Core\Framework\DataAbstractionLayer\Event\EntityIdSearchResultLoadedEvent;
  9. use Shopware\Core\Framework\DataAbstractionLayer\Event\EntityLoadedEventFactory;
  10. use Shopware\Core\Framework\DataAbstractionLayer\Event\EntitySearchedEvent;
  11. use Shopware\Core\Framework\DataAbstractionLayer\Event\EntitySearchResultLoadedEvent;
  12. use Shopware\Core\Framework\DataAbstractionLayer\Event\EntityWrittenContainerEvent;
  13. use Shopware\Core\Framework\DataAbstractionLayer\Read\EntityReaderInterface;
  14. use Shopware\Core\Framework\DataAbstractionLayer\Search\AggregationResult\AggregationResultCollection;
  15. use Shopware\Core\Framework\DataAbstractionLayer\Search\Criteria;
  16. use Shopware\Core\Framework\DataAbstractionLayer\Search\EntityAggregatorInterface;
  17. use Shopware\Core\Framework\DataAbstractionLayer\Search\EntitySearcherInterface;
  18. use Shopware\Core\Framework\DataAbstractionLayer\Search\EntitySearchResult;
  19. use Shopware\Core\Framework\DataAbstractionLayer\Search\IdSearchResult;
  20. use Shopware\Core\Framework\DataAbstractionLayer\Write\CloneBehavior;
  21. use Shopware\Core\Framework\DataAbstractionLayer\Write\WriteContext;
  22. use Shopware\Core\Framework\Log\Package;
  23. use Shopware\Core\Framework\Struct\ArrayEntity;
  24. use Shopware\Core\Framework\Uuid\Exception\InvalidUuidException;
  25. use Shopware\Core\Framework\Uuid\Uuid;
  26. use Shopware\Core\Profiling\Profiler;
  27. use Symfony\Component\EventDispatcher\EventDispatcherInterface;
  29. /**
  30.  * @final
  31.  */
  32. #[Package('core')]
  33. class EntityRepository
  34. {
  35.     /**
  36.      * @internal
  37.      */
  38.     public function __construct(private readonly EntityDefinition $definition, private readonly EntityReaderInterface $reader, private readonly VersionManager $versionManager, private readonly EntitySearcherInterface $searcher, private readonly EntityAggregatorInterface $aggregator, private readonly EventDispatcherInterface $eventDispatcher, private readonly EntityLoadedEventFactory $eventFactory)
  39.     {
  40.     }
  42.     public function getDefinition(): EntityDefinition
  43.     {
  44.         return $this->definition;
  45.     }
  47.     public function search(Criteria $criteria, Context $context): EntitySearchResult
  48.     {
  49.         if (!$criteria->getTitle()) {
  50.             return $this->_search($criteria, $context);
  51.         }
  53.         return Profiler::trace($criteria->getTitle(), fn () => $this->_search($criteria, $context), 'repository');
  54.     }
  56.     public function aggregate(Criteria $criteria, Context $context): AggregationResultCollection
  57.     {
  58.         $criteria = clone $criteria;
  60.         $result = $this->aggregator->aggregate($this->definition, $criteria, $context);
  62.         $event = new EntityAggregationResultLoadedEvent($this->definition, $result, $context);
  63.         $this->eventDispatcher->dispatch($event, $event->getName());
  65.         return $result;
  66.     }
  68.     public function searchIds(Criteria $criteria, Context $context): IdSearchResult
  69.     {
  70.         $criteria = clone $criteria;
  72.         $this->eventDispatcher->dispatch(new EntitySearchedEvent($criteria, $this->definition, $context));
  74.         $result = $this->searcher->search($this->definition, $criteria, $context);
  76.         $event = new EntityIdSearchResultLoadedEvent($this->definition, $result);
  77.         $this->eventDispatcher->dispatch($event, $event->getName());
  79.         return $result;
  80.     }
  82.     /**
  83.      * @param array<array<string, mixed|null>> $data
  84.      */
  85.     public function update(array $data, Context $context): EntityWrittenContainerEvent
  86.     {
  87.         ReplicaConnection::ensurePrimary();
  89.         $affected = $this->versionManager->update($this->definition, $data, WriteContext::createFromContext($context));
  90.         $event = EntityWrittenContainerEvent::createWithWrittenEvents($affected, $context, []);
  91.         $this->eventDispatcher->dispatch($event);
  93.         return $event;
  94.     }
  96.     /**
  97.      * @param array<array<string, mixed|null>> $data
  98.      */
  99.     public function upsert(array $data, Context $context): EntityWrittenContainerEvent
  100.     {
  101.         ReplicaConnection::ensurePrimary();
  103.         $affected = $this->versionManager->upsert($this->definition, $data, WriteContext::createFromContext($context));
  104.         $event = EntityWrittenContainerEvent::createWithWrittenEvents($affected, $context, []);
  105.         $this->eventDispatcher->dispatch($event);
  107.         return $event;
  108.     }
  110.     /**
  111.      * @param array<array<string, mixed|null>> $data
  112.      */
  113.     public function create(array $data, Context $context): EntityWrittenContainerEvent
  114.     {
  115.         ReplicaConnection::ensurePrimary();
  117.         $affected = $this->versionManager->insert($this->definition, $data, WriteContext::createFromContext($context));
  118.         $event = EntityWrittenContainerEvent::createWithWrittenEvents($affected, $context, []);
  119.         $this->eventDispatcher->dispatch($event);
  121.         return $event;
  122.     }
  124.     /**
  125.      * @param array<array<string, mixed|null>> $ids
  126.      */
  127.     public function delete(array $ids, Context $context): EntityWrittenContainerEvent
  128.     {
  129.         ReplicaConnection::ensurePrimary();
  131.         $affected = $this->versionManager->delete($this->definition, $ids, WriteContext::createFromContext($context));
  132.         $event = EntityWrittenContainerEvent::createWithDeletedEvents($affected->getDeleted(), $context, $affected->getNotFound());
  134.         if ($affected->getWritten()) {
  135.             $updates = EntityWrittenContainerEvent::createWithWrittenEvents($affected->getWritten(), $context, []);
  137.             if ($updates->getEvents() !== null) {
  138.                 $event->addEvent(...$updates->getEvents());
  139.             }
  140.         }
  142.         $this->eventDispatcher->dispatch($event);
  144.         return $event;
  145.     }
  147.     public function createVersion(string $id, Context $context, ?string $name = null, ?string $versionId = null): string
  148.     {
  149.         ReplicaConnection::ensurePrimary();
  151.         if (!$this->definition->isVersionAware()) {
  152.             throw new \RuntimeException(sprintf('Entity %s is not version aware', $this->definition->getEntityName()));
  153.         }
  155.         return $this->versionManager->createVersion($this->definition, $id, WriteContext::createFromContext($context), $name, $versionId);
  156.     }
  158.     public function merge(string $versionId, Context $context): void
  159.     {
  160.         ReplicaConnection::ensurePrimary();
  162.         if (!$this->definition->isVersionAware()) {
  163.             throw new \RuntimeException(sprintf('Entity %s is not version aware', $this->definition->getEntityName()));
  164.         }
  165.         $this->versionManager->merge($versionId, WriteContext::createFromContext($context));
  166.     }
  168.     public function clone(string $id, Context $context, ?string $newId = null, ?CloneBehavior $behavior = null): EntityWrittenContainerEvent
  169.     {
  170.         ReplicaConnection::ensurePrimary();
  172.         $newId ??= Uuid::randomHex();
  173.         if (!Uuid::isValid($newId)) {
  174.             throw new InvalidUuidException($newId);
  175.         }
  177.         $affected = $this->versionManager->clone(
  178.             $this->definition,
  179.             $id,
  180.             $newId,
  181.             $context->getVersionId(),
  182.             WriteContext::createFromContext($context),
  183.             $behavior ?? new CloneBehavior()
  184.         );
  186.         $event = EntityWrittenContainerEvent::createWithWrittenEvents($affected, $context, [], true);
  187.         $this->eventDispatcher->dispatch($event);
  189.         return $event;
  190.     }
  192.     /**
  193.      * @return EntityCollection<Entity>
  194.      */
  195.     private function read(Criteria $criteria, Context $context): EntityCollection
  196.     {
  197.         $criteria = clone $criteria;
  199.         $entities = $this->reader->read($this->definition, $criteria, $context);
  201.         if ($criteria->getFields() === []) {
  202.             $event = $this->eventFactory->create($entities->getElements(), $context);
  203.         } else {
  204.             $event = $this->eventFactory->createPartial($entities->getElements(), $context);
  205.         }
  207.         $this->eventDispatcher->dispatch($event);
  209.         return $entities;
  210.     }
  212.     private function _search(Criteria $criteria, Context $context): EntitySearchResult
  213.     {
  214.         $criteria = clone $criteria;
  215.         $aggregations = null;
  216.         if ($criteria->getAggregations()) {
  217.             $aggregations = $this->aggregate($criteria, $context);
  218.         }
  220.         if (!RepositorySearchDetector::isSearchRequired($this->definition, $criteria)) {
  221.             $this->eventDispatcher->dispatch(
  222.                 new EntitySearchedEvent($criteria, $this->definition, $context)
  223.             );
  224.             $entities = $this->read($criteria, $context);
  226.             return new EntitySearchResult($this->definition->getEntityName(), $entities->count(), $entities, $aggregations, $criteria, $context);
  227.         }
  229.         $ids = $this->searchIds($criteria, $context);
  231.         if (empty($ids->getIds())) {
  232.             /** @var EntityCollection<Entity> $collection */
  233.             $collection = $this->definition->getCollectionClass();
  235.             return new EntitySearchResult($this->definition->getEntityName(), $ids->getTotal(), new $collection(), $aggregations, $criteria, $context);
  236.         }
  238.         $readCriteria = $criteria->cloneForRead($ids->getIds());
  240.         $entities = $this->read($readCriteria, $context);
  242.         $search = $ids->getData();
  244.         /** @var Entity $element */
  245.         foreach ($entities as $element) {
  246.             if (!\array_key_exists($element->getUniqueIdentifier(), $search)) {
  247.                 continue;
  248.             }
  250.             $data = $search[$element->getUniqueIdentifier()];
  251.             unset($data['id']);
  253.             if (empty($data)) {
  254.                 continue;
  255.             }
  257.             $element->addExtension('search', new ArrayEntity($data));
  258.         }
  260.         $result = new EntitySearchResult($this->definition->getEntityName(), $ids->getTotal(), $entities, $aggregations, $criteria, $context);
  261.         $result->addState(...$ids->getStates());
  263.         $event = new EntitySearchResultLoadedEvent($this->definition, $result);
  264.         $this->eventDispatcher->dispatch($event, $event->getName());
  266.         return $result;
  267.     }
  268. }