src/Core/System/SalesChannel/Entity/SalesChannelRepository.php line 59

  1. <?php declare(strict_types=1);
  3. namespace Shopware\Core\System\SalesChannel\Entity;
  5. use Shopware\Core\Framework\DataAbstractionLayer\Entity;
  6. use Shopware\Core\Framework\DataAbstractionLayer\EntityCollection;
  7. use Shopware\Core\Framework\DataAbstractionLayer\EntityDefinition;
  8. use Shopware\Core\Framework\DataAbstractionLayer\Event\EntityAggregationResultLoadedEvent;
  9. use Shopware\Core\Framework\DataAbstractionLayer\Event\EntityLoadedEventFactory;
  10. use Shopware\Core\Framework\DataAbstractionLayer\Event\EntitySearchResultLoadedEvent;
  11. use Shopware\Core\Framework\DataAbstractionLayer\Exception\InconsistentCriteriaIdsException;
  12. use Shopware\Core\Framework\DataAbstractionLayer\Field\AssociationField;
  13. use Shopware\Core\Framework\DataAbstractionLayer\Read\EntityReaderInterface;
  14. use Shopware\Core\Framework\DataAbstractionLayer\RepositorySearchDetector;
  15. use Shopware\Core\Framework\DataAbstractionLayer\Search\AggregationResult\AggregationResultCollection;
  16. use Shopware\Core\Framework\DataAbstractionLayer\Search\Criteria;
  17. use Shopware\Core\Framework\DataAbstractionLayer\Search\EntityAggregatorInterface;
  18. use Shopware\Core\Framework\DataAbstractionLayer\Search\EntitySearcherInterface;
  19. use Shopware\Core\Framework\DataAbstractionLayer\Search\EntitySearchResult;
  20. use Shopware\Core\Framework\DataAbstractionLayer\Search\IdSearchResult;
  21. use Shopware\Core\Framework\Log\Package;
  22. use Shopware\Core\Framework\Struct\ArrayEntity;
  23. use Shopware\Core\System\SalesChannel\Event\SalesChannelProcessCriteriaEvent;
  24. use Shopware\Core\System\SalesChannel\SalesChannelContext;
  25. use Symfony\Component\EventDispatcher\EventDispatcherInterface;
  27. /**
  28.  * @final
  29.  */
  30. #[Package('sales-channel')]
  31. class SalesChannelRepository
  32. {
  33.     /**
  34.      * @internal
  35.      */
  36.     public function __construct(private readonly EntityDefinition $definition, private readonly EntityReaderInterface $reader, private readonly EntitySearcherInterface $searcher, private readonly EntityAggregatorInterface $aggregator, private readonly EventDispatcherInterface $eventDispatcher, private readonly EntityLoadedEventFactory $eventFactory)
  37.     {
  38.     }
  40.     /**
  41.      * @throws InconsistentCriteriaIdsException
  42.      */
  43.     public function search(Criteria $criteria, SalesChannelContext $salesChannelContext): EntitySearchResult
  44.     {
  45.         $criteria = clone $criteria;
  47.         $this->processCriteria($criteria, $salesChannelContext);
  49.         $aggregations = null;
  50.         if ($criteria->getAggregations()) {
  51.             $aggregations = $this->aggregate($criteria, $salesChannelContext);
  52.         }
  53.         if (!RepositorySearchDetector::isSearchRequired($this->definition, $criteria)) {
  54.             $entities = $this->read($criteria, $salesChannelContext);
  56.             return new EntitySearchResult($this->definition->getEntityName(), $entities->count(), $entities, $aggregations, $criteria, $salesChannelContext->getContext());
  57.         }
  59.         $ids = $this->doSearch($criteria, $salesChannelContext);
  61.         if (empty($ids->getIds())) {
  62.             /** @var EntityCollection<Entity> $collection */
  63.             $collection = $this->definition->getCollectionClass();
  65.             return new EntitySearchResult($this->definition->getEntityName(), $ids->getTotal(), new $collection(), $aggregations, $criteria, $salesChannelContext->getContext());
  66.         }
  68.         $readCriteria = $criteria->cloneForRead($ids->getIds());
  70.         $entities = $this->read($readCriteria, $salesChannelContext);
  72.         $search = $ids->getData();
  74.         /** @var Entity $element */
  75.         foreach ($entities as $element) {
  76.             if (!\array_key_exists($element->getUniqueIdentifier(), $search)) {
  77.                 continue;
  78.             }
  80.             $data = $search[$element->getUniqueIdentifier()];
  81.             unset($data['id']);
  83.             if (empty($data)) {
  84.                 continue;
  85.             }
  87.             $element->addExtension('search', new ArrayEntity($data));
  88.         }
  90.         $result = new EntitySearchResult($this->definition->getEntityName(), $ids->getTotal(), $entities, $aggregations, $criteria, $salesChannelContext->getContext());
  91.         $result->addState(...$ids->getStates());
  93.         $event = new EntitySearchResultLoadedEvent($this->definition, $result);
  94.         $this->eventDispatcher->dispatch($event, $event->getName());
  96.         $event = new SalesChannelEntitySearchResultLoadedEvent($this->definition, $result, $salesChannelContext);
  97.         $this->eventDispatcher->dispatch($event, $event->getName());
  99.         return $result;
  100.     }
  102.     public function aggregate(Criteria $criteria, SalesChannelContext $salesChannelContext): AggregationResultCollection
  103.     {
  104.         $criteria = clone $criteria;
  106.         $this->processCriteria($criteria, $salesChannelContext);
  108.         $result = $this->aggregator->aggregate($this->definition, $criteria, $salesChannelContext->getContext());
  110.         $event = new EntityAggregationResultLoadedEvent($this->definition, $result, $salesChannelContext->getContext());
  111.         $this->eventDispatcher->dispatch($event, $event->getName());
  113.         return $result;
  114.     }
  116.     public function searchIds(Criteria $criteria, SalesChannelContext $salesChannelContext): IdSearchResult
  117.     {
  118.         $criteria = clone $criteria;
  120.         $this->processCriteria($criteria, $salesChannelContext);
  122.         return $this->doSearch($criteria, $salesChannelContext);
  123.     }
  125.     /**
  126.      * @return EntityCollection<Entity>
  127.      */
  128.     private function read(Criteria $criteria, SalesChannelContext $salesChannelContext): EntityCollection
  129.     {
  130.         $criteria = clone $criteria;
  132.         $entities = $this->reader->read($this->definition, $criteria, $salesChannelContext->getContext());
  134.         if ($criteria->getFields() === []) {
  135.             $events = $this->eventFactory->createForSalesChannel($entities->getElements(), $salesChannelContext);
  136.         } else {
  137.             $events = $this->eventFactory->createPartialForSalesChannel($entities->getElements(), $salesChannelContext);
  138.         }
  140.         foreach ($events as $event) {
  141.             $this->eventDispatcher->dispatch($event);
  142.         }
  144.         return $entities;
  145.     }
  147.     private function doSearch(Criteria $criteria, SalesChannelContext $salesChannelContext): IdSearchResult
  148.     {
  149.         $result = $this->searcher->search($this->definition, $criteria, $salesChannelContext->getContext());
  151.         $event = new SalesChannelEntityIdSearchResultLoadedEvent($this->definition, $result, $salesChannelContext);
  152.         $this->eventDispatcher->dispatch($event, $event->getName());
  154.         return $result;
  155.     }
  157.     private function processCriteria(Criteria $topCriteria, SalesChannelContext $salesChannelContext): void
  158.     {
  159.         if (!$this->definition instanceof SalesChannelDefinitionInterface) {
  160.             return;
  161.         }
  163.         $queue = [
  164.             ['definition' => $this->definition, 'criteria' => $topCriteria],
  165.         ];
  167.         $maxCount = 100;
  169.         $processed = [];
  171.         // process all associations breadth-first
  172.         while (!empty($queue) && --$maxCount > 0) {
  173.             $cur = array_shift($queue);
  175.             /** @var EntityDefinition $definition */
  176.             $definition = $cur['definition'];
  177.             $criteria = $cur['criteria'];
  179.             if (isset($processed[$definition::class])) {
  180.                 continue;
  181.             }
  183.             if ($definition instanceof SalesChannelDefinitionInterface) {
  184.                 $definition->processCriteria($criteria, $salesChannelContext);
  186.                 $eventName = \sprintf('sales_channel.%s.process.criteria', $definition->getEntityName());
  187.                 $event = new SalesChannelProcessCriteriaEvent($criteria, $salesChannelContext);
  189.                 $this->eventDispatcher->dispatch($event, $eventName);
  190.             }
  192.             $processed[$definition::class] = true;
  194.             foreach ($criteria->getAssociations() as $associationName => $associationCriteria) {
  195.                 // find definition
  196.                 $field = $definition->getField($associationName);
  197.                 if (!$field instanceof AssociationField) {
  198.                     continue;
  199.                 }
  201.                 $referenceDefinition = $field->getReferenceDefinition();
  202.                 $queue[] = ['definition' => $referenceDefinition, 'criteria' => $associationCriteria];
  203.             }
  204.         }
  205.     }
  206. }