vendor/shopware/core/Framework/DataAbstractionLayer/EntityRepository.php line 100

Open in your IDE?
  1. <?php declare(strict_types=1);
  2. namespace Shopware\Core\Framework\DataAbstractionLayer;
  3. use Shopware\Core\Framework\Context;
  4. use Shopware\Core\Framework\DataAbstractionLayer\Event\EntityAggregationResultLoadedEvent;
  5. use Shopware\Core\Framework\DataAbstractionLayer\Event\EntityIdSearchResultLoadedEvent;
  6. use Shopware\Core\Framework\DataAbstractionLayer\Event\EntityLoadedEventFactory;
  7. use Shopware\Core\Framework\DataAbstractionLayer\Event\EntitySearchedEvent;
  8. use Shopware\Core\Framework\DataAbstractionLayer\Event\EntitySearchResultLoadedEvent;
  9. use Shopware\Core\Framework\DataAbstractionLayer\Event\EntityWrittenContainerEvent;
  10. use Shopware\Core\Framework\DataAbstractionLayer\Read\EntityReaderInterface;
  11. use Shopware\Core\Framework\DataAbstractionLayer\Search\AggregationResult\AggregationResultCollection;
  12. use Shopware\Core\Framework\DataAbstractionLayer\Search\Criteria;
  13. use Shopware\Core\Framework\DataAbstractionLayer\Search\EntityAggregatorInterface;
  14. use Shopware\Core\Framework\DataAbstractionLayer\Search\EntitySearcherInterface;
  15. use Shopware\Core\Framework\DataAbstractionLayer\Search\EntitySearchResult;
  16. use Shopware\Core\Framework\DataAbstractionLayer\Search\IdSearchResult;
  17. use Shopware\Core\Framework\DataAbstractionLayer\Write\CloneBehavior;
  18. use Shopware\Core\Framework\DataAbstractionLayer\Write\WriteContext;
  19. use Shopware\Core\Framework\Feature;
  20. use Shopware\Core\Framework\Struct\ArrayEntity;
  21. use Shopware\Core\Framework\Uuid\Exception\InvalidUuidException;
  22. use Shopware\Core\Framework\Uuid\Uuid;
  23. use Shopware\Core\Profiling\Profiler;
  24. use Symfony\Component\EventDispatcher\EventDispatcherInterface;
  25. /**
  26.  * @final tag:v6.5.0
  27.  */
  28. class EntityRepository implements EntityRepositoryInterface
  29. {
  30.     private EntityReaderInterface $reader;
  31.     private EntitySearcherInterface $searcher;
  32.     private EntityAggregatorInterface $aggregator;
  33.     private EventDispatcherInterface $eventDispatcher;
  34.     private VersionManager $versionManager;
  35.     private EntityDefinition $definition;
  36.     private ?EntityLoadedEventFactory $eventFactory;
  37.     /**
  38.      * @internal
  39.      *
  40.      * @deprecated tag:v6.5.0 - parameter $eventFactory will be required
  41.      */
  42.     public function __construct(
  43.         EntityDefinition $definition,
  44.         EntityReaderInterface $reader,
  45.         VersionManager $versionManager,
  46.         EntitySearcherInterface $searcher,
  47.         EntityAggregatorInterface $aggregator,
  48.         EventDispatcherInterface $eventDispatcher,
  49.         ?EntityLoadedEventFactory $eventFactory null
  50.     ) {
  51.         $this->reader $reader;
  52.         $this->searcher $searcher;
  53.         $this->aggregator $aggregator;
  54.         $this->eventDispatcher $eventDispatcher;
  55.         $this->versionManager $versionManager;
  56.         $this->definition $definition;
  57.         if ($eventFactory !== null) {
  58.             $this->eventFactory $eventFactory;
  59.         } else {
  60.             Feature::triggerDeprecationOrThrow(
  61.                 'v6.5.0.0',
  62.                 sprintf('EntityRepository constructor for definition %s requires the event factory as required 7th parameter in v6.5.0.0'$definition->getEntityName())
  63.             );
  64.         }
  65.     }
  66.     /**
  67.      * @deprecated tag:v6.5.0 - Will be removed, inject entity loaded event factory in __construct
  68.      */
  69.     public function setEntityLoadedEventFactory(EntityLoadedEventFactory $eventFactory): void
  70.     {
  71.         if (isset($this->eventFactory)) {
  72.             return;
  73.         }
  74.         Feature::triggerDeprecationOrThrow(
  75.             'v6.5.0.0',
  76.             sprintf('Repository for definition %s requires the event factory as __construct parameter'$this->definition->getEntityName())
  77.         );
  78.         $this->eventFactory $eventFactory;
  79.     }
  80.     public function getDefinition(): EntityDefinition
  81.     {
  82.         return $this->definition;
  83.     }
  84.     public function search(Criteria $criteriaContext $context): EntitySearchResult
  85.     {
  86.         if (!$criteria->getTitle()) {
  87.             return $this->_search($criteria$context);
  88.         }
  89.         return Profiler::trace($criteria->getTitle(), function () use ($criteria$context) {
  90.             return $this->_search($criteria$context);
  91.         }, 'repository');
  92.     }
  93.     public function aggregate(Criteria $criteriaContext $context): AggregationResultCollection
  94.     {
  95.         $criteria = clone $criteria;
  96.         $result $this->aggregator->aggregate($this->definition$criteria$context);
  97.         $event = new EntityAggregationResultLoadedEvent($this->definition$result$context);
  98.         $this->eventDispatcher->dispatch($event$event->getName());
  99.         return $result;
  100.     }
  101.     public function searchIds(Criteria $criteriaContext $context): IdSearchResult
  102.     {
  103.         $criteria = clone $criteria;
  104.         $this->eventDispatcher->dispatch(new EntitySearchedEvent($criteria$this->definition$context));
  105.         $result $this->searcher->search($this->definition$criteria$context);
  106.         $event = new EntityIdSearchResultLoadedEvent($this->definition$result);
  107.         $this->eventDispatcher->dispatch($event$event->getName());
  108.         return $result;
  109.     }
  110.     public function update(array $dataContext $context): EntityWrittenContainerEvent
  111.     {
  112.         $affected $this->versionManager->update($this->definition$dataWriteContext::createFromContext($context));
  113.         $event EntityWrittenContainerEvent::createWithWrittenEvents($affected$context, []);
  114.         $this->eventDispatcher->dispatch($event);
  115.         return $event;
  116.     }
  117.     public function upsert(array $dataContext $context): EntityWrittenContainerEvent
  118.     {
  119.         $affected $this->versionManager->upsert($this->definition$dataWriteContext::createFromContext($context));
  120.         $event EntityWrittenContainerEvent::createWithWrittenEvents($affected$context, []);
  121.         $this->eventDispatcher->dispatch($event);
  122.         return $event;
  123.     }
  124.     public function create(array $dataContext $context): EntityWrittenContainerEvent
  125.     {
  126.         $affected $this->versionManager->insert($this->definition$dataWriteContext::createFromContext($context));
  127.         $event EntityWrittenContainerEvent::createWithWrittenEvents($affected$context, []);
  128.         $this->eventDispatcher->dispatch($event);
  129.         return $event;
  130.     }
  131.     public function delete(array $idsContext $context): EntityWrittenContainerEvent
  132.     {
  133.         $affected $this->versionManager->delete($this->definition$idsWriteContext::createFromContext($context));
  134.         $event EntityWrittenContainerEvent::createWithDeletedEvents($affected->getDeleted(), $context$affected->getNotFound());
  135.         if ($affected->getWritten()) {
  136.             $updates EntityWrittenContainerEvent::createWithWrittenEvents($affected->getWritten(), $context, []);
  137.             if ($updates->getEvents() !== null) {
  138.                 $event->addEvent(...$updates->getEvents());
  139.             }
  140.         }
  141.         $this->eventDispatcher->dispatch($event);
  142.         return $event;
  143.     }
  144.     public function createVersion(string $idContext $context, ?string $name null, ?string $versionId null): string
  145.     {
  146.         if (!$this->definition->isVersionAware()) {
  147.             throw new \RuntimeException(sprintf('Entity %s is not version aware'$this->definition->getEntityName()));
  148.         }
  149.         return $this->versionManager->createVersion($this->definition$idWriteContext::createFromContext($context), $name$versionId);
  150.     }
  151.     public function merge(string $versionIdContext $context): void
  152.     {
  153.         if (!$this->definition->isVersionAware()) {
  154.             throw new \RuntimeException(sprintf('Entity %s is not version aware'$this->definition->getEntityName()));
  155.         }
  156.         $this->versionManager->merge($versionIdWriteContext::createFromContext($context));
  157.     }
  158.     public function clone(string $idContext $context, ?string $newId null, ?CloneBehavior $behavior null): EntityWrittenContainerEvent
  159.     {
  160.         $newId $newId ?? Uuid::randomHex();
  161.         if (!Uuid::isValid($newId)) {
  162.             throw new InvalidUuidException($newId);
  163.         }
  164.         $affected $this->versionManager->clone(
  165.             $this->definition,
  166.             $id,
  167.             $newId,
  168.             $context->getVersionId(),
  169.             WriteContext::createFromContext($context),
  170.             $behavior ?? new CloneBehavior()
  171.         );
  172.         $event EntityWrittenContainerEvent::createWithWrittenEvents($affected$context, [], true);
  173.         $this->eventDispatcher->dispatch($event);
  174.         return $event;
  175.     }
  176.     private function read(Criteria $criteriaContext $context): EntityCollection
  177.     {
  178.         $criteria = clone $criteria;
  179.         $entities $this->reader->read($this->definition$criteria$context);
  180.         if ($this->eventFactory === null) {
  181.             throw new \RuntimeException('Event loaded factory was not injected');
  182.         }
  183.         if ($criteria->getFields() === []) {
  184.             $event $this->eventFactory->create($entities->getElements(), $context);
  185.         } else {
  186.             $event $this->eventFactory->createPartial($entities->getElements(), $context);
  187.         }
  188.         $this->eventDispatcher->dispatch($event);
  189.         return $entities;
  190.     }
  191.     private function _search(Criteria $criteriaContext $context): EntitySearchResult
  192.     {
  193.         $criteria = clone $criteria;
  194.         $aggregations null;
  195.         if ($criteria->getAggregations()) {
  196.             $aggregations $this->aggregate($criteria$context);
  197.         }
  198.         if (!RepositorySearchDetector::isSearchRequired($this->definition$criteria)) {
  199.             $this->eventDispatcher->dispatch(
  200.                 new EntitySearchedEvent($criteria$this->definition$context)
  201.             );
  202.             $entities $this->read($criteria$context);
  203.             return new EntitySearchResult($this->definition->getEntityName(), $entities->count(), $entities$aggregations$criteria$context);
  204.         }
  205.         $ids $this->searchIds($criteria$context);
  206.         if (empty($ids->getIds())) {
  207.             $collection $this->definition->getCollectionClass();
  208.             return new EntitySearchResult($this->definition->getEntityName(), $ids->getTotal(), new $collection(), $aggregations$criteria$context);
  209.         }
  210.         $readCriteria $criteria->cloneForRead($ids->getIds());
  211.         $entities $this->read($readCriteria$context);
  212.         $search $ids->getData();
  213.         /** @var Entity $element */
  214.         foreach ($entities as $element) {
  215.             if (!\array_key_exists($element->getUniqueIdentifier(), $search)) {
  216.                 continue;
  217.             }
  218.             $data $search[$element->getUniqueIdentifier()];
  219.             unset($data['id']);
  220.             if (empty($data)) {
  221.                 continue;
  222.             }
  223.             $element->addExtension('search', new ArrayEntity($data));
  224.         }
  225.         $result = new EntitySearchResult($this->definition->getEntityName(), $ids->getTotal(), $entities$aggregations$criteria$context);
  226.         $result->addState(...$ids->getStates());
  227.         $event = new EntitySearchResultLoadedEvent($this->definition$result);
  228.         $this->eventDispatcher->dispatch($event$event->getName());
  229.         return $result;
  230.     }
  231. }