feat: Add per-SalesChannel activation setting (#93)

xndrdev · web-flow · commit a18a6dab6342 · 2026-01-19T09:47:24.000+01:00
* feat: add per-SalesChannel activation setting

Add new 'active' config option to enable/disable product compare functionality
per SalesChannel. When disabled:
- Compare routes return 404
- Compare buttons are hidden in storefront
- Cross-selling comparison is disabled
- Subscribers skip processing

This allows shop owners to selectively enable the compare feature
only for specific SalesChannels.

* chore: Increase version

* chore: Default enable true
diff --git a/composer.json b/composer.json
@@ -1,7 +1,7 @@
 {
     "name": "frosh/product-compare",
     "description": "A Simple Product Compare plugin for Shopware 6",
-    "version": "4.0.0",
+    "version": "4.0.1",
     "type": "shopware-platform-plugin",
     "license": "MIT",
     "authors": [
diff --git a/src/Controller/CompareProductController.php b/src/Controller/CompareProductController.php
@@ -6,10 +6,12 @@
 
 use Frosh\FroshProductCompare\Page\CompareProductPageLoader;
 use Shopware\Core\System\SalesChannel\SalesChannelContext;
+use Shopware\Core\System\SystemConfig\SystemConfigService;
 use Shopware\Storefront\Controller\StorefrontController;
 use Shopware\Storefront\Page\GenericPageLoaderInterface;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
+use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
 use Symfony\Component\Routing\Attribute\Route;
 
 #[Route(defaults: ['_routeScope' => ['storefront']])]
@@ -18,11 +20,14 @@ class CompareProductController extends StorefrontController
     public function __construct(
         private readonly CompareProductPageLoader $compareProductPageLoader,
         private readonly GenericPageLoaderInterface $genericPageLoader,
+        private readonly SystemConfigService $systemConfigService,
     ) {}
 
     #[Route(path: '/compare', name: 'frontend.compare.page', options: ['seo' => false], defaults: ['_httpCache' => false], methods: ['GET'])]
     public function comparePage(Request $request, SalesChannelContext $context): Response
     {
+        $this->ensureCompareIsActive($context);
+
         $page = $this->genericPageLoader->load($request, $context);
 
         return $this->renderStorefront('@FroshProductCompare/storefront/page/compare.html.twig', ['page' => $page]);
@@ -31,6 +36,8 @@ public function comparePage(Request $request, SalesChannelContext $context): Res
     #[Route(path: '/compare/content', name: 'frontend.compare.content', options: ['seo' => false], defaults: ['_httpCache' => false, 'XmlHttpRequest' => true], methods: ['POST'])]
     public function comparePageContent(Request $request, SalesChannelContext $context): Response
     {
+        $this->ensureCompareIsActive($context);
+
         $productIds = $request->request->all('productIds');
         $productIds = array_values(array_filter($productIds, is_string(...)));
 
@@ -42,11 +49,20 @@ public function comparePageContent(Request $request, SalesChannelContext $contex
     #[Route(path: '/compare/offcanvas', name: 'frontend.compare.offcanvas', options: ['seo' => false], defaults: ['_httpCache' => false, 'XmlHttpRequest' => true], methods: ['POST'])]
     public function offcanvas(Request $request, SalesChannelContext $context): Response
     {
+        $this->ensureCompareIsActive($context);
+
         $productIds = $request->request->all('productIds');
         $productIds = array_filter($productIds, is_string(...));
 
         $page = $this->compareProductPageLoader->loadPreview($productIds, $request, $context);
 
         return $this->renderStorefront('@FroshProductCompare/storefront/component/compare/offcanvas-compare-list.html.twig', ['page' => $page]);
     }
+
+    private function ensureCompareIsActive(SalesChannelContext $context): void
+    {
+        if (!$this->systemConfigService->getBool('FroshProductCompare.config.active', $context->getSalesChannelId())) {
+            throw new NotFoundHttpException('Product compare is not enabled for this sales channel');
+        }
+    }
 }
diff --git a/src/DependencyInjection/services.xml b/src/DependencyInjection/services.xml
@@ -26,6 +26,7 @@
         <service id="Frosh\FroshProductCompare\Controller\CompareProductController" public="true">
             <argument type="service" id="Frosh\FroshProductCompare\Page\CompareProductPageLoader"/>
             <argument type="service" id="Shopware\Storefront\Page\GenericPageLoader"/>
+            <argument type="service" id="Shopware\Core\System\SystemConfig\SystemConfigService"/>
             <call method="setContainer">
                 <argument type="service" id="service_container"/>
             </call>
@@ -35,10 +36,12 @@
         <service id="Frosh\FroshProductCompare\Subscriber\FroshCrossSellingProductListingSubscriber">
             <argument type="service" id="Frosh\FroshProductCompare\Page\CompareProductPageLoader"/>
             <argument type="service" id="Shopware\Core\Content\Product\Cart\ProductGateway"/>
+            <argument type="service" id="Shopware\Core\System\SystemConfig\SystemConfigService"/>
             <tag name="kernel.event_subscriber"/>
         </service>
 
         <service id="Frosh\FroshProductCompare\Subscriber\FroshProductGatewayCriteriaSubscriber">
+            <argument type="service" id="Shopware\Core\System\SystemConfig\SystemConfigService"/>
             <tag name="kernel.event_subscriber"/>
         </service>
 
diff --git a/src/Resources/config/config.xml b/src/Resources/config/config.xml
@@ -5,6 +5,13 @@
         <title>Product Compare Configuration</title>
         <title lang="de-DE">Produktvergleichskonfiguration</title>
 
+        <input-field type="bool">
+            <name>active</name>
+            <label>Enable Product Compare</label>
+            <label lang="de-DE">Produktvergleich aktivieren</label>
+            <defaultValue>true</defaultValue>
+        </input-field>
+
         <input-field type="bool">
             <name>showIconOnly</name>
             <label>Add to compare with icon only</label>
diff --git a/src/Resources/views/storefront/base.html.twig b/src/Resources/views/storefront/base.html.twig
@@ -3,7 +3,9 @@
 {% block base_body_inner %}
     {{ parent() }}
 
-    {% block frosh_product_compare_float_button_container %}
-        {% sw_include '@Storefront/storefront/component/compare/compare-float.html.twig' %}
-    {% endblock %}
+    {% if config('FroshProductCompare.config.active') %}
+        {% block frosh_product_compare_float_button_container %}
+            {% sw_include '@Storefront/storefront/component/compare/compare-float.html.twig' %}
+        {% endblock %}
+    {% endif %}
 {% endblock %}
diff --git a/src/Resources/views/storefront/component/product/card/action.html.twig b/src/Resources/views/storefront/component/product/card/action.html.twig
@@ -3,7 +3,7 @@
 {% block component_product_box_action_buy %}
     {{ parent() }}
 
-    {% if activeRoute != 'frontend.compare.content' %}
+    {% if config('FroshProductCompare.config.active') and activeRoute != 'frontend.compare.content' %}
         {% block component_product_box_action_add_to_compare_button %}
             {% sw_include '@Storefront/storefront/component/product/card/compare-button.html.twig' %}
         {% endblock %}
@@ -13,7 +13,7 @@
 {% block component_product_box_action_detail %}
     {{ parent() }}
 
-    {% if activeRoute != 'frontend.compare.content' %}
+    {% if config('FroshProductCompare.config.active') and activeRoute != 'frontend.compare.content' %}
         {% block component_product_box_action_detail_add_to_compare_button %}
             {% sw_include '@Storefront/storefront/component/product/card/compare-button.html.twig' %}
         {% endblock %}
diff --git a/src/Resources/views/storefront/element/cms-element-cross-selling.html.twig b/src/Resources/views/storefront/element/cms-element-cross-selling.html.twig
@@ -7,7 +7,7 @@
             {% set products = item.products %}
             {% set id = crossSelling.id %}
             {% set crossSellingComparable = item.crossSelling.extensions.crossSellingComparable %}
-            {% if crossSellingComparable and crossSellingComparable.isComparable %}
+            {% if config('FroshProductCompare.config.active') and crossSellingComparable and crossSellingComparable.isComparable %}
                 {% set page = {
                     products: products,
                     properties: crossSelling.extensions.compareProperties
diff --git a/src/Resources/views/storefront/layout/header/header.html.twig b/src/Resources/views/storefront/layout/header/header.html.twig
@@ -3,7 +3,7 @@
 {% block layout_header_search_toggle %}
     {{ parent() }}
 
-    {% if config('FroshProductCompare.config.showInHeader') %}
+    {% if config('FroshProductCompare.config.active') and config('FroshProductCompare.config.showInHeader') %}
         {% block frosh_product_compare_widget_button %}
             <div class="col-auto">
                 {% sw_include '@Storefront/storefront/component/compare/compare-float.html.twig' with {
diff --git a/src/Resources/views/storefront/page/product-detail/buy-widget.html.twig b/src/Resources/views/storefront/page/product-detail/buy-widget.html.twig
@@ -3,13 +3,15 @@
 {% block page_product_detail_buy_container %}
     {{ parent() }}
 
-    {% block page_product_detail_add_to_compare_button %}
-        <div class="mb-2">
-            {% sw_include '@Storefront/storefront/component/product/card/compare-button.html.twig' with {
-                navigationTree: page.header.navigation.tree,
-                categoryTree: page.product.categoryTree|last,
-                product: page.product
-            } only %}
-        </div>
-    {% endblock %}
+    {% if config('FroshProductCompare.config.active') %}
+        {% block page_product_detail_add_to_compare_button %}
+            <div class="mb-2">
+                {% sw_include '@Storefront/storefront/component/product/card/compare-button.html.twig' with {
+                    navigationTree: page.header.navigation.tree,
+                    categoryTree: page.product.categoryTree|last,
+                    product: page.product
+                } only %}
+            </div>
+        {% endblock %}
+    {% endif %}
 {% endblock %}
diff --git a/src/Subscriber/FroshCrossSellingProductListingSubscriber.php b/src/Subscriber/FroshCrossSellingProductListingSubscriber.php
@@ -20,13 +20,15 @@
 use Shopware\Core\Framework\DataAbstractionLayer\Search\Filter\MultiFilter;
 use Shopware\Core\Framework\DataAbstractionLayer\Search\Filter\NotFilter;
 use Shopware\Core\System\SalesChannel\SalesChannelContext;
+use Shopware\Core\System\SystemConfig\SystemConfigService;
 use Symfony\Component\EventDispatcher\EventSubscriberInterface;
 
 class FroshCrossSellingProductListingSubscriber implements EventSubscriberInterface
 {
     public function __construct(
         private readonly CompareProductPageLoader $compareProductPageLoader,
         private readonly ProductGatewayInterface $productGateway,
+        private readonly SystemConfigService $systemConfigService,
     ) {}
 
     public static function getSubscribedEvents(): array
@@ -46,6 +48,12 @@ public static function getSubscribedEvents(): array
 
     public function handleCriteriaLoadedRequest(ProductCrossSellingCriteriaEvent $event): void
     {
+        $context = $event->getSalesChannelContext();
+
+        if (!$this->systemConfigService->getBool('FroshProductCompare.config.active', $context->getSalesChannelId())) {
+            return;
+        }
+
         $crossSelling = $event->getCrossSelling();
         $crossSellingComparable = $crossSelling->getExtension('crossSellingComparable');
 
@@ -76,10 +84,14 @@ public function handleCriteriaLoadedRequest(ProductCrossSellingCriteriaEvent $ev
 
     public function handleCrossSellingLoadedEvent(ProductCrossSellingsLoadedEvent $event): void
     {
-        $crossSellings = $event->getCrossSellings();
-
         $salesChannelContext = $event->getSalesChannelContext();
 
+        if (!$this->systemConfigService->getBool('FroshProductCompare.config.active', $salesChannelContext->getSalesChannelId())) {
+            return;
+        }
+
+        $crossSellings = $event->getCrossSellings();
+
         /** @var CrossSellingElement $crossSellingElement */
         foreach ($crossSellings as $crossSellingElement) {
             $crossSelling = $crossSellingElement->getCrossSelling();
diff --git a/src/Subscriber/FroshProductGatewayCriteriaSubscriber.php b/src/Subscriber/FroshProductGatewayCriteriaSubscriber.php
@@ -5,10 +5,15 @@
 namespace Frosh\FroshProductCompare\Subscriber;
 
 use Shopware\Core\Content\Product\Events\ProductGatewayCriteriaEvent;
+use Shopware\Core\System\SystemConfig\SystemConfigService;
 use Symfony\Component\EventDispatcher\EventSubscriberInterface;
 
 class FroshProductGatewayCriteriaSubscriber implements EventSubscriberInterface
 {
+    public function __construct(
+        private readonly SystemConfigService $systemConfigService,
+    ) {}
+
     public static function getSubscribedEvents(): array
     {
         return [
@@ -20,6 +25,12 @@ public static function getSubscribedEvents(): array
 
     public function handleCriteriaLoadedRequest(ProductGatewayCriteriaEvent $event): void
     {
+        $context = $event->getSalesChannelContext();
+
+        if (!$this->systemConfigService->getBool('FroshProductCompare.config.active', $context->getSalesChannelId())) {
+            return;
+        }
+
         $criteria = $event->getCriteria();
 
         $criteria->addAssociation('prices')->addAssociation('manufacturer');

Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "frosh/product-compare",`
`3`	`3`	`"description": "A Simple Product Compare plugin for Shopware 6",`
`4`		`- "version": "4.0.0",`
	`4`	`+ "version": "4.0.1",`
`5`	`5`	`"type": "shopware-platform-plugin",`
`6`	`6`	`"license": "MIT",`
`7`	`7`	`"authors": [`