vendor/shopware/core/System/SalesChannel/Entity/SalesChannelRepository.php line 138

  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(
  37.         private readonly EntityDefinition $definition,
  38.         private readonly EntityReaderInterface $reader,
  39.         private readonly EntitySearcherInterface $searcher,
  40.         private readonly EntityAggregatorInterface $aggregator,
  41.         private readonly EventDispatcherInterface $eventDispatcher,
  42.         private readonly EntityLoadedEventFactory $eventFactory
  43.     ) {
  44.     }
  46.     /**
  47.      * @throws InconsistentCriteriaIdsException
  48.      */
  49.     public function search(Criteria $criteria, SalesChannelContext $salesChannelContext): EntitySearchResult
  50.     {
  51.         $criteria = clone $criteria;
  53.         $this->processCriteria($criteria, $salesChannelContext);
  55.         $aggregations = null;
  56.         if ($criteria->getAggregations()) {
  57.             $aggregations = $this->aggregate($criteria, $salesChannelContext);
  58.         }
  59.         if (!RepositorySearchDetector::isSearchRequired($this->definition, $criteria)) {
  60.             $entities = $this->read($criteria, $salesChannelContext);
  62.             return new EntitySearchResult($this->definition->getEntityName(), $entities->count(), $entities, $aggregations, $criteria, $salesChannelContext->getContext());
  63.         }
  65.         $ids = $this->doSearch($criteria, $salesChannelContext);
  67.         if (empty($ids->getIds())) {
  68.             /** @var EntityCollection<Entity> $collection */
  69.             $collection = $this->definition->getCollectionClass();
  71.             return new EntitySearchResult($this->definition->getEntityName(), $ids->getTotal(), new $collection(), $aggregations, $criteria, $salesChannelContext->getContext());
  72.         }
  74.         $readCriteria = $criteria->cloneForRead($ids->getIds());
  76.         $entities = $this->read($readCriteria, $salesChannelContext);
  78.         $search = $ids->getData();
  80.         /** @var Entity $element */
  81.         foreach ($entities as $element) {
  82.             if (!\array_key_exists($element->getUniqueIdentifier(), $search)) {
  83.                 continue;
  84.             }
  86.             $data = $search[$element->getUniqueIdentifier()];
  87.             unset($data['id']);
  89.             if (empty($data)) {
  90.                 continue;
  91.             }
  93.             $element->addExtension('search', new ArrayEntity($data));
  94.         }
  96.         $result = new EntitySearchResult($this->definition->getEntityName(), $ids->getTotal(), $entities, $aggregations, $criteria, $salesChannelContext->getContext());
  97.         $result->addState(...$ids->getStates());
  99.         $event = new EntitySearchResultLoadedEvent($this->definition, $result);
  100.         $this->eventDispatcher->dispatch($event, $event->getName());
  102.         $event = new SalesChannelEntitySearchResultLoadedEvent($this->definition, $result, $salesChannelContext);
  103.         $this->eventDispatcher->dispatch($event, $event->getName());
  105.         return $result;
  106.     }
  108.     public function aggregate(Criteria $criteria, SalesChannelContext $salesChannelContext): AggregationResultCollection
  109.     {
  110.         $criteria = clone $criteria;
  112.         $this->processCriteria($criteria, $salesChannelContext);
  114.         $result = $this->aggregator->aggregate($this->definition, $criteria, $salesChannelContext->getContext());
  116.         $event = new EntityAggregationResultLoadedEvent($this->definition, $result, $salesChannelContext->getContext());
  117.         $this->eventDispatcher->dispatch($event, $event->getName());
  119.         return $result;
  120.     }
  122.     public function searchIds(Criteria $criteria, SalesChannelContext $salesChannelContext): IdSearchResult
  123.     {
  124.         $criteria = clone $criteria;
  126.         $this->processCriteria($criteria, $salesChannelContext);
  128.         return $this->doSearch($criteria, $salesChannelContext);
  129.     }
  131.     /**
  132.      * @return EntityCollection<Entity>
  133.      */
  134.     private function read(Criteria $criteria, SalesChannelContext $salesChannelContext): EntityCollection
  135.     {
  136.         $criteria = clone $criteria;
  138.         $entities = $this->reader->read($this->definition, $criteria, $salesChannelContext->getContext());
  140.         if ($criteria->getFields() === []) {
  141.             $events = $this->eventFactory->createForSalesChannel($entities->getElements(), $salesChannelContext);
  142.         } else {
  143.             $events = $this->eventFactory->createPartialForSalesChannel($entities->getElements(), $salesChannelContext);
  144.         }
  146.         foreach ($events as $event) {
  147.             $this->eventDispatcher->dispatch($event);
  148.         }
  150.         return $entities;
  151.     }
  153.     private function doSearch(Criteria $criteria, SalesChannelContext $salesChannelContext): IdSearchResult
  154.     {
  155.         $result = $this->searcher->search($this->definition, $criteria, $salesChannelContext->getContext());
  157.         $event = new SalesChannelEntityIdSearchResultLoadedEvent($this->definition, $result, $salesChannelContext);
  158.         $this->eventDispatcher->dispatch($event, $event->getName());
  160.         return $result;
  161.     }
  163.     private function processCriteria(Criteria $topCriteria, SalesChannelContext $salesChannelContext): void
  164.     {
  165.         if (!$this->definition instanceof SalesChannelDefinitionInterface) {
  166.             return;
  167.         }
  169.         $queue = [
  170.             ['definition' => $this->definition, 'criteria' => $topCriteria],
  171.         ];
  173.         $maxCount = 100;
  175.         $processed = [];
  177.         // process all associations breadth-first
  178.         while (!empty($queue) && --$maxCount > 0) {
  179.             $cur = array_shift($queue);
  181.             /** @var EntityDefinition $definition */
  182.             $definition = $cur['definition'];
  183.             $criteria = $cur['criteria'];
  185.             if (isset($processed[$definition::class])) {
  186.                 continue;
  187.             }
  189.             if ($definition instanceof SalesChannelDefinitionInterface) {
  190.                 $definition->processCriteria($criteria, $salesChannelContext);
  192.                 $eventName = \sprintf('sales_channel.%s.process.criteria', $definition->getEntityName());
  193.                 $event = new SalesChannelProcessCriteriaEvent($criteria, $salesChannelContext);
  195.                 $this->eventDispatcher->dispatch($event, $eventName);
  196.             }
  198.             $processed[$definition::class] = true;
  200.             foreach ($criteria->getAssociations() as $associationName => $associationCriteria) {
  201.                 // find definition
  202.                 $field = $definition->getField($associationName);
  203.                 if (!$field instanceof AssociationField) {
  204.                     continue;
  205.                 }
  207.                 $referenceDefinition = $field->getReferenceDefinition();
  208.                 $queue[] = ['definition' => $referenceDefinition, 'criteria' => $associationCriteria];
  209.             }
  210.         }
  211.     }
  212. }