vendor/shopware/platform/src/Core/Framework/DataAbstractionLayer/EntityRepository.php line 115

Open in your IDE?
  1. <?php declare(strict_types=1);
  3. namespace Shopware\Core\Framework\DataAbstractionLayer;
  5. use Shopware\Core\Framework\Context;
  6. use Shopware\Core\Framework\DataAbstractionLayer\Event\EntityAggregationResultLoadedEvent;
  7. use Shopware\Core\Framework\DataAbstractionLayer\Event\EntityIdSearchResultLoadedEvent;
  8. use Shopware\Core\Framework\DataAbstractionLayer\Event\EntityLoadedEventFactory;
  9. use Shopware\Core\Framework\DataAbstractionLayer\Event\EntitySearchedEvent;
  10. use Shopware\Core\Framework\DataAbstractionLayer\Event\EntitySearchResultLoadedEvent;
  11. use Shopware\Core\Framework\DataAbstractionLayer\Event\EntityWrittenContainerEvent;
  12. use Shopware\Core\Framework\DataAbstractionLayer\Read\EntityReaderInterface;
  13. use Shopware\Core\Framework\DataAbstractionLayer\Search\AggregationResult\AggregationResultCollection;
  14. use Shopware\Core\Framework\DataAbstractionLayer\Search\Criteria;
  15. use Shopware\Core\Framework\DataAbstractionLayer\Search\EntityAggregatorInterface;
  16. use Shopware\Core\Framework\DataAbstractionLayer\Search\EntitySearcherInterface;
  17. use Shopware\Core\Framework\DataAbstractionLayer\Search\EntitySearchResult;
  18. use Shopware\Core\Framework\DataAbstractionLayer\Search\IdSearchResult;
  19. use Shopware\Core\Framework\DataAbstractionLayer\Write\CloneBehavior;
  20. use Shopware\Core\Framework\DataAbstractionLayer\Write\WriteContext;
  21. use Shopware\Core\Framework\Feature;
  22. use Shopware\Core\Framework\Struct\ArrayEntity;
  23. use Shopware\Core\Framework\Uuid\Exception\InvalidUuidException;
  24. use Shopware\Core\Framework\Uuid\Uuid;
  25. use Symfony\Component\EventDispatcher\EventDispatcherInterface;
  27. class EntityRepository implements EntityRepositoryInterface
  28. {
  29.     /**
  30.      * @var EntityReaderInterface
  31.      */
  32.     private $reader;
  34.     /**
  35.      * @var EntitySearcherInterface
  36.      */
  37.     private $searcher;
  39.     /**
  40.      * @var EntityAggregatorInterface
  41.      */
  42.     private $aggregator;
  44.     /**
  45.      * @var EventDispatcherInterface
  46.      */
  47.     private $eventDispatcher;
  49.     /**
  50.      * @var VersionManager
  51.      */
  52.     private $versionManager;
  54.     /**
  55.      * @var EntityDefinition
  56.      */
  57.     private $definition;
  59.     private ?EntityLoadedEventFactory $eventFactory;
  61.     public function __construct(
  62.         EntityDefinition $definition,
  63.         EntityReaderInterface $reader,
  64.         VersionManager $versionManager,
  65.         EntitySearcherInterface $searcher,
  66.         EntityAggregatorInterface $aggregator,
  67.         EventDispatcherInterface $eventDispatcher,
  68.         ?EntityLoadedEventFactory $eventFactory = null
  69.     ) {
  70.         $this->reader = $reader;
  71.         $this->searcher = $searcher;
  72.         $this->aggregator = $aggregator;
  73.         $this->eventDispatcher = $eventDispatcher;
  74.         $this->versionManager = $versionManager;
  75.         $this->definition = $definition;
  77.         if ($eventFactory !== null) {
  78.             $this->eventFactory = $eventFactory;
  79.         } else {
  80.             Feature::throwException('FEATURE_NEXT_16155', sprintf('Repository for definition %s requires the event factory as __construct parameter', $definition->getEntityName()));
  81.         }
  82.     }
  84.     /**
  85.      * @deprecated tag:v6.5.0 - Will be removed, inject entity loaded event factory in __construct
  86.      */
  87.     public function setEntityLoadedEventFactory(EntityLoadedEventFactory $eventFactory): void
  88.     {
  89.         if (isset($this->eventFactory)) {
  90.             return;
  91.         }
  93.         Feature::throwException('FEATURE_NEXT_16155', sprintf('Repository for definition %s requires the event factory as __construct parameter', $this->definition->getEntityName()));
  95.         $this->eventFactory = $eventFactory;
  96.     }
  98.     public function getDefinition(): EntityDefinition
  99.     {
  100.         return $this->definition;
  101.     }
  103.     public function search(Criteria $criteria, Context $context): EntitySearchResult
  104.     {
  105.         $criteria = clone $criteria;
  106.         $aggregations = null;
  107.         if ($criteria->getAggregations()) {
  108.             $aggregations = $this->aggregate($criteria, $context);
  109.         }
  111.         if (!RepositorySearchDetector::isSearchRequired($this->definition, $criteria)) {
  112.             $this->eventDispatcher->dispatch(
  113.                 new EntitySearchedEvent($criteria, $this->definition, $context)
  114.             );
  115.             $entities = $this->read($criteria, $context);
  117.             return new EntitySearchResult($this->definition->getEntityName(), $entities->count(), $entities, $aggregations, $criteria, $context);
  118.         }
  120.         $ids = $this->searchIds($criteria, $context);
  122.         if (empty($ids->getIds())) {
  123.             $collection = $this->definition->getCollectionClass();
  125.             return new EntitySearchResult($this->definition->getEntityName(), $ids->getTotal(), new $collection(), $aggregations, $criteria, $context);
  126.         }
  128.         $readCriteria = $criteria->cloneForRead($ids->getIds());
  130.         $entities = $this->read($readCriteria, $context);
  132.         $search = $ids->getData();
  134.         /** @var Entity $element */
  135.         foreach ($entities as $element) {
  136.             if (!\array_key_exists($element->getUniqueIdentifier(), $search)) {
  137.                 continue;
  138.             }
  140.             $data = $search[$element->getUniqueIdentifier()];
  141.             unset($data['id']);
  143.             if (empty($data)) {
  144.                 continue;
  145.             }
  147.             $element->addExtension('search', new ArrayEntity($data));
  148.         }
  150.         $result = new EntitySearchResult($this->definition->getEntityName(), $ids->getTotal(), $entities, $aggregations, $criteria, $context);
  151.         $result->addState(...$ids->getStates());
  153.         $event = new EntitySearchResultLoadedEvent($this->definition, $result);
  154.         $this->eventDispatcher->dispatch($event, $event->getName());
  156.         return $result;
  157.     }
  159.     public function aggregate(Criteria $criteria, Context $context): AggregationResultCollection
  160.     {
  161.         $criteria = clone $criteria;
  163.         $result = $this->aggregator->aggregate($this->definition, clone $criteria, $context);
  165.         $event = new EntityAggregationResultLoadedEvent($this->definition, $result, $context);
  166.         $this->eventDispatcher->dispatch($event, $event->getName());
  168.         return $result;
  169.     }
  171.     public function searchIds(Criteria $criteria, Context $context): IdSearchResult
  172.     {
  173.         $criteria = clone $criteria;
  175.         $this->eventDispatcher->dispatch(
  176.             new EntitySearchedEvent($criteria, $this->definition, $context)
  177.         );
  179.         $result = $this->searcher->search($this->definition, $criteria, $context);
  181.         $event = new EntityIdSearchResultLoadedEvent($this->definition, $result);
  182.         $this->eventDispatcher->dispatch($event, $event->getName());
  184.         return $result;
  185.     }
  187.     public function update(array $data, Context $context): EntityWrittenContainerEvent
  188.     {
  189.         $affected = $this->versionManager->update($this->definition, $data, WriteContext::createFromContext($context));
  190.         $event = EntityWrittenContainerEvent::createWithWrittenEvents($affected, $context, []);
  191.         $this->eventDispatcher->dispatch($event);
  193.         return $event;
  194.     }
  196.     public function upsert(array $data, Context $context): EntityWrittenContainerEvent
  197.     {
  198.         $affected = $this->versionManager->upsert($this->definition, $data, WriteContext::createFromContext($context));
  199.         $event = EntityWrittenContainerEvent::createWithWrittenEvents($affected, $context, []);
  200.         $this->eventDispatcher->dispatch($event);
  202.         return $event;
  203.     }
  205.     public function create(array $data, Context $context): EntityWrittenContainerEvent
  206.     {
  207.         $affected = $this->versionManager->insert($this->definition, $data, WriteContext::createFromContext($context));
  208.         $event = EntityWrittenContainerEvent::createWithWrittenEvents($affected, $context, []);
  209.         $this->eventDispatcher->dispatch($event);
  211.         return $event;
  212.     }
  214.     public function delete(array $ids, Context $context): EntityWrittenContainerEvent
  215.     {
  216.         $affected = $this->versionManager->delete($this->definition, $ids, WriteContext::createFromContext($context));
  217.         $event = EntityWrittenContainerEvent::createWithDeletedEvents($affected->getDeleted(), $context, $affected->getNotFound());
  219.         if ($affected->getWritten()) {
  220.             $updates = EntityWrittenContainerEvent::createWithWrittenEvents($affected->getWritten(), $context, []);
  221.             $event->addEvent(...$updates->getEvents());
  222.         }
  224.         $this->eventDispatcher->dispatch($event);
  226.         return $event;
  227.     }
  229.     public function createVersion(string $id, Context $context, ?string $name = null, ?string $versionId = null): string
  230.     {
  231.         if (!$this->definition->isVersionAware()) {
  232.             throw new \RuntimeException(sprintf('Entity %s is not version aware', $this->definition->getEntityName()));
  233.         }
  235.         return $this->versionManager->createVersion($this->definition, $id, WriteContext::createFromContext($context), $name, $versionId);
  236.     }
  238.     public function merge(string $versionId, Context $context): void
  239.     {
  240.         if (!$this->definition->isVersionAware()) {
  241.             throw new \RuntimeException(sprintf('Entity %s is not version aware', $this->definition->getEntityName()));
  242.         }
  243.         $this->versionManager->merge($versionId, WriteContext::createFromContext($context));
  244.     }
  246.     public function clone(string $id, Context $context, ?string $newId = null, ?CloneBehavior $behavior = null): EntityWrittenContainerEvent
  247.     {
  248.         $newId = $newId ?? Uuid::randomHex();
  249.         if (!Uuid::isValid($newId)) {
  250.             throw new InvalidUuidException($newId);
  251.         }
  253.         $affected = $this->versionManager->clone(
  254.             $this->definition,
  255.             $id,
  256.             $newId,
  257.             $context->getVersionId(),
  258.             WriteContext::createFromContext($context),
  259.             $behavior ?? new CloneBehavior()
  260.         );
  262.         $event = EntityWrittenContainerEvent::createWithWrittenEvents($affected, $context, []);
  263.         $this->eventDispatcher->dispatch($event);
  265.         return $event;
  266.     }
  268.     private function read(Criteria $criteria, Context $context): EntityCollection
  269.     {
  270.         $entities = $this->reader->read($this->definition, $criteria, $context);
  272.         if ($this->eventFactory === null) {
  273.             throw new \RuntimeException('Event loaded factory was not injected');
  274.         }
  276.         if ($criteria->getFields() === []) {
  277.             $event = $this->eventFactory->create($entities->getElements(), $context);
  278.         } else {
  279.             $event = $this->eventFactory->createPartial($entities->getElements(), $context);
  280.         }
  282.         $this->eventDispatcher->dispatch($event);
  284.         return $entities;
  285.     }
  286. }