custom/plugins/DtgsGoogleTagManagerSw6/src/Subscriber/GeneralSubscriber.php line 137

Open in your IDE?
  1. <?php declare(strict_types=1);
  3. namespace Dtgs\GoogleTagManager\Subscriber;
  5. use Dtgs\GoogleTagManager\Services\AdwordsService;
  6. use Dtgs\GoogleTagManager\Services\CustomerTagsService;
  7. use Dtgs\GoogleTagManager\Services\DatalayerService;
  8. use Dtgs\GoogleTagManager\Services\EnhancedEcommerceService;
  9. use Dtgs\GoogleTagManager\Services\Ga4Service;
  10. use Dtgs\GoogleTagManager\Services\GeneralTagsService;
  11. use Dtgs\GoogleTagManager\Services\RemarketingService;
  12. use Shopware\Core\Content\Cms\Aggregate\CmsSlot\CmsSlotEntity;
  13. use Shopware\Core\Content\Cms\SalesChannel\Struct\ProductListingStruct;
  14. use Shopware\Core\Content\Product\SalesChannel\SalesChannelProductEntity;
  15. use Shopware\Core\Framework\Struct\ArrayEntity;
  16. use Shopware\Core\Framework\Struct\Struct;
  17. use Shopware\Core\PlatformRequest;
  18. use Shopware\Core\System\SalesChannel\SalesChannelContext;
  19. use Shopware\Core\System\SystemConfig\SystemConfigService;
  20. use Shopware\Storefront\Page\Account\Login\AccountLoginPageLoadedEvent;
  21. use Shopware\Storefront\Page\Account\Order\AccountEditOrderPageLoadedEvent;
  22. use Shopware\Storefront\Page\Account\Order\AccountOrderPageLoadedEvent;
  23. use Shopware\Storefront\Page\Account\Overview\AccountOverviewPageLoadedEvent;
  24. use Shopware\Storefront\Page\Account\PaymentMethod\AccountPaymentMethodPageLoadedEvent;
  25. use Shopware\Storefront\Page\Account\Profile\AccountProfilePageLoadedEvent;
  26. use Shopware\Storefront\Page\Address\Listing\AddressListingPageLoadedEvent;
  27. use Shopware\Storefront\Page\Checkout\Cart\CheckoutCartPageLoadedEvent;
  28. use Shopware\Storefront\Page\Checkout\Confirm\CheckoutConfirmPageLoadedEvent;
  29. use Shopware\Storefront\Page\Checkout\Finish\CheckoutFinishPageLoadedEvent;
  30. use Shopware\Storefront\Page\Checkout\Register\CheckoutRegisterPageLoadedEvent;
  31. use Shopware\Storefront\Page\Contact\ContactPageLoadedEvent;
  32. use Shopware\Storefront\Page\LandingPage\LandingPageLoadedEvent;
  33. use Shopware\Storefront\Page\Maintenance\MaintenancePageLoadedEvent;
  34. use Shopware\Storefront\Page\Navigation\Error\ErrorPageLoadedEvent;
  35. use Shopware\Storefront\Page\Navigation\NavigationPageLoadedEvent;
  36. use Shopware\Storefront\Page\Newsletter\Register\NewsletterRegisterPageLoadedEvent;
  37. use Shopware\Storefront\Page\Newsletter\Subscribe\NewsletterSubscribePageLoadedEvent;
  38. use Shopware\Storefront\Page\Page;
  39. use Shopware\Storefront\Page\PageLoadedEvent;
  40. use Shopware\Storefront\Page\Product\ProductPageLoadedEvent;
  41. use Shopware\Storefront\Page\Search\SearchPageLoadedEvent;
  42. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  43. use Symfony\Component\HttpKernel\Event\ResponseEvent;
  44. use Symfony\Component\HttpKernel\KernelEvents;
  46. class GeneralSubscriber implements EventSubscriberInterface
  47. {
  48.     /**
  49.      * @var SystemConfigService
  50.      */
  51.     private $systemConfigService;
  52.     /**
  53.      * @var DatalayerService
  54.      */
  55.     private $datalayerService;
  56.     /**
  57.      * @var Ga4Service
  58.      */
  59.     private $ga4Service;
  60.     /**
  61.      * @var EnhancedEcommerceService
  62.      */
  63.     private $enhancedEcomService;
  64.     /**
  65.      * @var RemarketingService
  66.      */
  67.     private $remarketingService;
  68.     /**
  69.      * @var AdwordsService
  70.      */
  71.     private $adwordsService;
  72.     /**
  73.      * @var GeneralTagsService
  74.      */
  75.     private $generalTagsService;
  76.     /**
  77.      * @var CustomerTagsService
  78.      */
  79.     private $customerTagsService;
  81.     public function __construct(SystemConfigService $systemConfigService,
  82.                                 DatalayerService $datalayerService,
  83.                                 Ga4Service $ga4Service,
  84.                                 EnhancedEcommerceService $enhancedEcomService,
  85.                                 RemarketingService $remarketingService,
  86.                                 AdwordsService $adwordsService,
  87.                                 GeneralTagsService $generalTagsService,
  88.                                 CustomerTagsService $customerTagsService)
  89.     {
  90.         $this->systemConfigService = $systemConfigService;
  91.         $this->datalayerService = $datalayerService;
  92.         $this->ga4Service = $ga4Service;
  93.         $this->enhancedEcomService = $enhancedEcomService;
  94.         $this->remarketingService = $remarketingService;
  95.         $this->adwordsService = $adwordsService;
  96.         $this->generalTagsService = $generalTagsService;
  97.         $this->customerTagsService = $customerTagsService;
  98.     }
  100.     public static function getSubscribedEvents(): array
  101.     {
  102.         return [
  103.             ProductPageLoadedEvent::class => 'onPageLoaded',
  104.             //
  105.             CheckoutCartPageLoadedEvent::class => 'onPageLoaded',
  106.             CheckoutConfirmPageLoadedEvent::class => 'onPageLoaded',
  107.             CheckoutRegisterPageLoadedEvent::class => 'onPageLoaded',
  108.             CheckoutFinishPageLoadedEvent::class => 'onPageLoaded',
  109.             //
  110.             AccountOverviewPageLoadedEvent::class => 'onPageLoaded',
  111.             AccountProfilePageLoadedEvent::class => 'onPageLoaded',
  112.             AccountLoginPageLoadedEvent::class => 'onPageLoaded',
  113.             AccountOrderPageLoadedEvent::class => 'onPageLoaded',
  114.             AccountPaymentMethodPageLoadedEvent::class => 'onPageLoaded',
  115.             AddressListingPageLoadedEvent::class => 'onPageLoaded',
  116.             //
  117.             SearchPageLoadedEvent::class => 'onPageLoaded',
  118.             //
  119.             NavigationPageLoadedEvent::class => 'onPageLoaded',
  120.             LandingPageLoadedEvent::class => 'onPageLoaded',
  121.             //
  122.             ErrorPageLoadedEvent::class => 'onPageLoaded',
  123.             MaintenancePageLoadedEvent::class => 'onPageLoaded',
  124.             ContactPageLoadedEvent::class => 'onPageLoaded',
  125.             //
  126.             NewsletterRegisterPageLoadedEvent::class => 'onPageLoaded',
  127.             NewsletterSubscribePageLoadedEvent::class => 'onPageLoaded',
  128.         ];
  129.     }
  131.     /**
  132.      * Event für alle Seiten
  133.      *
  134.      * @param PageLoadedEvent $event
  135.      * @throws \Exception
  136.      */
  137.     public function onPageLoaded($event)
  138.     {
  139.         /** @var Page $page */
  140.         $page = $event->getPage();
  141.         $status = 'enabled';
  143.         $salesChannelId = $event->getSalesChannelContext()->getSalesChannel()->getId();
  144.         $containerIds = $this->datalayerService->getContainerIds($salesChannelId);
  145.         if(!$containerIds) {
  146.             $status = 'disabled';
  147.         }
  149.         //The following tags will always be there
  150.         $generalTags = $this->generalTagsService->getGeneralTags($page, $event->getSalesChannelContext()->getContext(), $event->getRequest());
  151.         $customerTags = $this->customerTagsService->getCustomerTags($event->getSalesChannelContext()->getCustomer(), $event->getSalesChannelContext()->getContext());
  152.         $utmTags = $this->generalTagsService->getUtmTags($event->getRequest());
  153.         //Specific page tags
  154.         $navigationTags = [];
  155.         $accountTags = [];
  156.         $detailTags = [];
  157.         $checkoutTags = [];
  158.         $searchTags = [];
  159.         //Remarketing - V6.0.1
  160.         $remarketingTags = [];
  161.         //EnhancedEcommerce - 6.0.2
  162.         $enhancedEcomTags = [];
  163.         //GA4 - 6.2.0
  164.         $ga4Tags = [];
  166.         switch (get_class($event)) {
  167.             case ProductPageLoadedEvent::class:
  168.                 $detailTags = $this->datalayerService->getDetailTags($event->getPage()->getProduct(), $event->getSalesChannelContext());
  169.                 $remarketingTags = $this->remarketingService->getDetailTags($event->getPage()->getProduct(), $event->getSalesChannelContext());
  170.                 $ga4Tags = $this->ga4Service->getDetailTags($event->getPage()->getProduct(), $event->getSalesChannelContext());
  171.                 $enhancedEcomTags = $this->enhancedEcomService->getDetailTags($event->getPage()->getProduct(), $event->getSalesChannelContext());
  173.                 $page->addExtension('GtmAddToCartInfo', new ArrayEntity([
  174.                     'price' => $enhancedEcomTags['ecommerce']['detail']['products'][0]['price'],
  175.                     'sku' => $enhancedEcomTags['ecommerce']['detail']['products'][0]['id'],
  176.                 ]));
  177.                 break;
  178.             case CheckoutCartPageLoadedEvent::class:
  179.             case CheckoutConfirmPageLoadedEvent::class:
  180.             case CheckoutRegisterPageLoadedEvent::class:
  181.                 $checkoutTags = $this->datalayerService->getCheckoutTags($page->getCart(), $event->getSalesChannelContext());
  182.                 $remarketingTags = $this->remarketingService->getCheckoutTags($page->getCart(), $event->getSalesChannelContext());
  183.                 $ga4Tags = $this->ga4Service->getCheckoutTags($page->getCart(), $event);
  184.                 $enhancedEcomTags = $this->enhancedEcomService->getCheckoutTags($page->getCart(), $event);
  185.                 break;
  186.             case CheckoutFinishPageLoadedEvent::class:
  187.                 $checkoutTags = $this->datalayerService->getFinishTags($page->getOrder(), $event->getSalesChannelContext());
  188.                 $remarketingTags = $this->remarketingService->getPurchaseConfirmationTags($page->getOrder(), $event->getSalesChannelContext());
  189.                 $ga4Tags = $this->ga4Service->getPurchaseConfirmationTags($page->getOrder(), $event->getSalesChannelContext());
  190.                 $enhancedEcomTags = $this->enhancedEcomService->getPurchaseConfirmationTags($page->getOrder(), $event->getSalesChannelContext());
  191.                 break;
  192.             case AccountOverviewPageLoadedEvent::class:
  193.             case AccountProfilePageLoadedEvent::class:
  194.             case AccountLoginPageLoadedEvent::class:
  195.             case AccountEditOrderPageLoadedEvent::class:
  196.             case AccountOrderPageLoadedEvent::class:
  197.             case AddressListingPageLoadedEvent::class:
  198.             case AccountPaymentMethodPageLoadedEvent::class:
  199.                 $accountTags = $this->datalayerService->getAccountTags();
  200.                 $remarketingTags = $this->remarketingService->getBasicTags($event->getRequest());
  201.                 break;
  202.             case SearchPageLoadedEvent::class:
  203.                 $searchTags = $this->datalayerService->getSearchTags($page->getSearchTerm(), $page->getListing());
  204.                 $remarketingTags = $this->remarketingService->getSearchTags($event->getRequest());
  205.                 $enhancedEcomTags = $this->enhancedEcomService->getSearchTags($page->getSearchTerm(), $page->getListing(), $event->getSalesChannelContext());
  206.                 break;
  207.             case NavigationPageLoadedEvent::class:
  208.                 $navigationId = $event->getRequest()->get('navigationId', $event->getSalesChannelContext()->getSalesChannel()->getNavigationCategoryId());
  209.                 $navigationTags = $this->datalayerService->getNavigationTags($navigationId, $event->getSalesChannelContext());
  211.                 /** @var SalesChannelProductEntity[] $products */
  212.                 $listing = $this->getListingOnNavigationPage($event->getPage());
  213.                 if($listing) {
  214.                     $remarketingTags = $this->remarketingService->getNavigationTags($navigationId, $listing, $event->getSalesChannelContext(), $event->getRequest());
  215.                     $enhancedEcomTags = $this->enhancedEcomService->getNavigationTags($navigationId, $listing, $event->getSalesChannelContext());
  216.                     $ga4Tags = $this->ga4Service->getNavigationTags($navigationId, $listing, $event->getSalesChannelContext());
  217.                 }
  218.                 else {
  219.                     $remarketingTags = $this->remarketingService->getBasicTags($event->getRequest());
  220.                     $enhancedEcomTags = $this->enhancedEcomService->getBasicTags($event->getSalesChannelContext());
  221.                 }
  222.                 break;
  223.             case ErrorPageLoadedEvent::class:
  224.             case NewsletterRegisterPageLoadedEvent::class:
  225.             case NewsletterSubscribePageLoadedEvent::class:
  226.             case MaintenancePageLoadedEvent::class:
  227.             case ContactPageLoadedEvent::class:
  228.             case LandingPageLoadedEvent::class:
  229.             default:
  230.                 $remarketingTags = $this->remarketingService->getBasicTags($event->getRequest());
  231.                 $enhancedEcomTags = $this->enhancedEcomService->getBasicTags($event->getSalesChannelContext());
  232.                 break;
  233.         }
  235.         $datalayerTags = $this->datalayerService->prepareTagsForView(
  236.             $generalTags,
  237.             $navigationTags,
  238.             $accountTags,
  239.             $detailTags,
  240.             $checkoutTags,
  241.             $customerTags,
  242.             $utmTags,
  243.             $searchTags
  244.         );
  246.         $remarketingTags = $this->remarketingService->prepareTagsForView($remarketingTags);
  247.         $ga4Tags = $this->ga4Service->prepareTagsForView($ga4Tags);
  248.         $enhancedEcomTags = $this->enhancedEcomService->prepareTagsForView($enhancedEcomTags);
  250.         $tagManagerConfig = $this->datalayerService->getGtmConfig($salesChannelId);
  251.         $adwords_tracking_enabled = isset($tagManagerConfig['googleAdwordsId']) && $tagManagerConfig['googleAdwordsId'] != '';
  253.         /**
  254.          * UserCentrics compatiblity & CookieFirst compatiblity - since 6.1.26
  255.          */
  256.         $additionalServiceCode = '';
  257.         if(isset($tagManagerConfig['usercentricsEnabled']) && $tagManagerConfig['usercentricsEnabled'] === true) {
  258.             $additionalServiceCode .= ' type="text/plain" data-usercentrics="Google Tag Manager"';
  259.         }
  260.         if(isset($tagManagerConfig['cookiefirstEnabled']) && $tagManagerConfig['cookiefirstEnabled'] === true) {
  261.             $additionalServiceCode .= ' type="text/plain" data-cookiefirst-script="google_tag_manager"';
  262.         }
  264.         $page->addExtension('GoogleTagManagerConfig', new ArrayEntity([
  265.             'containerIds' => $containerIds,
  266.             'tags' => $datalayerTags,
  267.             'remarketing_tags' => $remarketingTags,
  268.             'ga4_tags' => $ga4Tags,
  269.             'enhancedecommerce_tags' => $enhancedEcomTags,
  270.             'adwords_tracking_enabled' => $adwords_tracking_enabled,
  271.             'status' => $status,
  272.             'additionalServiceCode' => $additionalServiceCode,
  273.         ]));
  275.     }
  277.     /**
  278.      * @param Struct $page
  279.      * @return array|void
  280.      */
  281.     private function getListingOnNavigationPage(Struct $page)
  282.     {
  283.         $cmsPage = $page->getCmsPage();
  285.         if (!$cmsPage || $cmsPage->getType() !== 'product_list') {
  286.             return;
  287.         }
  289.         $slots = $cmsPage->getSections()->getBlocks()->getSlots();
  290.         foreach($slots as $slot) {
  291.             /** @var CmsSlotEntity $slot */
  292.             if($slot->getType() == 'product-listing') {
  293.                 /** @var ProductListingStruct $productListingStruct */
  294.                 $productListingStruct = $slot->getData();
  295.                 break;
  296.             }
  297.         }
  298.         if(!isset($productListingStruct) || !is_a($productListingStruct, 'Shopware\Core\Content\Cms\SalesChannel\Struct\ProductListingStruct')) return;
  300.         return $productListingStruct->getListing()->getElements();
  301.     }
  302. }