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

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\GeneralTagsService;
  10. use Dtgs\GoogleTagManager\Services\RemarketingService;
  11. use Shopware\Core\Content\Cms\Aggregate\CmsSlot\CmsSlotEntity;
  12. use Shopware\Core\Content\Cms\SalesChannel\Struct\ProductListingStruct;
  13. use Shopware\Core\Content\Product\SalesChannel\SalesChannelProductEntity;
  14. use Shopware\Core\Framework\Struct\ArrayEntity;
  15. use Shopware\Core\Framework\Struct\Struct;
  16. use Shopware\Core\System\SystemConfig\SystemConfigService;
  17. use Shopware\Storefront\Page\Account\Login\AccountLoginPageLoadedEvent;
  18. use Shopware\Storefront\Page\Account\Order\AccountEditOrderPageLoadedEvent;
  19. use Shopware\Storefront\Page\Account\Order\AccountOrderPageLoadedEvent;
  20. use Shopware\Storefront\Page\Account\Overview\AccountOverviewPageLoadedEvent;
  21. use Shopware\Storefront\Page\Account\PaymentMethod\AccountPaymentMethodPageLoadedEvent;
  22. use Shopware\Storefront\Page\Account\Profile\AccountProfilePageLoadedEvent;
  23. use Shopware\Storefront\Page\Address\Listing\AddressListingPageLoadedEvent;
  24. use Shopware\Storefront\Page\Checkout\Cart\CheckoutCartPageLoadedEvent;
  25. use Shopware\Storefront\Page\Checkout\Confirm\CheckoutConfirmPageLoadedEvent;
  26. use Shopware\Storefront\Page\Checkout\Finish\CheckoutFinishPageLoadedEvent;
  27. use Shopware\Storefront\Page\Checkout\Register\CheckoutRegisterPageLoadedEvent;
  28. use Shopware\Storefront\Page\Contact\ContactPageLoadedEvent;
  29. use Shopware\Storefront\Page\Maintenance\MaintenancePageLoadedEvent;
  30. use Shopware\Storefront\Page\Navigation\Error\ErrorPageLoadedEvent;
  31. use Shopware\Storefront\Page\Navigation\NavigationPageLoadedEvent;
  32. use Shopware\Storefront\Page\Newsletter\Register\NewsletterRegisterPageLoadedEvent;
  33. use Shopware\Storefront\Page\Newsletter\Subscribe\NewsletterSubscribePageLoadedEvent;
  34. use Shopware\Storefront\Page\Page;
  35. use Shopware\Storefront\Page\PageLoadedEvent;
  36. use Shopware\Storefront\Page\Product\ProductPageLoadedEvent;
  37. use Shopware\Storefront\Page\Search\SearchPageLoadedEvent;
  38. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  40. class GeneralSubscriber implements EventSubscriberInterface
  41. {
  42.     /**
  43.      * @var SystemConfigService
  44.      */
  45.     private $systemConfigService;
  46.     /**
  47.      * @var DatalayerService
  48.      */
  49.     private $datalayerService;
  50.     /**
  51.      * @var EnhancedEcommerceService
  52.      */
  53.     private $enhancedEcomService;
  54.     /**
  55.      * @var RemarketingService
  56.      */
  57.     private $remarketingService;
  58.     /**
  59.      * @var AdwordsService
  60.      */
  61.     private $adwordsService;
  62.     /**
  63.      * @var GeneralTagsService
  64.      */
  65.     private $generalTagsService;
  66.     /**
  67.      * @var CustomerTagsService
  68.      */
  69.     private $customerTagsService;
  71.     public function __construct(SystemConfigService $systemConfigService,
  72.                                 DatalayerService $datalayerService,
  73.                                 EnhancedEcommerceService $enhancedEcomService,
  74.                                 RemarketingService $remarketingService,
  75.                                 AdwordsService $adwordsService,
  76.                                 GeneralTagsService $generalTagsService,
  77.                                 CustomerTagsService $customerTagsService)
  78.     {
  79.         $this->systemConfigService = $systemConfigService;
  80.         $this->datalayerService = $datalayerService;
  81.         $this->enhancedEcomService = $enhancedEcomService;
  82.         $this->remarketingService = $remarketingService;
  83.         $this->adwordsService = $adwordsService;
  84.         $this->generalTagsService = $generalTagsService;
  85.         $this->customerTagsService = $customerTagsService;
  86.     }
  88.     public static function getSubscribedEvents(): array
  89.     {
  90.         return [
  91.             ProductPageLoadedEvent::class => 'onPageLoaded',
  92.             //
  93.             CheckoutCartPageLoadedEvent::class => 'onPageLoaded',
  94.             CheckoutConfirmPageLoadedEvent::class => 'onPageLoaded',
  95.             CheckoutRegisterPageLoadedEvent::class => 'onPageLoaded',
  96.             CheckoutFinishPageLoadedEvent::class => 'onPageLoaded',
  97.             //
  98.             AccountOverviewPageLoadedEvent::class => 'onPageLoaded',
  99.             AccountProfilePageLoadedEvent::class => 'onPageLoaded',
  100.             AccountLoginPageLoadedEvent::class => 'onPageLoaded',
  101.             AccountOrderPageLoadedEvent::class => 'onPageLoaded',
  102.             AccountPaymentMethodPageLoadedEvent::class => 'onPageLoaded',
  103.             AddressListingPageLoadedEvent::class => 'onPageLoaded',
  104.             //
  105.             SearchPageLoadedEvent::class => 'onPageLoaded',
  106.             //
  107.             NavigationPageLoadedEvent::class => 'onPageLoaded',
  108.             //
  109.             ErrorPageLoadedEvent::class => 'onPageLoaded',
  110.             MaintenancePageLoadedEvent::class => 'onPageLoaded',
  111.             ContactPageLoadedEvent::class => 'onPageLoaded',
  112.             //
  113.             NewsletterRegisterPageLoadedEvent::class => 'onPageLoaded',
  114.             NewsletterSubscribePageLoadedEvent::class => 'onPageLoaded',
  115.         ];
  116.     }
  118.     /**
  119.      * Event für alle Seiten
  120.      *
  121.      * @param PageLoadedEvent $event
  122.      * @throws \Exception
  123.      */
  124.     public function onPageLoaded($event)
  125.     {
  127.         /** @var Page $page */
  128.         $page = $event->getPage();
  130.         $salesChannelId = $event->getSalesChannelContext()->getSalesChannel()->getId();
  131.         $containerIds = $this->datalayerService->getContainerIds($salesChannelId);
  132.         if(!$containerIds) return;
  134.         //The following tags will always be there
  135.         $generalTags = $this->generalTagsService->getGeneralTags($page, $event->getSalesChannelContext()->getContext(), $event->getRequest());
  136.         $customerTags = $this->customerTagsService->getCustomerTags($event->getSalesChannelContext()->getCustomer(), $event->getSalesChannelContext()->getContext());
  137.         $customGetTags = $this->generalTagsService->getCustomGetParamsTags($event->getRequest());
  138.         $utmTags = $this->generalTagsService->getUtmTags($event->getRequest());
  139.         //Specific page tags
  140.         $navigationTags = [];
  141.         $accountTags = [];
  142.         $detailTags = [];
  143.         $checkoutTags = [];
  144.         $searchTags = [];
  145.         //Remarketing - V6.0.1
  146.         $remarketingTags = [];
  147.         //EnhancedEcommerce - 6.0.2
  148.         $enhancedEcomTags = [];
  149.         //Adwords - 6.1.0
  150.         $adwordsTags = [];
  152.         switch (get_class($event)) {
  153.             case ProductPageLoadedEvent::class:
  154.                 $detailTags = $this->datalayerService->getDetailTags($event->getPage()->getProduct(), $event->getSalesChannelContext());
  155.                 $remarketingTags = $this->remarketingService->getDetailTags($event->getPage()->getProduct(), $event->getSalesChannelContext());
  156.                 $enhancedEcomTags = $this->enhancedEcomService->getDetailTags($event->getPage()->getProduct(), $event->getSalesChannelContext());
  158.                 $page->addExtension('GtmAddToCartInfo', new ArrayEntity([
  159.                     'price' => $enhancedEcomTags['ecommerce']['detail']['products'][0]['price'],
  160.                     'sku' => $enhancedEcomTags['ecommerce']['detail']['products'][0]['id'],
  161.                 ]));
  162.                 break;
  163.             case CheckoutCartPageLoadedEvent::class:
  164.             case CheckoutConfirmPageLoadedEvent::class:
  165.             case CheckoutRegisterPageLoadedEvent::class:
  166.                 $checkoutTags = $this->datalayerService->getCheckoutTags($page->getCart(), $event->getSalesChannelContext());
  167.                 $remarketingTags = $this->remarketingService->getCheckoutTags($page->getCart());
  168.                 $enhancedEcomTags = $this->enhancedEcomService->getCheckoutTags($page->getCart(), $event);
  169.                 break;
  170.             case CheckoutFinishPageLoadedEvent::class:
  171.                 $checkoutTags = $this->datalayerService->getFinishTags($page->getOrder(), $event->getSalesChannelContext());
  172.                 $remarketingTags = $this->remarketingService->getPurchaseConfirmationTags($page->getOrder());
  173.                 $enhancedEcomTags = $this->enhancedEcomService->getPurchaseConfirmationTags($page->getOrder(), $event->getSalesChannelContext());
  174.                 $adwordsTags = $this->adwordsService->getPurchaseConfirmationTags($page->getOrder(), $event->getSalesChannelContext());
  175.                 break;
  176.             case AccountOverviewPageLoadedEvent::class:
  177.             case AccountProfilePageLoadedEvent::class:
  178.             case AccountLoginPageLoadedEvent::class:
  179.             case AccountEditOrderPageLoadedEvent::class:
  180.             case AccountOrderPageLoadedEvent::class:
  181.             case AddressListingPageLoadedEvent::class:
  182.             case AccountPaymentMethodPageLoadedEvent::class:
  183.                 $accountTags = $this->datalayerService->getAccountTags();
  184.                 $remarketingTags = $this->remarketingService->getBasicTags();
  185.                 break;
  186.             case SearchPageLoadedEvent::class:
  187.                 $searchTags = $this->datalayerService->getSearchTags($page->getSearchTerm(), $page->getListing());
  188.                 $remarketingTags = $this->remarketingService->getSearchTags();
  189.                 $enhancedEcomTags = $this->enhancedEcomService->getSearchTags($page->getSearchTerm(), $page->getListing(), $event->getSalesChannelContext());
  190.                 break;
  191.             case NavigationPageLoadedEvent::class:
  192.                 $navigationId = $event->getRequest()->get('navigationId', $event->getSalesChannelContext()->getSalesChannel()->getNavigationCategoryId());
  193.                 $navigationTags = $this->datalayerService->getNavigationTags();
  195.                 /** @var SalesChannelProductEntity[] $products */
  196.                 $listing = $this->getListingOnNavigationPage($event->getPage());
  197.                 if($listing) {
  198.                     $remarketingTags = $this->remarketingService->getNavigationTags($navigationId, $listing, $event->getSalesChannelContext());
  199.                     $enhancedEcomTags = $this->enhancedEcomService->getNavigationTags($navigationId, $listing, $event->getSalesChannelContext());
  200.                 }
  201.                 else {
  202.                     $remarketingTags = $this->remarketingService->getBasicTags();
  203.                     $enhancedEcomTags = $this->enhancedEcomService->getBasicTags($event->getSalesChannelContext());
  204.                 }
  205.                 break;
  206.             case ErrorPageLoadedEvent::class:
  207.             case NewsletterRegisterPageLoadedEvent::class:
  208.             case NewsletterSubscribePageLoadedEvent::class:
  209.             case MaintenancePageLoadedEvent::class:
  210.             case ContactPageLoadedEvent::class:
  211.             default:
  212.                 $remarketingTags = $this->remarketingService->getBasicTags();
  213.                 $enhancedEcomTags = $this->enhancedEcomService->getBasicTags($event->getSalesChannelContext());
  214.                 break;
  215.         }
  217.         $datalayerTags = $this->datalayerService->prepareTagsForView(
  218.             $generalTags,
  219.             $navigationTags,
  220.             $accountTags,
  221.             $detailTags,
  222.             $checkoutTags,
  223.             $customerTags,
  224.             $customGetTags,
  225.             $utmTags,
  226.             $searchTags
  227.         );
  229.         $remarketingTags = $this->remarketingService->prepareTagsForView($remarketingTags);
  230.         $enhancedEcomTags = $this->enhancedEcomService->prepareTagsForView($enhancedEcomTags);
  231.         $adwordsTags = $this->adwordsService->prepareTagsForView($adwordsTags);
  233.         $tagManagerConfig = $this->datalayerService->getGtmConfig($salesChannelId);
  234.         $adwords_tracking_enabled = (isset($tagManagerConfig['googleAdwordsId']) && $tagManagerConfig['googleAdwordsId'] != '') ? true : false;
  236.         $page->addExtension('GoogleTagManagerConfig', new ArrayEntity([
  237.             'containerIds' => $containerIds,
  238.             'tags' => $datalayerTags,
  239.             'remarketing_tags' => $remarketingTags,
  240.             'enhancedecommerce_tags' => $enhancedEcomTags,
  241.             'adwords_tracking_enabled' => $adwords_tracking_enabled,
  242.             'adwords_tags' => $adwordsTags,
  243.         ]));
  245.     }
  247.     /**
  248.      * @param Struct $page
  249.      * @return array|void
  250.      */
  251.     private function getListingOnNavigationPage(Struct $page)
  252.     {
  253.         $cmsPage = $page->getCmsPage();
  255.         if (!$cmsPage || $cmsPage->getType() !== 'product_list') {
  256.             return;
  257.         }
  259.         $slots = $cmsPage->getSections()->getBlocks()->getSlots();
  260.         foreach($slots as $slot) {
  261.             /** @var CmsSlotEntity $slot */
  262.             if($slot->getType() == 'product-listing') {
  263.                 /** @var ProductListingStruct $productListingStruct */
  264.                 $productListingStruct = $slot->getData();
  265.                 break;
  266.             }
  267.         }
  268.         if(!is_a($productListingStruct, 'Shopware\Core\Content\Cms\SalesChannel\Struct\ProductListingStruct')) return;
  270.         return $productListingStruct->getListing()->getElements();
  271.     }
  272. }