custom/plugins/SwagPlatformSecurity/src/Fixes/NEXT37527/SalesChannelRepository.php line 118

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\Field\ManyToManyAssociationField;
  14. use Shopware\Core\Framework\DataAbstractionLayer\Read\EntityReaderInterface;
  15. use Shopware\Core\Framework\DataAbstractionLayer\RepositorySearchDetector;
  16. use Shopware\Core\Framework\DataAbstractionLayer\Search\AggregationResult\AggregationResultCollection;
  17. use Shopware\Core\Framework\DataAbstractionLayer\Search\Criteria;
  18. use Shopware\Core\Framework\DataAbstractionLayer\Search\EntityAggregatorInterface;
  19. use Shopware\Core\Framework\DataAbstractionLayer\Search\EntitySearcherInterface;
  20. use Shopware\Core\Framework\DataAbstractionLayer\Search\EntitySearchResult;
  21. use Shopware\Core\Framework\DataAbstractionLayer\Search\IdSearchResult;
  22. use Shopware\Core\Framework\Feature;
  23. use Shopware\Core\Framework\Log\Package;
  24. use Shopware\Core\Framework\Struct\ArrayEntity;
  25. use Shopware\Core\System\SalesChannel\Event\SalesChannelProcessCriteriaEvent;
  26. use Shopware\Core\System\SalesChannel\SalesChannelContext;
  27. use Symfony\Component\EventDispatcher\EventDispatcherInterface;
  29. /**
  30.  * @final tag:v6.5.0
  31.  */
  32. #[Package('sales-channel')]
  33. class SalesChannelRepository implements SalesChannelRepositoryInterface
  34. {
  35.     /**
  36.      * @var EntityDefinition
  37.      */
  38.     protected $definition;
  40.     /**
  41.      * @var EntityReaderInterface
  42.      */
  43.     protected $reader;
  45.     /**
  46.      * @var EntitySearcherInterface
  47.      */
  48.     protected $searcher;
  50.     /**
  51.      * @var EntityAggregatorInterface
  52.      */
  53.     protected $aggregator;
  55.     /**
  56.      * @var EventDispatcherInterface
  57.      */
  58.     protected $eventDispatcher;
  60.     private ?EntityLoadedEventFactory $eventFactory;
  62.     /**
  63.      * @internal
  64.      *
  65.      * @deprecated tag:v6.5.0 - $eventFactory parameter will be required
  66.      */
  67.     public function __construct(
  68.         EntityDefinition $definition,
  69.         EntityReaderInterface $reader,
  70.         EntitySearcherInterface $searcher,
  71.         EntityAggregatorInterface $aggregator,
  72.         EventDispatcherInterface $eventDispatcher,
  73.         ?EntityLoadedEventFactory $eventFactory
  74.     ) {
  75.         $this->definition = $definition;
  76.         $this->reader = $reader;
  77.         $this->searcher = $searcher;
  78.         $this->aggregator = $aggregator;
  79.         $this->eventDispatcher = $eventDispatcher;
  81.         if ($eventFactory !== null) {
  82.             $this->eventFactory = $eventFactory;
  83.         } else {
  84.             Feature::triggerDeprecationOrThrow(
  85.                 'v6.5.0.0',
  86.                 sprintf('SalesChannelRepository constructor for definition %s requires the event factory as required 6th parameter in v6.5.0.0', $definition->getEntityName())
  87.             );
  88.         }
  89.     }
  91.     /**
  92.      * @deprecated tag:v6.5.0 - Will be removed
  93.      */
  94.     public function setEntityLoadedEventFactory(EntityLoadedEventFactory $eventFactory): void
  95.     {
  96.         Feature::triggerDeprecationOrThrow(
  97.             'v6.5.0.0',
  98.             Feature::deprecatedMethodMessage(__CLASS__, __METHOD__, 'v6.5.0.0')
  99.         );
  101.         $this->eventFactory = $eventFactory;
  102.     }
  104.     /**
  105.      * @throws InconsistentCriteriaIdsException
  106.      */
  107.     public function search(Criteria $criteria, SalesChannelContext $salesChannelContext): EntitySearchResult
  108.     {
  109.         $criteria = clone $criteria;
  111.         $this->processCriteria($criteria, $salesChannelContext);
  113.         $aggregations = null;
  114.         if ($criteria->getAggregations()) {
  115.             $aggregations = $this->aggregate($criteria, $salesChannelContext);
  116.         }
  117.         if (!RepositorySearchDetector::isSearchRequired($this->definition, $criteria)) {
  118.             $entities = $this->read($criteria, $salesChannelContext);
  120.             return new EntitySearchResult($this->definition->getEntityName(), $entities->count(), $entities, $aggregations, $criteria, $salesChannelContext->getContext());
  121.         }
  123.         $ids = $this->doSearch($criteria, $salesChannelContext);
  125.         if (empty($ids->getIds())) {
  126.             /** @var EntityCollection<Entity> $collection */
  127.             $collection = $this->definition->getCollectionClass();
  129.             return new EntitySearchResult($this->definition->getEntityName(), $ids->getTotal(), new $collection(), $aggregations, $criteria, $salesChannelContext->getContext());
  130.         }
  132.         $readCriteria = $criteria->cloneForRead($ids->getIds());
  134.         $entities = $this->read($readCriteria, $salesChannelContext);
  136.         $search = $ids->getData();
  138.         /** @var Entity $element */
  139.         foreach ($entities as $element) {
  140.             if (!\array_key_exists($element->getUniqueIdentifier(), $search)) {
  141.                 continue;
  142.             }
  144.             $data = $search[$element->getUniqueIdentifier()];
  145.             unset($data['id']);
  147.             if (empty($data)) {
  148.                 continue;
  149.             }
  151.             $element->addExtension('search', new ArrayEntity($data));
  152.         }
  154.         $result = new EntitySearchResult($this->definition->getEntityName(), $ids->getTotal(), $entities, $aggregations, $criteria, $salesChannelContext->getContext());
  155.         $result->addState(...$ids->getStates());
  157.         $event = new EntitySearchResultLoadedEvent($this->definition, $result);
  158.         $this->eventDispatcher->dispatch($event, $event->getName());
  160.         $event = new SalesChannelEntitySearchResultLoadedEvent($this->definition, $result, $salesChannelContext);
  161.         $this->eventDispatcher->dispatch($event, $event->getName());
  163.         return $result;
  164.     }
  166.     public function aggregate(Criteria $criteria, SalesChannelContext $salesChannelContext): AggregationResultCollection
  167.     {
  168.         $criteria = clone $criteria;
  170.         $this->processCriteria($criteria, $salesChannelContext);
  172.         $result = $this->aggregator->aggregate($this->definition, $criteria, $salesChannelContext->getContext());
  174.         $event = new EntityAggregationResultLoadedEvent($this->definition, $result, $salesChannelContext->getContext());
  175.         $this->eventDispatcher->dispatch($event, $event->getName());
  177.         return $result;
  178.     }
  180.     public function searchIds(Criteria $criteria, SalesChannelContext $salesChannelContext): IdSearchResult
  181.     {
  182.         $criteria = clone $criteria;
  184.         $this->processCriteria($criteria, $salesChannelContext);
  186.         return $this->doSearch($criteria, $salesChannelContext);
  187.     }
  189.     /**
  190.      * @return EntityCollection<Entity>
  191.      */
  192.     private function read(Criteria $criteria, SalesChannelContext $salesChannelContext): EntityCollection
  193.     {
  194.         $criteria = clone $criteria;
  196.         $entities = $this->reader->read($this->definition, $criteria, $salesChannelContext->getContext());
  198.         if ($this->eventFactory === null) {
  199.             throw new \RuntimeException('Event loaded factory was not injected');
  200.         }
  202.         if (method_exists($criteria, 'getFields')) {
  203.             if ($criteria->getFields() === []) {
  204.                 $events = $this->eventFactory->createForSalesChannel($entities->getElements(), $salesChannelContext);
  205.             } else {
  206.                 $events = $this->eventFactory->createPartialForSalesChannel($entities->getElements(), $salesChannelContext);
  207.             }
  208.         } else {
  209.             $events = $this->eventFactory->createForSalesChannel($entities->getElements(), $salesChannelContext);
  210.         }
  212.         foreach ($events as $event) {
  213.             $this->eventDispatcher->dispatch($event);
  214.         }
  216.         return $entities;
  217.     }
  219.     private function doSearch(Criteria $criteria, SalesChannelContext $salesChannelContext): IdSearchResult
  220.     {
  221.         $result = $this->searcher->search($this->definition, $criteria, $salesChannelContext->getContext());
  223.         $event = new SalesChannelEntityIdSearchResultLoadedEvent($this->definition, $result, $salesChannelContext);
  224.         $this->eventDispatcher->dispatch($event, $event->getName());
  226.         return $result;
  227.     }
  229.     private function processCriteria(Criteria $topCriteria, SalesChannelContext $salesChannelContext): void
  230.     {
  231.         if (!$this->definition instanceof SalesChannelDefinitionInterface) {
  232.             return;
  233.         }
  235.         $queue = [
  236.             ['definition' => $this->definition, 'criteria' => $topCriteria, 'path' => ''],
  237.         ];
  239.         $maxCount = 100;
  241.         $processed = [];
  243.         // process all associations breadth-first
  244.         while (!empty($queue) && --$maxCount > 0) {
  245.             $cur = array_shift($queue);
  247.             $definition = $cur['definition'];
  248.             $criteria = $cur['criteria'];
  249.             $path = $cur['path'];
  250.             $processedKey = $path . get_class($definition);
  252.             if (isset($processed[$processedKey])) {
  253.                 continue;
  254.             }
  256.             if ($definition instanceof SalesChannelDefinitionInterface) {
  257.                 $definition->processCriteria($criteria, $salesChannelContext);
  259.                 $eventName = \sprintf('sales_channel.%s.process.criteria', $definition->getEntityName());
  260.                 $event = new SalesChannelProcessCriteriaEvent($criteria, $salesChannelContext);
  262.                 $this->eventDispatcher->dispatch($event, $eventName);
  263.             }
  265.             $processed[$processedKey] = true;
  267.             foreach ($criteria->getAssociations() as $associationName => $associationCriteria) {
  268.                 // find definition
  269.                 $field = $definition->getField($associationName);
  270.                 if (!$field instanceof AssociationField) {
  271.                     continue;
  272.                 }
  274.                 $referenceDefinition = $field->getReferenceDefinition();
  275.                 $queue[] = ['definition' => $referenceDefinition, 'criteria' => $associationCriteria, 'path' => $path . '.' . $associationName];
  277.                 if (!$field instanceof ManyToManyAssociationField) {
  278.                     continue;
  279.                 }
  281.                 $referenceDefinition = $field->getToManyReferenceDefinition();
  282.                 $queue[] = ['definition' => $referenceDefinition, 'criteria' => $associationCriteria, 'path' => $path . '.' . $associationName];
  283.             }
  284.         }
  285.     }
  286. }