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

Open in your IDE?
  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\Feature;
  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. class SalesChannelRepository implements SalesChannelRepositoryInterface
  28. {
  29.     /**
  30.      * @var EntityDefinition
  31.      */
  32.     protected $definition;
  34.     /**
  35.      * @var EntityReaderInterface
  36.      */
  37.     protected $reader;
  39.     /**
  40.      * @var EntitySearcherInterface
  41.      */
  42.     protected $searcher;
  44.     /**
  45.      * @var EntityAggregatorInterface
  46.      */
  47.     protected $aggregator;
  49.     /**
  50.      * @var EventDispatcherInterface
  51.      */
  52.     protected $eventDispatcher;
  54.     private ?EntityLoadedEventFactory $eventFactory;
  56.     /**
  57.      * @internal
  58.      *
  59.      * @deprecated tag:v6.5.0 - $eventFactory parameter will be required
  60.      */
  61.     public function __construct(
  62.         EntityDefinition $definition,
  63.         EntityReaderInterface $reader,
  64.         EntitySearcherInterface $searcher,
  65.         EntityAggregatorInterface $aggregator,
  66.         EventDispatcherInterface $eventDispatcher,
  67.         ?EntityLoadedEventFactory $eventFactory
  68.     ) {
  69.         $this->definition = $definition;
  70.         $this->reader = $reader;
  71.         $this->searcher = $searcher;
  72.         $this->aggregator = $aggregator;
  73.         $this->eventDispatcher = $eventDispatcher;
  75.         if ($eventFactory !== null) {
  76.             $this->eventFactory = $eventFactory;
  77.         } else {
  78.             Feature::triggerDeprecationOrThrow(
  79.                 'v6.5.0.0',
  80.                 sprintf('SalesChannelRepository constructor for definition %s requires the event factory as required 6th parameter in v6.5.0.0', $definition->getEntityName())
  81.             );
  82.         }
  83.     }
  85.     /**
  86.      * @deprecated tag:v6.5.0 - Will be removed
  87.      */
  88.     public function setEntityLoadedEventFactory(EntityLoadedEventFactory $eventFactory): void
  89.     {
  90.         Feature::triggerDeprecationOrThrow(
  91.             'v6.5.0.0',
  92.             Feature::deprecatedMethodMessage(__CLASS__, __METHOD__, 'v6.5.0.0')
  93.         );
  95.         $this->eventFactory = $eventFactory;
  96.     }
  98.     /**
  99.      * @throws InconsistentCriteriaIdsException
  100.      */
  101.     public function search(Criteria $criteria, SalesChannelContext $salesChannelContext): EntitySearchResult
  102.     {
  103.         $criteria = clone $criteria;
  105.         $this->processCriteria($criteria, $salesChannelContext);
  107.         $aggregations = null;
  108.         if ($criteria->getAggregations()) {
  109.             $aggregations = $this->aggregate($criteria, $salesChannelContext);
  110.         }
  111.         if (!RepositorySearchDetector::isSearchRequired($this->definition, $criteria)) {
  112.             $entities = $this->read($criteria, $salesChannelContext);
  114.             return new EntitySearchResult($this->definition->getEntityName(), $entities->count(), $entities, $aggregations, $criteria, $salesChannelContext->getContext());
  115.         }
  117.         $ids = $this->doSearch($criteria, $salesChannelContext);
  119.         if (empty($ids->getIds())) {
  120.             $collection = $this->definition->getCollectionClass();
  122.             return new EntitySearchResult($this->definition->getEntityName(), $ids->getTotal(), new $collection(), $aggregations, $criteria, $salesChannelContext->getContext());
  123.         }
  125.         $readCriteria = $criteria->cloneForRead($ids->getIds());
  127.         $entities = $this->read($readCriteria, $salesChannelContext);
  129.         $search = $ids->getData();
  131.         /** @var Entity $element */
  132.         foreach ($entities as $element) {
  133.             if (!\array_key_exists($element->getUniqueIdentifier(), $search)) {
  134.                 continue;
  135.             }
  137.             $data = $search[$element->getUniqueIdentifier()];
  138.             unset($data['id']);
  140.             if (empty($data)) {
  141.                 continue;
  142.             }
  144.             $element->addExtension('search', new ArrayEntity($data));
  145.         }
  147.         $result = new EntitySearchResult($this->definition->getEntityName(), $ids->getTotal(), $entities, $aggregations, $criteria, $salesChannelContext->getContext());
  148.         $result->addState(...$ids->getStates());
  150.         $event = new EntitySearchResultLoadedEvent($this->definition, $result);
  151.         $this->eventDispatcher->dispatch($event, $event->getName());
  153.         $event = new SalesChannelEntitySearchResultLoadedEvent($this->definition, $result, $salesChannelContext);
  154.         $this->eventDispatcher->dispatch($event, $event->getName());
  156.         return $result;
  157.     }
  159.     public function aggregate(Criteria $criteria, SalesChannelContext $salesChannelContext): AggregationResultCollection
  160.     {
  161.         $criteria = clone $criteria;
  163.         $this->processCriteria($criteria, $salesChannelContext);
  165.         $result = $this->aggregator->aggregate($this->definition, $criteria, $salesChannelContext->getContext());
  167.         $event = new EntityAggregationResultLoadedEvent($this->definition, $result, $salesChannelContext->getContext());
  168.         $this->eventDispatcher->dispatch($event, $event->getName());
  170.         return $result;
  171.     }
  173.     public function searchIds(Criteria $criteria, SalesChannelContext $salesChannelContext): IdSearchResult
  174.     {
  175.         $criteria = clone $criteria;
  177.         $this->processCriteria($criteria, $salesChannelContext);
  179.         return $this->doSearch($criteria, $salesChannelContext);
  180.     }
  182.     private function read(Criteria $criteria, SalesChannelContext $salesChannelContext): EntityCollection
  183.     {
  184.         $criteria = clone $criteria;
  186.         $entities = $this->reader->read($this->definition, $criteria, $salesChannelContext->getContext());
  188.         if ($this->eventFactory === null) {
  189.             throw new \RuntimeException('Event loaded factory was not injected');
  190.         }
  192.         if ($criteria->getFields() === []) {
  193.             $events = $this->eventFactory->createForSalesChannel($entities->getElements(), $salesChannelContext);
  194.         } else {
  195.             $events = $this->eventFactory->createPartialForSalesChannel($entities->getElements(), $salesChannelContext);
  196.         }
  198.         foreach ($events as $event) {
  199.             $this->eventDispatcher->dispatch($event);
  200.         }
  202.         return $entities;
  203.     }
  205.     private function doSearch(Criteria $criteria, SalesChannelContext $salesChannelContext): IdSearchResult
  206.     {
  207.         $result = $this->searcher->search($this->definition, $criteria, $salesChannelContext->getContext());
  209.         $event = new SalesChannelEntityIdSearchResultLoadedEvent($this->definition, $result, $salesChannelContext);
  210.         $this->eventDispatcher->dispatch($event, $event->getName());
  212.         return $result;
  213.     }
  215.     private function processCriteria(Criteria $topCriteria, SalesChannelContext $salesChannelContext): void
  216.     {
  217.         if (!$this->definition instanceof SalesChannelDefinitionInterface) {
  218.             return;
  219.         }
  221.         $queue = [
  222.             ['definition' => $this->definition, 'criteria' => $topCriteria],
  223.         ];
  225.         $maxCount = 100;
  227.         $processed = [];
  229.         // process all associations breadth-first
  230.         while (!empty($queue) && --$maxCount > 0) {
  231.             $cur = array_shift($queue);
  233.             /** @var EntityDefinition $definition */
  234.             $definition = $cur['definition'];
  235.             $criteria = $cur['criteria'];
  237.             if (isset($processed[\get_class($definition)])) {
  238.                 continue;
  239.             }
  241.             if ($definition instanceof SalesChannelDefinitionInterface) {
  242.                 $definition->processCriteria($criteria, $salesChannelContext);
  244.                 $eventName = \sprintf('sales_channel.%s.process.criteria', $definition->getEntityName());
  245.                 $event = new SalesChannelProcessCriteriaEvent($criteria, $salesChannelContext);
  247.                 $this->eventDispatcher->dispatch($event, $eventName);
  248.             }
  250.             $processed[\get_class($definition)] = true;
  252.             foreach ($criteria->getAssociations() as $associationName => $associationCriteria) {
  253.                 // find definition
  254.                 $field = $definition->getField($associationName);
  255.                 if (!$field instanceof AssociationField) {
  256.                     continue;
  257.                 }
  259.                 $referenceDefinition = $field->getReferenceDefinition();
  260.                 $queue[] = ['definition' => $referenceDefinition, 'criteria' => $associationCriteria];
  261.             }
  262.         }
  263.     }
  264. }