custom/plugins/HemoCustomerGroupRestriction/src/Subscriber/ProductVisibilitySubscriber.php line 54

Open in your IDE?
  1. <?php declare(strict_types=1);
  3. namespace Hemo\CustomerGroupRestriction\Subscriber;
  5. use Hemo\CustomerGroupRestriction\Service\ProductRestrictionLoader;
  6. use Shopware\Core\Content\Category\Event\CategoryRouteCacheKeyEvent;
  7. use Shopware\Core\Content\LandingPage\Event\LandingPageRouteCacheKeyEvent;
  8. use Shopware\Core\Content\Product\Events\CrossSellingRouteCacheKeyEvent;
  9. use Shopware\Core\Content\Product\Events\ProductDetailRouteCacheKeyEvent;
  10. use Shopware\Core\Content\Product\Events\ProductListingRouteCacheKeyEvent;
  11. use Shopware\Core\Content\Product\Events\ProductSearchRouteCacheKeyEvent;
  12. use Shopware\Core\Content\Product\Events\ProductSuggestRouteCacheKeyEvent;
  13. use Shopware\Core\Framework\Adapter\Cache\StoreApiRouteCacheKeyEvent;
  14. use Shopware\Core\Framework\DataAbstractionLayer\Search\Filter\EqualsAnyFilter;
  15. use Shopware\Core\Framework\DataAbstractionLayer\Search\Filter\EqualsFilter;
  16. use Shopware\Core\Framework\DataAbstractionLayer\Search\Filter\MultiFilter;
  17. use Shopware\Core\Framework\DataAbstractionLayer\Search\Filter\NotFilter;
  18. use Shopware\Core\System\SalesChannel\Event\SalesChannelProcessCriteriaEvent;
  19. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  21. /**
  22.  * Hides restricted products from every sales channel product read (listing, search, suggest,
  23.  * detail page, CMS sliders, cross selling, Store API) for customers outside the allowed groups.
  24.  */
  25. final class ProductVisibilitySubscriber implements EventSubscriberInterface
  26. {
  27.     /**
  28.      * Criteria title used by Shopware's ProductGateway when loading cart products. The cart
  29.      * processor handles that case itself and reports a meaningful error to the customer.
  30.      */
  31.     private const CART_CRITERIA_TITLE = 'cart::products';
  33.     private ProductRestrictionLoader $loader;
  35.     public function __construct(ProductRestrictionLoader $loader)
  36.     {
  37.         $this->loader = $loader;
  38.     }
  40.     public static function getSubscribedEvents(): array
  41.     {
  42.         return [
  43.             'sales_channel.product.process.criteria' => 'onProcessCriteria',
  44.             ProductListingRouteCacheKeyEvent::class => 'onCacheKey',
  45.             ProductSearchRouteCacheKeyEvent::class => 'onCacheKey',
  46.             ProductSuggestRouteCacheKeyEvent::class => 'onCacheKey',
  47.             ProductDetailRouteCacheKeyEvent::class => 'onCacheKey',
  48.             CrossSellingRouteCacheKeyEvent::class => 'onCacheKey',
  49.             CategoryRouteCacheKeyEvent::class => 'onCacheKey',
  50.             LandingPageRouteCacheKeyEvent::class => 'onCacheKey',
  51.         ];
  52.     }
  54.     public function onProcessCriteria(SalesChannelProcessCriteriaEvent $event): void
  55.     {
  56.         $criteria = $event->getCriteria();
  58.         if ($criteria->getTitle() === self::CART_CRITERIA_TITLE) {
  59.             return;
  60.         }
  62.         $customerGroupId = $event->getSalesChannelContext()->getCurrentCustomerGroup()->getId();
  63.         $hiddenIds = $this->loader->getHiddenProductIds($customerGroupId);
  65.         if ($hiddenIds === []) {
  66.             return;
  67.         }
  69.         // A variant without a restriction of its own inherits the parent's restriction.
  70.         $parentVisibility = [
  71.             new EqualsFilter('product.parentId', null),
  72.             new NotFilter(NotFilter::CONNECTION_AND, [new EqualsAnyFilter('product.parentId', $hiddenIds)]),
  73.         ];
  75.         $ownRestriction = $this->loader->getRestrictedProductIds();
  76.         if ($ownRestriction !== []) {
  77.             $parentVisibility[] = new EqualsAnyFilter('product.id', $ownRestriction);
  78.         }
  80.         $criteria->addFilter(new MultiFilter(MultiFilter::CONNECTION_AND, [
  81.             new NotFilter(NotFilter::CONNECTION_AND, [new EqualsAnyFilter('product.id', $hiddenIds)]),
  82.             new MultiFilter(MultiFilter::CONNECTION_OR, $parentVisibility),
  83.         ]));
  84.     }
  86.     /**
  87.      * The cached Store API routes build their cache key before the criteria is processed, so the
  88.      * customer group has to become part of the key explicitly.
  89.      */
  90.     public function onCacheKey(StoreApiRouteCacheKeyEvent $event): void
  91.     {
  92.         $event->addPart($event->getContext()->getCurrentCustomerGroup()->getId());
  93.     }
  94. }