Implement more events

Hlavtox · Hlavtox · commit 2fc509fbf0c7 · 2023-11-04T23:36:05.000+01:00
diff --git a/classes/GoogleAnalyticsTools.php b/classes/GoogleAnalyticsTools.php
@@ -24,23 +24,6 @@
 
 class GoogleAnalyticsTools
 {
-    /**
-     * filter
-     *
-     * @param string $gaScripts
-     * @param int $filterable
-     *
-     * @return string
-     */
-    public function filter($gaScripts, $filterable)
-    {
-        if (1 == $filterable) {
-            return implode(';', array_unique(explode(';', $gaScripts)));
-        }
-
-        return $gaScripts;
-    }
-
     /**
      * Renders purchase event for order
      *
@@ -68,21 +51,12 @@ public function renderPurchaseEvent($orderProducts, $orderData, $callbackUrl)
             'tax' => (float) $orderData['tax'],
             'shipping' => (float) $orderData['shipping'],
             'currency' => $orderData['currency'],
-            'items' => [],
+            'items' => $orderProducts,
             'event_callback' => "function() {
                 $.get('" . $callbackUrl . "', " . json_encode($callbackData, JSON_UNESCAPED_UNICODE) . ');
             }',
         ];
 
-        foreach ($orderProducts as $product) {
-            $eventData['items'][] = [
-                'item_id' => (int) $product['id'],
-                'item_name' => $product['name'],
-                'quantity' => (int) $product['quantity'],
-                'price' => (float) $product['price'],
-            ];
-        }
-
         return $this->renderEvent(
             'purchase',
             $eventData,
diff --git a/classes/Hook/HookDisplayBackOfficeHeader.php b/classes/Hook/HookDisplayBackOfficeHeader.php
@@ -167,9 +167,7 @@ public function processOrder($idOrder)
         $orderProducts = [];
         $cart = new Cart($order->id_cart);
         if (Validate::isLoadedObject($cart)) {
-            foreach ($cart->getProducts() as $order_product) {
-                $orderProducts[] = $productWrapper->wrapProduct($order_product);
-            }
+            $orderProducts = $productWrapper->prepareItemListFromProductList($cart->getProducts(), true);
         }
 
         // Render transaction code
diff --git a/classes/Hook/HookDisplayBeforeBodyClosingTag.php b/classes/Hook/HookDisplayBeforeBodyClosingTag.php
@@ -53,22 +53,21 @@ public function run()
         // Prepare our tag handler
         $gaTagHandler = new GanalyticsJsHandler($this->module, $this->context);
 
-        // Add events for item listing
-        $this->renderProductListing();
+        // Log information about product listing
+        $this->saveInformationAboutListing();
 
-        // Add events for search
+        // Add events
+        $this->renderProductListing();
         $this->renderSearch();
-        
-        // Add events for search
         $this->renderCartPage();
-
-        // Render begin checkout
         $this->renderBeginCheckout();
+        $this->renderLogin();
+        $this->renderRegistration();
 
         // TODO
-        // Sign_up event after registration, we need to check if the register was submitted
-        // Login event, we need to check if the login was done in this request
+        // Unify wrappers - add proper quantities for cart items
         // Cart actions adding/removing
+        // Shipping info
 
         return $gaTagHandler->generate($this->gaScripts);
         die;
@@ -83,8 +82,6 @@ public function run()
         $controller_name = Tools::getValue('controller');
 
         if (count($gacarts) > 0 && $controller_name != 'product') {
-            $this->module->filterable = 0;
-
             foreach ($gacarts as $key => $gacart) {
                 if (isset($gacart['quantity'])) {
                     if ($gacart['quantity'] > 0) {
@@ -153,8 +150,6 @@ public function run()
 
     /**
      * This method renders tracking code for product listings, like category pages.
-     *
-     * @return string
      */
     private function renderProductListing()
     {
@@ -166,20 +161,13 @@ private function renderProductListing()
 
         // Prepare items to our format
         $productWrapper = new ProductWrapper($this->context);
-        $items = [];
-        $counter = 0;
-        foreach ($listing['products'] as $product) {
-            $product = $productWrapper->prepareItemFromProductLazyArray($product);
-            $product['index'] = $counter;
-            $items[] = $product;
-            $counter++;
-        }
-
+        $items = $productWrapper->prepareItemListFromProductList($listing['products']);
+        
         // Prepare info about the list
         $item_list_id = $this->context->controller->php_self;
         $item_list_name = $listing['label'];
 
-        // Render the listing event
+        // Render the event
         $eventData = [
             'item_list_id' => $item_list_id,
             'item_list_name' => $item_list_name,
@@ -201,7 +189,7 @@ private function renderSearch()
             return;
         }
 
-        // Render the listing event
+        // Render the event
         $eventData = [
             'search_term' => (string) $_GET['s'],
         ];
@@ -213,8 +201,6 @@ private function renderSearch()
 
     /**
      * This method renders tracking code for product listings, like category pages.
-     *
-     * @return string
      */
     private function renderCartpage()
     {
@@ -231,16 +217,9 @@ private function renderCartpage()
 
         // Prepare items to our format
         $productWrapper = new ProductWrapper($this->context);
-        $items = [];
-        $counter = 0;
-        foreach ($cart['products'] as $product) {
-            $product = $productWrapper->prepareItemFromProductLazyArray($product);
-            $product['index'] = $counter;
-            $items[] = $product;
-            $counter++;
-        }
-
-        // Render the listing event
+        $items = $productWrapper->prepareItemListFromProductList($cart['products'], true);
+        
+        // Render the event
         $eventData = [
             'currency' => $this->context->currency->iso_code,
             'value' => $cart['totals']['total']['amount'],
@@ -254,8 +233,6 @@ private function renderCartpage()
 
     /**
      * This method renders tracking code for product listings, like category pages.
-     *
-     * @return string
      */
     private function renderBeginCheckout()
     {
@@ -284,16 +261,9 @@ private function renderBeginCheckout()
 
         // Prepare items to our format
         $productWrapper = new ProductWrapper($this->context);
-        $items = [];
-        $counter = 0;
-        foreach ($cart['products'] as $product) {
-            $product = $productWrapper->prepareItemFromProductLazyArray($product);
-            $product['index'] = $counter;
-            $items[] = $product;
-            $counter++;
-        }
+        $items = $productWrapper->prepareItemListFromProductList($cart['products'], true);
 
-        // Render the listing event
+        // Render the event
         $eventData = [
             'currency' => $this->context->currency->iso_code,
             'value' => $cart['totals']['total']['amount'],
@@ -304,4 +274,53 @@ private function renderBeginCheckout()
             $eventData
         );
     }
+
+    /**
+     * This method renders tracking code after user logs in.
+     */
+    private function renderLogin()
+    {
+        // Render it only on login page AND if we are not creating a new account in older PS versions
+        // For newer versions, registrations are handled with standalone registration controller.
+        if ($this->context->controller->php_self != 'authentication' || isset($_GET['create_account'])) {
+            return;
+        }
+
+        // Render the event
+        $this->gaScripts .= $this->module->getTools()->renderEvent('login', []);
+    }
+
+    /**
+     * This method renders tracking code after user registers.
+     */
+    private function renderRegistration()
+    {
+        if ($this->context->controller->php_self != 'registration' &&
+            ($this->context->controller->php_self != 'authentication' || !isset($_GET['create_account']))
+        ) {
+            return;
+        }
+
+        // Render the event
+        $this->gaScripts .= $this->module->getTools()->renderEvent('sign_up', []);
+    }
+
+    /**
+     * Saves information about last visited product listing, so we can later use it for select_item event.
+     */
+    private function saveInformationAboutListing()
+    {
+        // Try to get product list variable
+        $listing = $this->context->smarty->getTemplateVars('listing');
+        if (empty($listing['products']) || empty($listing['label'])) {
+            return;
+        }
+
+        // Save this information to a cookie
+        $this->context->cookie->ga_last_listing = json_encode([
+            'item_list_url' => $_SERVER['REQUEST_URI'],
+            'item_list_id' => $this->context->controller->php_self,
+            'item_list_name' => $listing['label'],
+        ]);
+    }
 }
diff --git a/classes/Hook/HookDisplayFooterProduct.php b/classes/Hook/HookDisplayFooterProduct.php
@@ -59,11 +59,11 @@ public function run()
 
         // Prepare it and format it for our purpose
         $productWrapper = new ProductWrapper($this->context);
-        $item = $productWrapper->prepareItemFromProductLazyArray($product);
+        $item = $productWrapper->prepareItemFromProduct($product);
 
         $js = '';
 
-        // Prepare and render view_item event
+        // Prepare and render event
         $eventData = [
             'currency' => $this->context->currency->iso_code,
             'value' => $product['price_amount'],
@@ -75,13 +75,21 @@ public function run()
         );
 
         // If the user got to the product page from previous page on our shop,
-        // we will also send select_item event
+        // we will also send select_item event.
         if ($this->wasPreviousPageOurShop()) {
             $eventData = [
-                'currency' => $this->context->currency->iso_code,
-                'value' => $product['price_amount'],
                 'items' => [$item],
             ];
+
+            // We will also try to get the information about the last visited listing.
+            // We save this information into a cookie. If it's the page that got the user here,
+            // we will use it.
+            $previousListingData = $this->getLastVisitedListing();
+            if (!empty($previousListingData)) {
+                $eventData = array_merge($previousListingData, $eventData);
+            }
+
+            // Render the event
             $js .= $this->module->getTools()->renderEvent(
                 'select_item',
                 $eventData
@@ -91,11 +99,45 @@ public function run()
         return $gaTagHandler->generate($js);
     }
 
+    /**
+     * Checks HTTP_REFERER to see if the previous page that got user to this product
+     * was our shop.
+     *
+     * @return bool
+     */
     private function wasPreviousPageOurShop() {
-        if (isset($_SERVER['HTTP_REFERER']) && strpos($_SERVER['HTTP_REFERER'], $_SERVER['HTTP_HOST']) > 0) {
+        if (isset($_SERVER['HTTP_REFERER']) && strpos($_SERVER['HTTP_REFERER'], $_SERVER['HTTP_HOST']) !== false) {
             return true;
         }
 
         return false;
     }
+
+    /**
+     * Tries to get details of previous listing from the cookie.
+     *
+     * @return bool|array
+     */
+    private function getLastVisitedListing()
+    {
+        // Fetch it from the cookie
+        $last_listing = $this->context->cookie->ga_last_listing;
+        if (empty($last_listing)) {
+            return false;
+        }
+
+        // Decode the data and check if it contains something sensible
+        $last_listing = json_decode($last_listing, true);
+        if (empty($last_listing['item_list_id'])) {
+            return false;
+        }
+
+        // Check if the last listing is the page the user came from
+        if (isset($_SERVER['HTTP_REFERER']) && strpos($_SERVER['HTTP_REFERER'], $last_listing['item_list_url']) !== false) {
+            unset($last_listing['item_list_url']);
+            return $last_listing;
+        }
+
+        return false;
+    }
 }
diff --git a/classes/Hook/HookDisplayOrderConfirmation.php b/classes/Hook/HookDisplayOrderConfirmation.php
@@ -69,7 +69,7 @@ public function run()
 
         // If the customer is revisiting confirmation screen and the order was already sent, we don't do anything
         if ($ganalyticsRepository->hasOrderBeenAlreadySent((int) $order->id)) {
-            return $gaScripts;
+            // return $gaScripts;
         }
 
         // Prepare transaction data
@@ -88,9 +88,7 @@ public function run()
         $orderProducts = [];
         $cart = new Cart($order->id_cart);
         if (Validate::isLoadedObject($cart)) {
-            foreach ($cart->getProducts() as $order_product) {
-                $orderProducts[] = $productWrapper->wrapProduct($order_product);
-            }
+            $orderProducts = $productWrapper->prepareItemListFromProductList($cart->getProducts(), true);
         }
 
         // Render transaction code
diff --git a/classes/Wrapper/OrderWrapper.php b/classes/Wrapper/OrderWrapper.php
@@ -23,10 +23,9 @@
 use Configuration;
 use Context;
 use Currency;
-use PrestaShop\Module\Ps_Googleanalytics\Hooks\WrapperInterface;
 use Shop;
 
-class OrderWrapper implements WrapperInterface
+class OrderWrapper
 {
     private $context;
 
diff --git a/classes/Wrapper/ProductWrapper.php b/classes/Wrapper/ProductWrapper.php
diff --git a/classes/Wrapper/WrapperInterface.php b/classes/Wrapper/WrapperInterface.php
diff --git a/ps_googleanalytics.php b/ps_googleanalytics.php
