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

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