vendor/store.shopware.com/moorlmagazine/src/Core/Content/MagazineArticle/SalesChannel/Listing/MagazineArticleListingFeaturesSubscriber.php line 62

Open in your IDE?
  1. <?php declare(strict_types=1);
  3. namespace MoorlMagazine\Core\Content\MagazineArticle\SalesChannel\Listing;
  5. use Doctrine\DBAL\Connection;
  6. use MoorlCreator\Core\Content\Creator\CreatorDefinition;
  7. use MoorlFoundation\Core\Content\Sorting\SortingCollection;
  8. use MoorlFoundation\Core\Service\SortingService;
  9. use MoorlMagazine\Core\Content\MagazineArticle\MagazineArticleDefinition;
  10. use MoorlMagazine\Core\Content\MagazineArticle\SalesChannel\Events\MagazineArticleListingCriteriaEvent;
  11. use MoorlMagazine\Core\Content\MagazineArticle\SalesChannel\Events\MagazineArticleListingResultEvent;
  12. use MoorlMagazine\Core\Content\MagazineArticle\SalesChannel\Events\MagazineArticleSearchCriteriaEvent;
  13. use MoorlMagazine\Core\Content\MagazineArticle\SalesChannel\Events\MagazineArticleSearchResultEvent;
  14. use MoorlMagazine\Core\Content\MagazineArticle\SalesChannel\Events\MagazineArticleSuggestCriteriaEvent;
  15. use MoorlMagazine\Core\Content\MagazineCategory\MagazineCategoryDefinition;
  16. use Shopware\Core\Content\Product\Events\ProductListingCriteriaEvent;
  17. use Shopware\Core\Content\Product\Events\ProductListingResultEvent;
  18. use Shopware\Core\Content\Product\SalesChannel\Listing\Filter;
  19. use Shopware\Core\Content\Product\SalesChannel\Listing\FilterCollection;
  20. use Shopware\Core\Content\Product\SalesChannel\Sorting\ProductSortingEntity;
  21. use Shopware\Core\Framework\DataAbstractionLayer\Search\Aggregation\Bucket\FilterAggregation;
  22. use Shopware\Core\Framework\DataAbstractionLayer\Search\Aggregation\Metric\EntityAggregation;
  23. use Shopware\Core\Framework\DataAbstractionLayer\Search\Criteria;
  24. use Shopware\Core\Framework\DataAbstractionLayer\Search\Filter\EqualsAnyFilter;
  25. use Shopware\Core\System\SalesChannel\SalesChannelContext;
  26. use Shopware\Core\System\Tag\TagDefinition;
  27. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  28. use Symfony\Component\HttpFoundation\Request;
  30. class MagazineArticleListingFeaturesSubscriber implements EventSubscriberInterface
  31. {
  32.     public const DEFAULT_SEARCH_SORT = 'standard';
  34.     private SortingService $sortingService;
  36.     public function __construct(SortingService $sortingService)
  37.     {
  38.         $this->sortingService = $sortingService;
  39.     }
  41.     public static function getSubscribedEvents(): array
  42.     {
  43.         return [
  44.             MagazineArticleListingCriteriaEvent::class => [
  45.                 ['handleListingRequest', 100],
  46.                 ['handleFlags', -100],
  47.             ],
  48.             MagazineArticleSuggestCriteriaEvent::class => [
  49.                 ['handleFlags', -100],
  50.             ],
  51.             MagazineArticleSearchCriteriaEvent::class => [
  52.                 ['handleSearchRequest', 100],
  53.                 ['handleFlags', -100],
  54.             ],
  55.             MagazineArticleListingResultEvent::class => [
  56.                 ['handleResult', 100]
  57.             ],
  58.             MagazineArticleSearchResultEvent::class => 'handleResult',
  59.         ];
  60.     }
  62.     public function handleFlags(ProductListingCriteriaEvent $event): void
  63.     {
  64.         $request = $event->getRequest();
  65.         $criteria = $event->getCriteria();
  67.         if ($request->get('no-aggregations')) {
  68.             $criteria->resetAggregations();
  69.         }
  71.         if ($request->get('only-aggregations')) {
  72.             $criteria->setLimit(0);
  73.             $criteria->setTotalCountMode(Criteria::TOTAL_COUNT_MODE_NONE);
  74.             $criteria->resetSorting();
  75.             $criteria->resetAssociations();
  76.         }
  77.     }
  79.     public function handleListingRequest(ProductListingCriteriaEvent $event): void
  80.     {
  81.         $request = $event->getRequest();
  82.         $criteria = $event->getCriteria();
  83.         $context = $event->getSalesChannelContext();
  85.         if (!$request->get('order')) {
  86.             $request->request->set('order', self::DEFAULT_SEARCH_SORT);
  87.         }
  89.         $this->handlePagination($request, $criteria, $event->getSalesChannelContext());
  90.         $this->handleFilters($request, $criteria, $context);
  91.         $this->handleSorting($request, $criteria, $context);
  92.     }
  94.     public function handleSearchRequest(ProductListingCriteriaEvent $event): void
  95.     {
  96.         $request = $event->getRequest();
  97.         $criteria = $event->getCriteria();
  98.         $context = $event->getSalesChannelContext();
  100.         if (!$request->get('order')) {
  101.             $request->request->set('order', self::DEFAULT_SEARCH_SORT);
  102.         }
  104.         $this->handlePagination($request, $criteria, $event->getSalesChannelContext());
  105.         $this->handleFilters($request, $criteria, $context);
  106.         $this->handleSorting($request, $criteria, $context);
  107.     }
  109.     public function handleResult(ProductListingResultEvent $event): void
  110.     {
  111.         $this->addCurrentFilters($event);
  113.         $result = $event->getResult();
  115.         $sortings = $this->sortingService->getAvailableSortings(
  116.             MagazineArticleDefinition::ENTITY_NAME,
  117.             $event->getSalesChannelContext()->getContext()
  118.         );
  120.         $currentSortingKey = $this->getCurrentSorting($sortings, $event->getRequest())->getKey();
  122.         $result->setSorting($currentSortingKey);
  123.         $result->setAvailableSortings($sortings);
  124.         $result->setPage($this->getPage($event->getRequest()));
  125.         $result->setLimit($this->getLimit($event->getRequest()));
  126.     }
  128.     private function handleFilters(Request $request, Criteria $criteria, SalesChannelContext $context): void
  129.     {
  130.         $filters = $this->getFilters($request, $context);
  132.         $aggregations = $this->getAggregations($request, $filters);
  134.         foreach ($aggregations as $aggregation) {
  135.             $criteria->addAggregation($aggregation);
  136.         }
  138.         if ($request->get('search')) {
  139.             $criteria->setTerm($request->get('search'));
  140.         }
  142.         foreach ($filters as $filter) {
  143.             if ($filter->isFiltered()) {
  144.                 $criteria->addPostFilter($filter->getFilter());
  145.             }
  146.         }
  148.         $criteria->addExtension('filters', $filters);
  149.     }
  151.     private function getAggregations(Request $request, FilterCollection $filters): array
  152.     {
  153.         $aggregations = [];
  155.         if ($request->get('reduce-aggregations') === null) {
  156.             foreach ($filters as $filter) {
  157.                 $aggregations = array_merge($aggregations, $filter->getAggregations());
  158.             }
  160.             return $aggregations;
  161.         }
  163.         foreach ($filters as $filter) {
  164.             $excluded = $filters->filtered();
  166.             if ($filter->exclude()) {
  167.                 $excluded = $excluded->blacklist($filter->getName());
  168.             }
  170.             foreach ($filter->getAggregations() as $aggregation) {
  171.                 if ($aggregation instanceof FilterAggregation) {
  172.                     $aggregation->addFilters($excluded->getFilters());
  174.                     $aggregations[] = $aggregation;
  176.                     continue;
  177.                 }
  179.                 $aggregation = new FilterAggregation(
  180.                     $aggregation->getName(),
  181.                     $aggregation,
  182.                     $excluded->getFilters()
  183.                 );
  185.                 $aggregations[] = $aggregation;
  186.             }
  187.         }
  189.         return $aggregations;
  190.     }
  192.     private function handlePagination(Request $request, Criteria $criteria, SalesChannelContext $context): void
  193.     {
  194.         $limit = $this->getLimit($request);
  195.         $page = $this->getPage($request);
  196.         $criteria->setOffset(($page - 1) * $limit);
  197.         $criteria->setLimit($limit);
  198.         $criteria->setTotalCountMode(Criteria::TOTAL_COUNT_MODE_EXACT);
  199.     }
  201.     private function handleSorting(Request $request, Criteria $criteria, SalesChannelContext $context): void
  202.     {
  203.         if ($criteria->getSorting()) {
  204.             return;
  205.         }
  207.         $sortings = $this->sortingService->getAvailableSortings(
  208.             MagazineArticleDefinition::ENTITY_NAME,
  209.             $context->getContext()
  210.         );
  211.         $currentSorting = $this->getCurrentSorting($sortings, $request);
  212.         $criteria->addSorting(...$currentSorting->createDalSorting());
  213.         $criteria->addExtension('sortings', $sortings);
  214.     }
  216.     private function getCurrentSorting(SortingCollection $sortings, Request $request): ProductSortingEntity
  217.     {
  218.         $key = $request->get('order');
  219.         $sorting = $sortings->getByKey($key);
  220.         if ($sorting !== null) {
  221.             return $sorting;
  222.         }
  223.         return $sortings->first();
  224.     }
  226.     private function addCurrentFilters(ProductListingResultEvent $event): void
  227.     {
  228.         $result = $event->getResult();
  229.         $filters = $result->getCriteria()->getExtension('filters');
  230.         if (!$filters instanceof FilterCollection) {
  231.             return;
  232.         }
  233.         foreach ($filters as $filter) {
  234.             $result->addCurrentFilter($filter->getName(), $filter->getValues());
  235.         }
  236.     }
  238.     private function getLimit(Request $request): int
  239.     {
  240.         $limit = $request->query->getInt('limit', 0);
  241.         if ($request->isMethod(Request::METHOD_POST)) {
  242.             $limit = $request->request->getInt('limit', $limit);
  243.         }
  244.         return $limit <= 0 ? 12 : $limit;
  245.     }
  247.     private function getPage(Request $request): int
  248.     {
  249.         $page = $request->query->getInt('p', 1);
  250.         if ($request->isMethod(Request::METHOD_POST)) {
  251.             $page = $request->request->getInt('p', $page);
  252.         }
  253.         return $page <= 0 ? 1 : $page;
  254.     }
  256.     private function getFilters(Request $request, SalesChannelContext $context): FilterCollection
  257.     {
  258.         $filters = new FilterCollection();
  259.         $filters->add($this->getCategoryFilter($request));
  260.         $filters->add($this->getTagFilter($request));
  261.         $filters->add($this->getAuthorFilter($request));
  263.         return $filters;
  264.     }
  266.     private function getCategoryFilter(Request $request): Filter
  267.     {
  268.         $ids = array_filter(explode('|', $request->query->get('moorl-magazine-article-category', '')));
  269.         return new Filter(
  270.             'moorl-magazine-article-category',
  271.             !empty($ids),
  272.             [new EntityAggregation('moorl-magazine-article-category', 'moorl_magazine_article.categories.id', MagazineCategoryDefinition::ENTITY_NAME)],
  273.             new EqualsAnyFilter('moorl_magazine_article.categories.id', $ids),
  274.             $ids
  275.         );
  276.     }
  278.     private function getTagFilter(Request $request): Filter
  279.     {
  280.         $ids = array_filter(explode('|', $request->query->get('moorl-magazine-article-tag', '')));
  281.         return new Filter(
  282.             'moorl-magazine-article-tag',
  283.             !empty($ids),
  284.             [new EntityAggregation('moorl-magazine-article-tag', 'moorl_magazine_article.tags.id', TagDefinition::ENTITY_NAME)],
  285.             new EqualsAnyFilter('moorl_magazine_article.tags.id', $ids),
  286.             $ids
  287.         );
  288.     }
  290.     private function getAuthorFilter(Request $request): Filter
  291.     {
  292.         $ids = array_filter(explode('|', $request->query->get('moorl-magazine-article-author', '')));
  293.         return new Filter(
  294.             'moorl-magazine-article-author',
  295.             !empty($ids),
  296.             [new EntityAggregation('moorl-magazine-article-author', 'moorl_magazine_article.creatorId', CreatorDefinition::ENTITY_NAME)],
  297.             new EqualsAnyFilter('moorl_magazine_article.creatorId', $ids),
  298.             $ids
  299.         );
  300.     }
  301. }