Skip to content

Commit 2ae2987

Browse files
ishakhsuvarovishakhsuvarov
authored
Merge pull request #7649 from magento-amigos/gtag
[Amigos] Community contributions – Gtag + PB Bundled
2 parents 320c2e5 + e729015 commit 2ae2987

File tree

38 files changed

+1955
-23
lines changed

38 files changed

+1955
-23
lines changed

‎app/code/Magento/GoogleGtag/Block/Ga.php

Lines changed: 200 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,200 @@
1+
<?php
2+
/**
3+
* Copyright © Magento, Inc. All rights reserved.
4+
* See COPYING.txt for license details.
5+
*/
6+
declare(strict_types=1);
7+
8+
namespace Magento\GoogleGtag\Block;
9+
10+
use Magento\Cookie\Helper\Cookie;
11+
use Magento\Framework\Api\SearchCriteriaBuilder;
12+
use Magento\Framework\Serialize\SerializerInterface;
13+
use Magento\Framework\View\Element\Template;
14+
use Magento\Framework\View\Element\Template\Context;
15+
use Magento\GoogleGtag\Model\Config\GtagConfig as GtagConfiguration;
16+
use Magento\Sales\Api\OrderRepositoryInterface;
17+
18+
/**
19+
* GoogleAnalytics Page Block
20+
*
21+
* @api
22+
*/
23+
class Ga extends Template
24+
{
25+
/**
26+
* @var GtagConfiguration
27+
*/
28+
private $googleGtagConfig;
29+
30+
/**
31+
* @var Cookie
32+
*/
33+
private $cookieHelper;
34+
35+
/**
36+
* @var SerializerInterface
37+
*/
38+
private $serializer;
39+
40+
/**
41+
* @var OrderRepositoryInterface
42+
*/
43+
private $orderRepository;
44+
45+
/**
46+
* @var SearchCriteriaBuilder
47+
*/
48+
private $searchCriteriaBuilder;
49+
50+
/**
51+
* @param Context $context
52+
* @param GtagConfiguration $googleGtagConfig
53+
* @param Cookie $cookieHelper
54+
* @param SerializerInterface $serializer
55+
* @param SearchCriteriaBuilder $searchCriteriaBuilder
56+
* @param OrderRepositoryInterface $orderRepository
57+
* @param array $data
58+
*/
59+
public function __construct(
60+
Context $context,
61+
GtagConfiguration $googleGtagConfig,
62+
Cookie $cookieHelper,
63+
SerializerInterface $serializer,
64+
SearchCriteriaBuilder $searchCriteriaBuilder,
65+
OrderRepositoryInterface $orderRepository,
66+
array $data = []
67+
) {
68+
$this->googleGtagConfig = $googleGtagConfig;
69+
$this->cookieHelper = $cookieHelper;
70+
$this->serializer = $serializer;
71+
$this->orderRepository = $orderRepository;
72+
$this->searchCriteriaBuilder = $searchCriteriaBuilder;
73+
parent::__construct($context, $data);
74+
}
75+
76+
/**
77+
* Get a specific page name (may be customized via layout)
78+
*
79+
* @return string|null
80+
*/
81+
public function getPageName(): ?string
82+
{
83+
return $this->_getData('page_name');
84+
}
85+
86+
/**
87+
* Return cookie restriction mode value.
88+
*
89+
* @return bool
90+
*/
91+
public function isCookieRestrictionModeEnabled(): bool
92+
{
93+
return (bool) $this->cookieHelper->isCookieRestrictionModeEnabled();
94+
}
95+
96+
/**
97+
* Return current website id.
98+
*
99+
* @return int
100+
*/
101+
public function getCurrentWebsiteId(): int
102+
{
103+
return (int) $this->_storeManager->getWebsite()->getId();
104+
}
105+
106+
/**
107+
* Return information about page for GA tracking
108+
*
109+
* @link https://developers.google.com/analytics/devguides/collection/gtagjs
110+
* @link https://developers.google.com/analytics/devguides/collection/ga4
111+
*
112+
* @param string $measurementId
113+
* @return array
114+
*/
115+
public function getPageTrackingData($measurementId): array
116+
{
117+
return [
118+
'optPageUrl' => $this->getOptPageUrl(),
119+
'measurementId' => $this->escapeHtmlAttr($measurementId, false)
120+
];
121+
}
122+
123+
/**
124+
* Return information about order and items for GA tracking.
125+
*
126+
* @link https://developers.google.com/analytics/devguides/collection/ga4/ecommerce#purchase
127+
* @link https://developers.google.com/gtagjs/reference/ga4-events#purchase
128+
* @link https://developers.google.com/analytics/devguides/collection/gtagjs/enhanced-ecommerce#product-data
129+
* @link https://developers.google.com/gtagjs/reference/event#purchase
130+
*
131+
* @return array
132+
*/
133+
public function getOrdersTrackingData(): array
134+
{
135+
$result = [];
136+
$orderIds = $this->getOrderIds();
137+
if (empty($orderIds) || !is_array($orderIds)) {
138+
return $result;
139+
}
140+
$this->searchCriteriaBuilder->addFilter(
141+
'entity_id',
142+
$orderIds,
143+
'in'
144+
);
145+
$collection = $this->orderRepository->getList($this->searchCriteriaBuilder->create());
146+
147+
foreach ($collection->getItems() as $order) {
148+
foreach ($order->getAllVisibleItems() as $item) {
149+
$result['products'][] = [
150+
'item_id' => $this->escapeJsQuote($item->getSku()),
151+
'item_name' => $this->escapeJsQuote($item->getName()),
152+
'price' => number_format((float) $item->getPrice(), 2),
153+
'quantity' => (int)$item->getQtyOrdered(),
154+
];
155+
}
156+
$result['orders'][] = [
157+
'transaction_id' => $order->getIncrementId(),
158+
'affiliation' => $this->escapeJsQuote($this->_storeManager->getStore()->getFrontendName()),
159+
'value' => number_format((float) $order->getGrandTotal(), 2),
160+
'tax' => number_format((float) $order->getTaxAmount(), 2),
161+
'shipping' => number_format((float) $order->getShippingAmount(), 2),
162+
];
163+
$result['currency'] = $order->getOrderCurrencyCode();
164+
}
165+
return $result;
166+
}
167+
168+
/**
169+
* Return page url for tracking.
170+
*
171+
* @return string
172+
*/
173+
private function getOptPageUrl(): string
174+
{
175+
$optPageURL = '';
176+
$pageName = $this->getPageName() !== null ? trim($this->getPageName()) : '';
177+
if ($pageName && substr($pageName, 0, 1) === '/' && strlen($pageName) > 1) {
178+
$optPageURL = ", '" . $this->escapeHtmlAttr($pageName, false) . "'";
179+
}
180+
return $optPageURL;
181+
}
182+
183+
/**
184+
* Provide analytics events data
185+
*
186+
* @return bool|string
187+
*/
188+
public function getAnalyticsData()
189+
{
190+
$analyticData = [
191+
'isCookieRestrictionModeEnabled' => $this->isCookieRestrictionModeEnabled(),
192+
'currentWebsite' => $this->getCurrentWebsiteId(),
193+
'cookieName' => Cookie::IS_USER_ALLOWED_SAVE_COOKIE,
194+
'pageTrackingData' => $this->getPageTrackingData($this->googleGtagConfig->getMeasurementId()),
195+
'ordersTrackingData' => $this->getOrdersTrackingData(),
196+
'googleAnalyticsAvailable' => $this->googleGtagConfig->isGoogleAnalyticsAvailable()
197+
];
198+
return $this->serializer->serialize($analyticData);
199+
}
200+
}

‎app/code/Magento/GoogleGtag/LICENSE.txt

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
2+
Open Software License ("OSL") v. 3.0
3+
4+
This Open Software License (the "License") applies to any original work of authorship (the "Original Work") whose owner (the "Licensor") has placed the following licensing notice adjacent to the copyright notice for the Original Work:
5+
6+
Licensed under the Open Software License version 3.0
7+
8+
1. Grant of Copyright License. Licensor grants You a worldwide, royalty-free, non-exclusive, sublicensable license, for the duration of the copyright, to do the following:
9+
10+
1. to reproduce the Original Work in copies, either alone or as part of a collective work;
11+
12+
2. to translate, adapt, alter, transform, modify, or arrange the Original Work, thereby creating derivative works ("Derivative Works") based upon the Original Work;
13+
14+
3. to distribute or communicate copies of the Original Work and Derivative Works to the public, with the proviso that copies of Original Work or Derivative Works that You distribute or communicate shall be licensed under this Open Software License;
15+
16+
4. to perform the Original Work publicly; and
17+
18+
5. to display the Original Work publicly.
19+
20+
2. Grant of Patent License. Licensor grants You a worldwide, royalty-free, non-exclusive, sublicensable license, under patent claims owned or controlled by the Licensor that are embodied in the Original Work as furnished by the Licensor, for the duration of the patents, to make, use, sell, offer for sale, have made, and import the Original Work and Derivative Works.
21+
22+
3. Grant of Source Code License. The term "Source Code" means the preferred form of the Original Work for making modifications to it and all available documentation describing how to modify the Original Work. Licensor agrees to provide a machine-readable copy of the Source Code of the Original Work along with each copy of the Original Work that Licensor distributes. Licensor reserves the right to satisfy this obligation by placing a machine-readable copy of the Source Code in an information repository reasonably calculated to permit inexpensive and convenient access by You for as long as Licensor continues to distribute the Original Work.
23+
24+
4. Exclusions From License Grant. Neither the names of Licensor, nor the names of any contributors to the Original Work, nor any of their trademarks or service marks, may be used to endorse or promote products derived from this Original Work without express prior permission of the Licensor. Except as expressly stated herein, nothing in this License grants any license to Licensor's trademarks, copyrights, patents, trade secrets or any other intellectual property. No patent license is granted to make, use, sell, offer for sale, have made, or import embodiments of any patent claims other than the licensed claims defined in Section 2. No license is granted to the trademarks of Licensor even if such marks are included in the Original Work. Nothing in this License shall be interpreted to prohibit Licensor from licensing under terms different from this License any Original Work that Licensor otherwise would have a right to license.
25+
26+
5. External Deployment. The term "External Deployment" means the use, distribution, or communication of the Original Work or Derivative Works in any way such that the Original Work or Derivative Works may be used by anyone other than You, whether those works are distributed or communicated to those persons or made available as an application intended for use over a network. As an express condition for the grants of license hereunder, You must treat any External Deployment by You of the Original Work or a Derivative Work as a distribution under section 1(c).
27+
28+
6. Attribution Rights. You must retain, in the Source Code of any Derivative Works that You create, all copyright, patent, or trademark notices from the Source Code of the Original Work, as well as any notices of licensing and any descriptive text identified therein as an "Attribution Notice." You must cause the Source Code for any Derivative Works that You create to carry a prominent Attribution Notice reasonably calculated to inform recipients that You have modified the Original Work.
29+
30+
7. Warranty of Provenance and Disclaimer of Warranty. Licensor warrants that the copyright in and to the Original Work and the patent rights granted herein by Licensor are owned by the Licensor or are sublicensed to You under the terms of this License with the permission of the contributor(s) of those copyrights and patent rights. Except as expressly stated in the immediately preceding sentence, the Original Work is provided under this License on an "AS IS" BASIS and WITHOUT WARRANTY, either express or implied, including, without limitation, the warranties of non-infringement, merchantability or fitness for a particular purpose. THE ENTIRE RISK AS TO THE QUALITY OF THE ORIGINAL WORK IS WITH YOU. This DISCLAIMER OF WARRANTY constitutes an essential part of this License. No license to the Original Work is granted by this License except under this disclaimer.
31+
32+
8. Limitation of Liability. Under no circumstances and under no legal theory, whether in tort (including negligence), contract, or otherwise, shall the Licensor be liable to anyone for any indirect, special, incidental, or consequential damages of any character arising as a result of this License or the use of the Original Work including, without limitation, damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses. This limitation of liability shall not apply to the extent applicable law prohibits such limitation.
33+
34+
9. Acceptance and Termination. If, at any time, You expressly assented to this License, that assent indicates your clear and irrevocable acceptance of this License and all of its terms and conditions. If You distribute or communicate copies of the Original Work or a Derivative Work, You must make a reasonable effort under the circumstances to obtain the express assent of recipients to the terms of this License. This License conditions your rights to undertake the activities listed in Section 1, including your right to create Derivative Works based upon the Original Work, and doing so without honoring these terms and conditions is prohibited by copyright law and international treaty. Nothing in this License is intended to affect copyright exceptions and limitations (including 'fair use' or 'fair dealing'). This License shall terminate immediately and You may no longer exercise any of the rights granted to You by this License upon your failure to honor the conditions in Section 1(c).
35+
36+
10. Termination for Patent Action. This License shall terminate automatically and You may no longer exercise any of the rights granted to You by this License as of the date You commence an action, including a cross-claim or counterclaim, against Licensor or any licensee alleging that the Original Work infringes a patent. This termination provision shall not apply for an action alleging patent infringement by combinations of the Original Work with other software or hardware.
37+
38+
11. Jurisdiction, Venue and Governing Law. Any action or suit relating to this License may be brought only in the courts of a jurisdiction wherein the Licensor resides or in which Licensor conducts its primary business, and under the laws of that jurisdiction excluding its conflict-of-law provisions. The application of the United Nations Convention on Contracts for the International Sale of Goods is expressly excluded. Any use of the Original Work outside the scope of this License or after its termination shall be subject to the requirements and penalties of copyright or patent law in the appropriate jurisdiction. This section shall survive the termination of this License.
39+
40+
12. Attorneys' Fees. In any action to enforce the terms of this License or seeking damages relating thereto, the prevailing party shall be entitled to recover its costs and expenses, including, without limitation, reasonable attorneys' fees and costs incurred in connection with such action, including any appeal of such action. This section shall survive the termination of this License.
41+
42+
13. Miscellaneous. If any provision of this License is held to be unenforceable, such provision shall be reformed only to the extent necessary to make it enforceable.
43+
44+
14. Definition of "You" in This License. "You" throughout this License, whether in upper or lower case, means an individual or a legal entity exercising rights under, and complying with all of the terms of, this License. For legal entities, "You" includes any entity that controls, is controlled by, or is under common control with you. For purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity.
45+
46+
15. Right to Use. You may use the Original Work in all ways not otherwise restricted or conditioned by this License or by law, and Licensor promises not to interfere with or be responsible for such uses by You.
47+
48+
16. Modification of This License. This License is Copyright (C) 2005 Lawrence Rosen. Permission is granted to copy, distribute, or communicate this License without modification. Nothing in this License permits You to modify this License as applied to the Original Work or to Derivative Works. However, You may modify the text of this License and copy, distribute or communicate your modified version (the "Modified License") and apply it to other original works of authorship subject to the following conditions: (i) You may not indicate in any way that your Modified License is the "Open Software License" or "OSL" and you may not use those names in the name of your Modified License; (ii) You must replace the notice specified in the first paragraph above with the notice "Licensed under <insert your license name here>" or with a notice of your own that is not confusingly similar to the notice in this License; and (iii) You may not claim that your original works are open source software unless your Modified License has been approved by Open Source Initiative (OSI) and You comply with its license review and certification process.

0 commit comments

Comments
 (0)