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

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. /**
  28.  * @final tag:v6.5.0
  29.  */
  30. class SalesChannelRepository implements SalesChannelRepositoryInterface
  31. {
  32.     /**
  33.      * @var EntityDefinition
  34.      */
  35.     protected $definition;
  37.     /**
  38.      * @var EntityReaderInterface
  39.      */
  40.     protected $reader;
  42.     /**
  43.      * @var EntitySearcherInterface
  44.      */
  45.     protected $searcher;
  47.     /**
  48.      * @var EntityAggregatorInterface
  49.      */
  50.     protected $aggregator;
  52.     /**
  53.      * @var EventDispatcherInterface
  54.      */
  55.     protected $eventDispatcher;
  57.     private ?EntityLoadedEventFactory $eventFactory;
  59.     /**
  60.      * @internal
  61.      *
  62.      * @deprecated tag:v6.5.0 - $eventFactory parameter will be required
  63.      */
  64.     public function __construct(
  65.         EntityDefinition $definition,
  66.         EntityReaderInterface $reader,
  67.         EntitySearcherInterface $searcher,
  68.         EntityAggregatorInterface $aggregator,
  69.         EventDispatcherInterface $eventDispatcher,
  70.         ?EntityLoadedEventFactory $eventFactory
  71.     ) {
  72.         $this->definition = $definition;
  73.         $this->reader = $reader;
  74.         $this->searcher = $searcher;
  75.         $this->aggregator = $aggregator;
  76.         $this->eventDispatcher = $eventDispatcher;
  78.         if ($eventFactory !== null) {
  79.             $this->eventFactory = $eventFactory;
  80.         } else {
  81.             Feature::triggerDeprecationOrThrow(
  82.                 'v6.5.0.0',
  83.                 sprintf('SalesChannelRepository constructor for definition %s requires the event factory as required 6th parameter in v6.5.0.0', $definition->getEntityName())
  84.             );
  85.         }
  86.     }
  88.     /**
  89.      * @deprecated tag:v6.5.0 - Will be removed
  90.      */
  91.     public function setEntityLoadedEventFactory(EntityLoadedEventFactory $eventFactory): void
  92.     {
  93.         Feature::triggerDeprecationOrThrow(
  94.             'v6.5.0.0',
  95.             Feature::deprecatedMethodMessage(__CLASS__, __METHOD__, 'v6.5.0.0')
  96.         );
  98.         $this->eventFactory = $eventFactory;
  99.     }
  101.     /**
  102.      * @throws InconsistentCriteriaIdsException
  103.      */
  104.     public function search(Criteria $criteria, SalesChannelContext $salesChannelContext): EntitySearchResult
  105.     {
  106.         $criteria = clone $criteria;
  108.         $this->processCriteria($criteria, $salesChannelContext);
  110.         $aggregations = null;
  111.         if ($criteria->getAggregations()) {
  112.             $aggregations = $this->aggregate($criteria, $salesChannelContext);
  113.         }
  114.         if (!RepositorySearchDetector::isSearchRequired($this->definition, $criteria)) {
  115.             $entities = $this->read($criteria, $salesChannelContext);
  117.             return new EntitySearchResult($this->definition->getEntityName(), $entities->count(), $entities, $aggregations, $criteria, $salesChannelContext->getContext());
  118.         }
  120.         $ids = $this->doSearch($criteria, $salesChannelContext);
  122.         if (empty($ids->getIds())) {
  123.             /** @var EntityCollection<Entity> $collection */
  124.             $collection = $this->definition->getCollectionClass();
  126.             return new EntitySearchResult($this->definition->getEntityName(), $ids->getTotal(), new $collection(), $aggregations, $criteria, $salesChannelContext->getContext());
  127.         }
  129.         $readCriteria = $criteria->cloneForRead($ids->getIds());
  131.         $entities = $this->read($readCriteria, $salesChannelContext);
  133.         $search = $ids->getData();
  135.         /** @var Entity $element */
  136.         foreach ($entities as $element) {
  137.             if (!\array_key_exists($element->getUniqueIdentifier(), $search)) {
  138.                 continue;
  139.             }
  141.             $data = $search[$element->getUniqueIdentifier()];
  142.             unset($data['id']);
  144.             if (empty($data)) {
  145.                 continue;
  146.             }
  148.             $element->addExtension('search', new ArrayEntity($data));
  149.         }
  151.         $result = new EntitySearchResult($this->definition->getEntityName(), $ids->getTotal(), $entities, $aggregations, $criteria, $salesChannelContext->getContext());
  152.         $result->addState(...$ids->getStates());
  154.         $event = new EntitySearchResultLoadedEvent($this->definition, $result);
  155.         $this->eventDispatcher->dispatch($event, $event->getName());
  157.         $event = new SalesChannelEntitySearchResultLoadedEvent($this->definition, $result, $salesChannelContext);
  158.         $this->eventDispatcher->dispatch($event, $event->getName());
  160.         return $result;
  161.     }
  163.     public function aggregate(Criteria $criteria, SalesChannelContext $salesChannelContext): AggregationResultCollection
  164.     {
  165.         $criteria = clone $criteria;
  167.         $this->processCriteria($criteria, $salesChannelContext);
  169.         $result = $this->aggregator->aggregate($this->definition, $criteria, $salesChannelContext->getContext());
  171.         $event = new EntityAggregationResultLoadedEvent($this->definition, $result, $salesChannelContext->getContext());
  172.         $this->eventDispatcher->dispatch($event, $event->getName());
  174.         return $result;
  175.     }
  177.     public function searchIds(Criteria $criteria, SalesChannelContext $salesChannelContext): IdSearchResult
  178.     {
  179.         $criteria = clone $criteria;
  181.         $this->processCriteria($criteria, $salesChannelContext);
  183.         return $this->doSearch($criteria, $salesChannelContext);
  184.     }
  186.     /**
  187.      * @return EntityCollection<Entity>
  188.      */
  189.     private function read(Criteria $criteria, SalesChannelContext $salesChannelContext): EntityCollection
  190.     {
  191.         $criteria = clone $criteria;
  193.         $entities = $this->reader->read($this->definition, $criteria, $salesChannelContext->getContext());
  195.         if ($this->eventFactory === null) {
  196.             throw new \RuntimeException('Event loaded factory was not injected');
  197.         }
  199.         if ($criteria->getFields() === []) {
  200.             $events = $this->eventFactory->createForSalesChannel($entities->getElements(), $salesChannelContext);
  201.         } else {
  202.             $events = $this->eventFactory->createPartialForSalesChannel($entities->getElements(), $salesChannelContext);
  203.         }
  205.         foreach ($events as $event) {
  206.             $this->eventDispatcher->dispatch($event);
  207.         }
  209.         return $entities;
  210.     }
  212.     private function doSearch(Criteria $criteria, SalesChannelContext $salesChannelContext): IdSearchResult
  213.     {
  214.         $result = $this->searcher->search($this->definition, $criteria, $salesChannelContext->getContext());
  216.         $event = new SalesChannelEntityIdSearchResultLoadedEvent($this->definition, $result, $salesChannelContext);
  217.         $this->eventDispatcher->dispatch($event, $event->getName());
  219.         return $result;
  220.     }
  222.     private function processCriteria(Criteria $topCriteria, SalesChannelContext $salesChannelContext): void
  223.     {
  224.         if (!$this->definition instanceof SalesChannelDefinitionInterface) {
  225.             return;
  226.         }
  228.         $queue = [
  229.             ['definition' => $this->definition, 'criteria' => $topCriteria],
  230.         ];
  232.         $maxCount = 100;
  234.         $processed = [];
  236.         // process all associations breadth-first
  237.         while (!empty($queue) && --$maxCount > 0) {
  238.             $cur = array_shift($queue);
  240.             /** @var EntityDefinition $definition */
  241.             $definition = $cur['definition'];
  242.             $criteria = $cur['criteria'];
  244.             if (isset($processed[\get_class($definition)])) {
  245.                 continue;
  246.             }
  248.             if ($definition instanceof SalesChannelDefinitionInterface) {
  249.                 $definition->processCriteria($criteria, $salesChannelContext);
  251.                 $eventName = \sprintf('sales_channel.%s.process.criteria', $definition->getEntityName());
  252.                 $event = new SalesChannelProcessCriteriaEvent($criteria, $salesChannelContext);
  254.                 $this->eventDispatcher->dispatch($event, $eventName);
  255.             }
  257.             $processed[\get_class($definition)] = true;
  259.             foreach ($criteria->getAssociations() as $associationName => $associationCriteria) {
  260.                 // find definition
  261.                 $field = $definition->getField($associationName);
  262.                 if (!$field instanceof AssociationField) {
  263.                     continue;
  264.                 }
  266.                 $referenceDefinition = $field->getReferenceDefinition();
  267.                 $queue[] = ['definition' => $referenceDefinition, 'criteria' => $associationCriteria];
  268.             }
  269.         }
  270.     }
  271. }