Merge pull request #1159 from magento-folks/bugs

[Folks] Bugfixes

Author: Alexander Akimov

app/code/Magento/GoogleAnalytics/Block/Ga.php

@@ -8,6 +8,8 @@
 
 namespace Magento\GoogleAnalytics\Block;
 
+use Magento\Framework\App\ObjectManager;
+
 /**
  * GoogleAnalytics Page Block
  *
@@ -27,20 +29,28 @@ class Ga extends \Magento\Framework\View\Element\Template
      */
     protected $_salesOrderCollection;
 
+    /**
+     * @var \Magento\Cookie\Helper\Cookie
+     */
+    private $cookieHelper;
+
     /**
      * @param \Magento\Framework\View\Element\Template\Context $context
      * @param \Magento\Sales\Model\ResourceModel\Order\CollectionFactory $salesOrderCollection
      * @param \Magento\GoogleAnalytics\Helper\Data $googleAnalyticsData
      * @param array $data
+     * @param \Magento\Cookie\Helper\Cookie|null $cookieHelper
      */
     public function __construct(
         \Magento\Framework\View\Element\Template\Context $context,
         \Magento\Sales\Model\ResourceModel\Order\CollectionFactory $salesOrderCollection,
         \Magento\GoogleAnalytics\Helper\Data $googleAnalyticsData,
-        array $data = []
+        array $data = [],
+        \Magento\Cookie\Helper\Cookie $cookieHelper = null
     ) {
         $this->_googleAnalyticsData = $googleAnalyticsData;
         $this->_salesOrderCollection = $salesOrderCollection;
+        $this->cookieHelper = $cookieHelper ?: ObjectManager::getInstance()->get(\Magento\Cookie\Helper\Cookie::class);
         parent::__construct($context, $data);
     }
 
@@ -73,22 +83,17 @@ public function getPageName()
      * @return string
      * @link https://developers.google.com/analytics/devguides/collection/analyticsjs/method-reference#set
      * @link https://developers.google.com/analytics/devguides/collection/analyticsjs/method-reference#gaObjectMethods
+     * @deprecated please use getPageTrackingData method
      */
     public function getPageTrackingCode($accountId)
     {
-        $pageName = trim($this->getPageName());
-        $optPageURL = '';
-        if ($pageName && substr($pageName, 0, 1) == '/' && strlen($pageName) > 1) {
-            $optPageURL = ", '" . $this->escapeHtmlAttr($pageName, false) . "'";
-        }
-
         $anonymizeIp = "";
         if ($this->_googleAnalyticsData->isAnonymizedIpActive()) {
             $anonymizeIp = "\nga('set', 'anonymizeIp', true);";
         }
 
         return "\nga('create', '" . $this->escapeHtmlAttr($accountId, false)
-           . "', 'auto');{$anonymizeIp}\nga('send', 'pageview'{$optPageURL});\n";
+           . "', 'auto');{$anonymizeIp}\nga('send', 'pageview'{$this->getOptPageUrl()});\n";
     }
 
     /**
@@ -99,6 +104,7 @@ public function getPageTrackingCode($accountId)
      * @link https://developers.google.com/analytics/devguides/collection/analyticsjs/enhanced-ecommerce#transaction
      *
      * @return string|void
+     * @deprecated please use getOrdersTrackingData method
      */
     public function getOrdersTrackingCode()
     {
@@ -162,4 +168,97 @@ protected function _toHtml()
 
         return parent::_toHtml();
     }
+
+    /**
+     * Return cookie restriction mode value.
+     *
+     * @return bool
+     */
+    public function isCookieRestrictionModeEnabled()
+    {
+        return $this->cookieHelper->isCookieRestrictionModeEnabled();
+    }
+
+    /**
+     * Return current website id.
+     *
+     * @return int
+     */
+    public function getCurrentWebsiteId()
+    {
+        return $this->_storeManager->getWebsite()->getId();
+    }
+
+    /**
+     * Return information about page for GA tracking
+     *
+     * @link https://developers.google.com/analytics/devguides/collection/analyticsjs/method-reference#set
+     * @link https://developers.google.com/analytics/devguides/collection/analyticsjs/method-reference#gaObjectMethods
+     *
+     * @param string $accountId
+     * @return array
+     */
+    public function getPageTrackingData($accountId)
+    {
+        return [
+            'optPageUrl' => $this->getOptPageUrl(),
+            'isAnonymizedIpActive' => $this->_googleAnalyticsData->isAnonymizedIpActive(),
+            'accountId' => $this->escapeHtmlAttr($accountId, false)
+        ];
+    }
+
+    /**
+     * Return information about order and items for GA tracking.
+     *
+     * @link https://developers.google.com/analytics/devguides/collection/analyticsjs/enhanced-ecommerce#checkout-options
+     * @link https://developers.google.com/analytics/devguides/collection/analyticsjs/enhanced-ecommerce#measuring-transactions
+     * @link https://developers.google.com/analytics/devguides/collection/analyticsjs/enhanced-ecommerce#transaction
+     *
+     * @return array
+     */
+    public function getOrdersTrackingData()
+    {
+        $result = [];
+        $orderIds = $this->getOrderIds();
+        if (empty($orderIds) || !is_array($orderIds)) {
+            return $result;
+        }
+
+        $collection = $this->_salesOrderCollection->create();
+        $collection->addFieldToFilter('entity_id', ['in' => $orderIds]);
+
+        foreach ($collection as $order) {
+            foreach ($order->getAllVisibleItems() as $item) {
+                $result['products'][] = [
+                    'id' => $this->escapeJs($item->getSku()),
+                    'name' =>  $this->escapeJs($item->getName()),
+                    'price' => $item->getBasePrice(),
+                    'quantity' => $item->getQtyOrdered(),
+                ];
+            }
+            $result['orders'][] = [
+                'id' =>  $order->getIncrementId(),
+                'affiliation' => $this->escapeJs($this->_storeManager->getStore()->getFrontendName()),
+                'revenue' => $order->getBaseGrandTotal(),
+                'tax' => $order->getBaseTaxAmount(),
+                'shipping' => $order->getBaseShippingAmount(),
+            ];
+        }
+        return $result;
+    }
+
+    /**
+     * Return page url for tracking.
+     *
+     * @return string
+     */
+    private function getOptPageUrl()
+    {
+        $optPageURL = '';
+        $pageName = trim($this->getPageName());
+        if ($pageName && substr($pageName, 0, 1) == '/' && strlen($pageName) > 1) {
+            $optPageURL = ", '" . $this->escapeHtmlAttr($pageName, false) . "'";
+        }
+        return $optPageURL;
+    }
 }

app/code/Magento/GoogleAnalytics/Helper/Data.php

@@ -3,12 +3,10 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
-
-// @codingStandardsIgnoreFile
-
 namespace Magento\GoogleAnalytics\Helper;
 
 use Magento\Store\Model\Store;
+use Magento\Store\Model\ScopeInterface;
 
 /**
  * GoogleAnalytics data helper
@@ -33,8 +31,8 @@ class Data extends \Magento\Framework\App\Helper\AbstractHelper
      */
     public function isGoogleAnalyticsAvailable($store = null)
     {
-        $accountId = $this->scopeConfig->getValue(self::XML_PATH_ACCOUNT, \Magento\Store\Model\ScopeInterface::SCOPE_STORE, $store);
-        return $accountId && $this->scopeConfig->isSetFlag(self::XML_PATH_ACTIVE, \Magento\Store\Model\ScopeInterface::SCOPE_STORE, $store);
+        $accountId = $this->scopeConfig->getValue(self::XML_PATH_ACCOUNT, ScopeInterface::SCOPE_STORE, $store);
+        return $accountId && $this->scopeConfig->isSetFlag(self::XML_PATH_ACTIVE, ScopeInterface::SCOPE_STORE, $store);
     }
 
     /**
@@ -45,7 +43,6 @@ public function isGoogleAnalyticsAvailable($store = null)
      */
     public function isAnonymizedIpActive($store = null)
     {
-        $anonymize = $this->scopeConfig->getValue(self::XML_PATH_ANONYMIZE, \Magento\Store\Model\ScopeInterface::SCOPE_STORE, $store);
-        return $anonymize;
+        return $this->scopeConfig->getValue(self::XML_PATH_ANONYMIZE, ScopeInterface::SCOPE_STORE, $store);
     }
 }