├── Config
    ├── AbstractConfigProvider.php
    └── ModuleConfiguration.php
├── Exception
    └── TrackingDataNotValidException.php
├── LICENSE
├── Logger
    ├── Handler.php
    └── Logger.php
├── Model
    ├── GAClient.php
    ├── Resolver
    │   └── GAResolver.php
    ├── ResourceModel
    │   ├── SalesOrder.php
    │   └── SalesOrder
    │   │   └── Collection.php
    ├── SalesOrder.php
    ├── SalesOrderFactory.php
    ├── SalesOrderRepository.php
    ├── SendPurchaseEvent.php
    └── Source
    │   ├── CurrencySource.php
    │   ├── Fallback.php
    │   ├── PaymentMethods.php
    │   └── TriggerMode.php
├── Observer
    ├── AfterOrderPayed.php
    └── AfterOrderPlaced.php
├── Plugin
    └── SaveGaUserDataToDb.php
├── README.md
├── Service
    └── UserDataProvider.php
├── Setup
    ├── Patch
    │   └── Data
    │   │   └── RenameConfigPaths.php
    └── UpgradeData.php
├── composer.json
├── etc
    ├── adminhtml
    │   └── system.xml
    ├── config.xml
    ├── db_schema.xml
    ├── db_schema_whitelist.json
    ├── di.xml
    ├── events.xml
    ├── extension_attributes.xml
    ├── module.xml
    └── schema.graphqls
└── registration.php


/Config/AbstractConfigProvider.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | /**
 4 |  * Copyright Elgentos BV. All rights reserved.
 5 |  * https://www.elgentos.nl/
 6 |  */
 7 | 
 8 | declare(strict_types=1);
 9 | 
10 | namespace Elgentos\ServerSideAnalytics\Config;
11 | 
12 | use Magento\Framework\App\Config\ScopeConfigInterface;
13 | use Magento\Store\Model\ScopeInterface;
14 | use Magento\Store\Model\StoreManagerInterface;
15 | 
16 | abstract class AbstractConfigProvider
17 | {
18 |     public function __construct(
19 |         protected ScopeConfigInterface  $scopeConfig,
20 |         protected StoreManagerInterface $storeManager
21 |     ) {
22 |     }
23 | 
24 |     public function isSetFlag(string $xpath, int|null|string $storeId = null): bool
25 |     {
26 |         return $this->scopeConfig->isSetFlag(
27 |             $xpath,
28 |             ScopeInterface::SCOPE_STORE,
29 |             scopeCode: $storeId
30 |         );
31 |     }
32 | 
33 |     protected function getConfig(string $xpath, int|null|string $storeId = null): mixed
34 |     {
35 |         return $this->scopeConfig->getValue(
36 |             $xpath,
37 |             ScopeInterface::SCOPE_STORE,
38 |             $storeId
39 |         );
40 |     }
41 | 
42 |     public function getConfigAsString(string $xpath, int|null|string $storeId = null): ?string
43 |     {
44 |         return (string)$this->getConfig($xpath, $storeId);
45 |     }
46 | 
47 |     public function getConfigAsInt(string $xpath, int|null|string $storeId = null): int
48 |     {
49 |         return (int)$this->getConfig($xpath, $storeId);
50 |     }
51 | }
52 | 


--------------------------------------------------------------------------------
/Config/ModuleConfiguration.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | /**
  4 |  * Copyright Elgentos BV. All rights reserved.
  5 |  * https://www.elgentos.nl/
  6 |  */
  7 | 
  8 | declare(strict_types=1);
  9 | 
 10 | namespace Elgentos\ServerSideAnalytics\Config;
 11 | 
 12 | use Elgentos\ServerSideAnalytics\Model\Source\TriggerMode;
 13 | 
 14 | class ModuleConfiguration extends AbstractConfigProvider
 15 | {
 16 |     public const XPATH_ENABLED                    = 'google/serverside_analytics/enabled';
 17 |     public const XPATH_API_SECRET                 = 'google/serverside_analytics/general/api_secret';
 18 |     public const XPATH_MEASUREMENT_ID             = 'google/serverside_analytics/general/measurement_id';
 19 |     public const XPATH_CURRENCY_SOURCE            = 'google/serverside_analytics/general/currency_source';
 20 |     public const XPATH_TRIGGER_MODE               = 'google/serverside_analytics/trigger_on/mode';
 21 |     public const XPATH_TRIGGER_ON_PLACED_METHODS  = 'google/serverside_analytics/trigger_on/on_placed_methods';
 22 |     public const XPATH_TRIGGER_ON_PAYED_METHODS   = 'google/serverside_analytics/trigger_on/on_payed_methods';
 23 |     public const XPATH_FALLBACK_GENERATION_MODE   = 'google/serverside_analytics/fallback_session_id/mode';
 24 |     public const XPATH_FALLBACK_SESSION_ID_PREFIX = 'google/serverside_analytics/fallback_session_id/prefix';
 25 |     public const XPATH_FALLBACK_SESSION_ID        = 'google/serverside_analytics/fallback_session_id/id';
 26 |     public const XPATH_TAX_DISPLAY_TYPE           = 'tax/display/type';
 27 |     public const XPATH_DEBUG_MODE                 = 'google/serverside_analytics/developer/debug';
 28 |     public const XPATH_ENABLE_LOGGING             = 'google/serverside_analytics/developer/logging';
 29 | 
 30 |     public function ensureStoreId(int|null|string $storeId = null): int|string
 31 |     {
 32 |         return $this->storeManager->getStore($storeId)->getId();
 33 |     }
 34 | 
 35 |     public function isDebugMode(int|null|string $storeId = null): bool
 36 |     {
 37 |         return $this->isSetFlag(static::XPATH_DEBUG_MODE, $storeId);
 38 |     }
 39 | 
 40 |     public function isLogging(int|null|string $storeId = null): bool
 41 |     {
 42 |         return $this->isSetFlag(static::XPATH_ENABLE_LOGGING, $storeId);
 43 |     }
 44 | 
 45 |     public function getCurrencySource(int|null|string $storeId = null): ?int
 46 |     {
 47 |         return $this->getConfigAsInt(static::XPATH_CURRENCY_SOURCE, $storeId);
 48 |     }
 49 | 
 50 |     public function getTaxDisplayType(int|null|string $storeId = null): ?int
 51 |     {
 52 |         return $this->getConfigAsInt(static::XPATH_TAX_DISPLAY_TYPE, $storeId);
 53 |     }
 54 | 
 55 |     public function getFallbackGenerationMode(int|null|string $storeId = null): ?int
 56 |     {
 57 |         return $this->getConfigAsInt(static::XPATH_FALLBACK_GENERATION_MODE, $storeId);
 58 |     }
 59 | 
 60 |     public function getFallbackSessionIdPrefix(int|null|string $storeId = null): ?string
 61 |     {
 62 |         return $this->getConfigAsString(static::XPATH_FALLBACK_SESSION_ID_PREFIX, $storeId);
 63 |     }
 64 | 
 65 |     public function getFallbackSessionId(int|null|string $storeId = null): ?string
 66 |     {
 67 |         return $this->getConfigAsString(static::XPATH_FALLBACK_SESSION_ID, $storeId);
 68 |     }
 69 | 
 70 |     public function shouldTriggerOnPayment(int|null|string $storeId = null, ?string $paymentMethodCode = null): ?bool
 71 |     {
 72 |         return $this->shouldTriggerOn(
 73 |             mode: TriggerMode::PAYED,
 74 |             storeId: $storeId,
 75 |             paymentMethodCode: $paymentMethodCode
 76 |         );
 77 |     }
 78 | 
 79 |     protected function shouldTriggerOn(
 80 |         int $mode,
 81 |         int|null|string $storeId = null,
 82 |         ?string $paymentMethodCode = null
 83 |     ): ?bool {
 84 |         return $this->isReadyForUse($storeId) && $this->shouldTriggerOnMode(
 85 |             mode: $mode,
 86 |             storeId: $storeId,
 87 |             paymentMethodCode: $paymentMethodCode
 88 |         );
 89 |     }
 90 | 
 91 |     public function isReadyForUse(int|null|string $storeId = null): bool
 92 |     {
 93 |         return $this->isEnabled($storeId) &&
 94 |             !empty($this->getApiSecret($storeId)) &&
 95 |             !empty($this->getMeasurementId($storeId));
 96 |     }
 97 | 
 98 |     public function isEnabled(int|null|string $storeId = null): bool
 99 |     {
100 |         return $this->isSetFlag(static::XPATH_ENABLED, $storeId);
101 |     }
102 | 
103 |     public function getApiSecret(int|null|string $storeId = null): ?string
104 |     {
105 |         return $this->getConfigAsString(static::XPATH_API_SECRET, $storeId);
106 |     }
107 | 
108 |     public function getMeasurementId(int|null|string $storeId = null): ?string
109 |     {
110 |         return $this->getConfigAsString(static::XPATH_MEASUREMENT_ID, $storeId);
111 |     }
112 | 
113 |     protected function shouldTriggerOnMode(
114 |         int $mode,
115 |         int|null|string $storeId = null,
116 |         ?string $paymentMethodCode = null
117 |     ): ?bool {
118 |         $triggerMode = $this->getTriggerMode($storeId);
119 |         if ($triggerMode === $mode) {
120 |             return true;
121 |         }
122 | 
123 |         if ($triggerMode !== TriggerMode::PAYMENT_METHOD_DEPENDENT) {
124 |             return false;
125 |         }
126 | 
127 |         if (!$paymentMethodCode) {
128 |             return false;
129 |         }
130 | 
131 |         if (in_array($paymentMethodCode, $this->getPaymentMethodsForTrigger(mode: $mode, storeId: $storeId))) {
132 |             return true;
133 |         }
134 | 
135 |         return false;
136 |     }
137 | 
138 |     public function getTriggerMode(int|null|string $storeId = null): ?int
139 |     {
140 |         $value = $this->getConfigAsInt(static::XPATH_TRIGGER_MODE, $storeId);
141 |         if (in_array($value, TriggerMode::ALL_OPTION_VALUES)) {
142 |             return $value;
143 |         }
144 | 
145 |         return null;
146 |     }
147 | 
148 |     public function getPaymentMethodsForTrigger(int $mode = null, int|null|string $storeId = null): array
149 |     {
150 |         switch ($mode) {
151 |             case TriggerMode::PLACED:
152 |                 return explode(
153 |                     ',',
154 |                     $this->getConfigAsString(self::XPATH_TRIGGER_ON_PLACED_METHODS, $storeId)
155 |                 );
156 |             case TriggerMode::PAYED:
157 |                 return explode(
158 |                     ',',
159 |                     $this->getConfigAsString(self::XPATH_TRIGGER_ON_PAYED_METHODS, $storeId)
160 |                 );
161 |         }
162 | 
163 |         return [];
164 |     }
165 | 
166 |     public function shouldTriggerOnPlaced(int|null|string $storeId = null, ?string $paymentMethodCode = null): ?bool
167 |     {
168 |         return $this->shouldTriggerOn(
169 |             mode: TriggerMode::PLACED,
170 |             storeId: $storeId,
171 |             paymentMethodCode: $paymentMethodCode
172 |         );
173 |     }
174 | }
175 | 


--------------------------------------------------------------------------------
/Exception/TrackingDataNotValidException.php:
--------------------------------------------------------------------------------
1 | <?php
2 | 
3 | namespace Elgentos\ServerSideAnalytics\Exception;
4 | 
5 | class TrackingDataNotValidException extends \Exception
6 | {
7 | }
8 | 


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
 1 | MIT License
 2 | 
 3 | Copyright (c) 2022 elgentos ecommerce solutions
 4 | 
 5 | Permission is hereby granted, free of charge, to any person obtaining a copy
 6 | of this software and associated documentation files (the "Software"), to deal
 7 | in the Software without restriction, including without limitation the rights
 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 | 
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 | 
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 | SOFTWARE.
22 | 


--------------------------------------------------------------------------------
/Logger/Handler.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | /**
 4 |  * Copyright Elgentos BV. All rights reserved.
 5 |  * https://www.elgentos.nl/
 6 |  */
 7 | 
 8 | declare(strict_types=1);
 9 | 
10 | namespace Elgentos\ServerSideAnalytics\Logger;
11 | 
12 | use Magento\Framework\Logger\Handler\Base;
13 | use Monolog\Logger;
14 | 
15 | class Handler extends Base
16 | {
17 |     /**
18 |      * Logging level
19 |      * @var int
20 |      */
21 |     protected $loggerType = Logger::INFO;
22 | 
23 |     /**
24 |      * File name
25 |      * @var string
26 |      */
27 |     protected $fileName = 'var/log/serversideanalytics.log';
28 | }
29 | 


--------------------------------------------------------------------------------
/Logger/Logger.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | /**
 4 |  * Copyright Elgentos BV. All rights reserved.
 5 |  * https://www.elgentos.nl/
 6 |  */
 7 | 
 8 | declare(strict_types=1);
 9 | 
10 | namespace Elgentos\ServerSideAnalytics\Logger;
11 | 
12 | class Logger extends \Monolog\Logger
13 | {
14 | }
15 | 


--------------------------------------------------------------------------------
/Model/GAClient.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | /**
  4 |  * Copyright Elgentos BV. All rights reserved.
  5 |  * https://www.elgentos.nl/
  6 |  */
  7 | 
  8 | declare(strict_types=1);
  9 | 
 10 | namespace Elgentos\ServerSideAnalytics\Model;
 11 | 
 12 | use Br33f\Ga4\MeasurementProtocol\Dto\Common\UserAddress;
 13 | use Br33f\Ga4\MeasurementProtocol\Dto\Common\UserDataItem;
 14 | use Br33f\Ga4\MeasurementProtocol\Dto\Event\PurchaseEvent;
 15 | use Br33f\Ga4\MeasurementProtocol\Dto\Parameter\ItemParameter;
 16 | use Br33f\Ga4\MeasurementProtocol\Dto\Request\BaseRequest;
 17 | use Br33f\Ga4\MeasurementProtocol\Service;
 18 | use DateTime;
 19 | use Elgentos\ServerSideAnalytics\Config\ModuleConfiguration;
 20 | use Elgentos\ServerSideAnalytics\Exception\TrackingDataNotValidException;
 21 | use Elgentos\ServerSideAnalytics\Logger\Logger;
 22 | use Magento\Framework\DataObject;
 23 | use Magento\Framework\Exception\LocalizedException;
 24 | 
 25 | class GAClient
 26 | {
 27 |     /** @var Service[] */
 28 |     protected array $service = [];
 29 | 
 30 |     protected ?BaseRequest $request;
 31 | 
 32 |     protected ?PurchaseEvent $purchaseEvent;
 33 | 
 34 |     protected string $version = '1';
 35 | 
 36 |     protected int $productCounter = 0;
 37 | 
 38 |     public function __construct(
 39 |         protected ModuleConfiguration $moduleConfiguration,
 40 |         protected Logger $logger
 41 |     ) {
 42 |     }
 43 | 
 44 |     public function setTrackingData(DataObject $data): void
 45 |     {
 46 |         if (!$data->getClientId()) {
 47 |             throw new TrackingDataNotValidException('No client ID is set for GA client.');
 48 |         }
 49 | 
 50 |         $this->getRequest()->setClientId($data->getClientId()); // '2133506694.1448249699'
 51 | 
 52 |         $this->getRequest()->setTimestampMicros($this->getMicroTime());
 53 |     }
 54 | 
 55 |     public function getRequest()
 56 |     {
 57 |         if (isset($this->request)) {
 58 |             return $this->request;
 59 |         }
 60 | 
 61 |         $this->request = new BaseRequest();
 62 | 
 63 |         return $this->request;
 64 |     }
 65 | 
 66 |     public function getMicroTime(): int
 67 |     {
 68 |         return (int)(new DateTime())
 69 |             ->format('Uu');
 70 |     }
 71 | 
 72 |     public function setTransactionData(DataObject $data)
 73 |     {
 74 |         foreach ($data->getData() as $key => $param) {
 75 |             $this->getPurchaseEvent()->setParamValue($key, $param);
 76 |         }
 77 | 
 78 |         $this->getPurchaseEvent()->setParamValue('timestamp_micros', $this->getMicroTime());
 79 |     }
 80 | 
 81 |     public function getPurchaseEvent()
 82 |     {
 83 |         if (isset($this->purchaseEvent)) {
 84 |             return $this->purchaseEvent;
 85 |         }
 86 | 
 87 |         $this->purchaseEvent = new PurchaseEvent();
 88 | 
 89 |         return $this->purchaseEvent;
 90 |     }
 91 | 
 92 |     /**
 93 |      * @param DataObject[] $products
 94 |      */
 95 |     public function addProducts(array $products): void
 96 |     {
 97 |         foreach ($products as $product) {
 98 |             $this->addProduct($product);
 99 |         }
100 |     }
101 | 
102 |     public function addProduct(DataObject $data)
103 |     {
104 |         $this->productCounter++;
105 | 
106 |         $itemParameter = new ItemParameter($data->getData());
107 |         $itemParameter->setItemId($data->getSku())
108 |             ->setItemName($data->getName())
109 |             ->setIndex((float)$data->getPosition())
110 |             ->setPrice((float)$data->getPrice())
111 |             ->setQuantity((float)$data->getQuantity());
112 | 
113 |         $this->getPurchaseEvent()->addItem($itemParameter);
114 |     }
115 | 
116 |     public function addUserDataItems($userDataItems){
117 |         foreach ($userDataItems as $key => $userDataItem) {
118 |             $this->addUserDataItem($key, $userDataItem);
119 |         }
120 |     }
121 | 
122 |     public function addUserDataItem($key, $userDataItem){
123 |         if($key === 'address'){
124 |             foreach($userDataItem as $addressData){
125 |                 $userAddress = new UserAddress();
126 | 
127 |                 foreach($addressData as $addressKey => $addressValue){
128 |                     $addressDataItem = new UserDataItem($addressKey, $addressValue);
129 | 
130 |                     $userAddress->addUserAddressItem($addressDataItem);
131 |                 }
132 | 
133 |                 $this->getRequest()->getUserData()->addUserAddress($userAddress);
134 |             }
135 |         }else{
136 |             $userDataItem = new UserDataItem($key, $userDataItem);
137 | 
138 |             $this->getRequest()->addUserDataItem($userDataItem);
139 |         }
140 |     }
141 | 
142 |     /**
143 |      * @throws LocalizedException
144 |      */
145 |     public function firePurchaseEvent(int|string|null $storeId)
146 |     {
147 |         if (!$this->productCounter) {
148 |             throw new LocalizedException(
149 |                 __(
150 |                     'No products have been added to transaction %s',
151 |                     $this->getPurchaseEvent()->getTransactionId()
152 |                 )
153 |             );
154 |         }
155 | 
156 |         $baseRequest = $this->getRequest();
157 |         $baseRequest->addEvent($this->getPurchaseEvent());
158 | 
159 |         $baseRequest->validate();
160 | 
161 |         $send = $this->moduleConfiguration->isDebugMode() ? 'sendDebug' : 'send';
162 | 
163 |         $service = $this->getService($storeId);
164 |         $response = $this->getService($storeId)->$send($baseRequest);
165 | 
166 |         $this->createLog(
167 |             "Request: ",
168 |             [
169 |                 "storeId" => $storeId,
170 |                 "measurementId" => $service->getMeasurementId(),
171 |                 "body" => $this->getRequest()->export()
172 |             ]
173 |         );
174 |         $this->createLog('Response: ', [$response->getStatusCode()]);
175 |     }
176 | 
177 |     public function getService(int|string|null $storeId)
178 |     {
179 |         $storeId = $this->moduleConfiguration->ensureStoreId($storeId);
180 |         if (isset($this->service[$storeId])) {
181 |             return $this->service[$storeId];
182 |         }
183 | 
184 |         $this->service[$storeId] = new Service($this->moduleConfiguration->getApiSecret($storeId));
185 |         $this->service[$storeId]->setMeasurementId($this->moduleConfiguration->getMeasurementId($storeId));
186 | 
187 |         return $this->service[$storeId];
188 |     }
189 | 
190 |     public function createLog($message, array $context = [])
191 |     {
192 |         if (!$this->moduleConfiguration->isLogging()) {
193 |             return;
194 |         }
195 | 
196 |         $this->logger->info($message, $context);
197 |     }
198 | 
199 |     /**
200 |      * @return string
201 |      */
202 |     public function getVersion(): string
203 |     {
204 |         return $this->version;
205 |     }
206 | }
207 | 


--------------------------------------------------------------------------------
/Model/Resolver/GAResolver.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | /**
 4 |  * Copyright Elgentos BV. All rights reserved.
 5 |  * https://www.elgentos.nl/
 6 |  */
 7 | 
 8 | declare(strict_types=1);
 9 | 
10 | namespace Elgentos\ServerSideAnalytics\Model\Resolver;
11 | 
12 | use Elgentos\ServerSideAnalytics\Model\ResourceModel\SalesOrder\Collection;
13 | use Elgentos\ServerSideAnalytics\Model\ResourceModel\SalesOrder\CollectionFactory;
14 | use Elgentos\ServerSideAnalytics\Model\SalesOrder;
15 | use Elgentos\ServerSideAnalytics\Model\SalesOrderRepository;
16 | use Magento\Framework\GraphQl\Config\Element\Field;
17 | use Magento\Framework\GraphQl\Exception\GraphQlAuthorizationException;
18 | use Magento\Framework\GraphQl\Query\ResolverInterface;
19 | use Magento\Framework\GraphQl\Schema\Type\ResolveInfo;
20 | use Magento\GraphQl\Model\Query\Context;
21 | use Magento\Quote\Api\CartRepositoryInterface;
22 | use Magento\Quote\Model\MaskedQuoteIdToQuoteIdInterface;
23 | 
24 | class GAResolver implements ResolverInterface
25 | {
26 |     public function __construct(
27 |         protected CartRepositoryInterface $quoteRepository,
28 |         protected MaskedQuoteIdToQuoteIdInterface $maskedQuoteIdToQuoteId,
29 |         protected CollectionFactory $elgentosSalesOrderCollectionFactory,
30 |         protected SalesOrderRepository $elgentosSalesOrderRepository,
31 |     ) {
32 |     }
33 | 
34 |     public function resolve(
35 |         Field $field,
36 |         $context,
37 |         ResolveInfo $info,
38 |         array $value = null,
39 |         array $args = null
40 |     ) {
41 |         $input = $args['input'];
42 | 
43 |         /** @var Context $context */
44 |         if (is_numeric($input['cartId']) && false === $context->getExtensionAttributes()->getIsCustomer()) {
45 |             throw new GraphQlAuthorizationException(__('The current customer isn\'t authorized.'));
46 |         }
47 | 
48 |         $cartId = is_numeric($input['cartId'])
49 |             ? $input['cartId']
50 |             : $this->maskedQuoteIdToQuoteId->execute($input['cartId']);
51 | 
52 |         /** @var Collection $elgentosSalesOrderCollection */
53 |         $elgentosSalesOrderCollection = $this->elgentosSalesOrderCollectionFactory->create();
54 |         /** @var SalesOrder $elgentosSalesOrder */
55 |         $elgentosSalesOrder = $elgentosSalesOrderCollection
56 |             ->addFieldToFilter('quote_id', $cartId)
57 |             ->getFirstItem();
58 | 
59 |         $elgentosSalesOrder->setQuoteId($cartId);
60 |         if ($elgentosSalesOrder->getGaUserId() !== ($input['gaUserId'] ?? null)) {
61 |             $elgentosSalesOrder->setGaUserId($input['gaUserId'] ?? '');
62 |         }
63 | 
64 |         if ($elgentosSalesOrder->getGaSessionId() !== ($input['gaSessionId'] ?? null)) {
65 |             $elgentosSalesOrder->setGaSessionId($input['gaSessionId'] ?? '');
66 |         }
67 | 
68 |         $this->elgentosSalesOrderRepository->save($elgentosSalesOrder);
69 | 
70 |         return [
71 |             'cartId' => $cartId,
72 |             'maskedId' => !is_numeric($input['cartId']) ? $input['cartId'] : null
73 |         ];
74 |     }
75 | }
76 | 


--------------------------------------------------------------------------------
/Model/ResourceModel/SalesOrder.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | /**
 4 |  * Copyright Elgentos BV. All rights reserved.
 5 |  * https://www.elgentos.nl/
 6 |  */
 7 | 
 8 | declare(strict_types=1);
 9 | 
10 | namespace Elgentos\ServerSideAnalytics\Model\ResourceModel;
11 | 
12 | use Magento\Framework\Model\ResourceModel\Db\AbstractDb;
13 | 
14 | class SalesOrder extends AbstractDb
15 | {
16 |     /** @var string Main table name */
17 |     public const MAIN_TABLE = 'elgentos_serversideanalytics_sales_order';
18 | 
19 |     /** @var string Main table primary key field name */
20 |     public const ID_FIELD_NAME = 'id';
21 | 
22 |     protected function _construct(): void
23 |     {
24 |         $this->_init(self::MAIN_TABLE, self::ID_FIELD_NAME);
25 |     }
26 | }
27 | 


--------------------------------------------------------------------------------
/Model/ResourceModel/SalesOrder/Collection.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | /**
 4 |  * Copyright Elgentos BV. All rights reserved.
 5 |  * https://www.elgentos.nl/
 6 |  */
 7 | 
 8 | declare(strict_types=1);
 9 | 
10 | namespace Elgentos\ServerSideAnalytics\Model\ResourceModel\SalesOrder;
11 | 
12 | use Elgentos\ServerSideAnalytics\Model\ResourceModel\SalesOrder as SalesOrderResource;
13 | use Magento\Framework\Model\ResourceModel\Db\Collection\AbstractCollection;
14 | use Elgentos\ServerSideAnalytics\Model\SalesOrder;
15 | 
16 | class Collection extends AbstractCollection
17 | {
18 |     protected function _construct(): void
19 |     {
20 |         $this->_init(SalesOrder::class, SalesOrderResource::class);
21 |     }
22 | }
23 | 


--------------------------------------------------------------------------------
/Model/SalesOrder.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | /**
  4 |  * Copyright Elgentos BV. All rights reserved.
  5 |  * https://www.elgentos.nl/
  6 |  */
  7 | 
  8 | declare(strict_types=1);
  9 | 
 10 | namespace Elgentos\ServerSideAnalytics\Model;
 11 | 
 12 | use Elgentos\ServerSideAnalytics\Config\ModuleConfiguration;
 13 | use Elgentos\ServerSideAnalytics\Model\ResourceModel\SalesOrder\CollectionFactory;
 14 | use Elgentos\ServerSideAnalytics\Model\Source\Fallback;
 15 | use Magento\Framework\Data\Collection\AbstractDb;
 16 | use Magento\Framework\Model\AbstractModel;
 17 | use Magento\Framework\Model\Context;
 18 | use Elgentos\ServerSideAnalytics\Model\ResourceModel\SalesOrder as SalesOrderResource;
 19 | use Magento\Framework\Registry;
 20 | use Magento\Framework\Stdlib\CookieManagerInterface;
 21 | 
 22 | class SalesOrder extends AbstractModel
 23 | {
 24 |     public function __construct(
 25 |         Context $context,
 26 |         Registry $registry,
 27 |         protected readonly ModuleConfiguration $moduleConfiguration,
 28 |         protected readonly CollectionFactory $elgentosSalesOrderCollectionFactory,
 29 |         protected readonly SalesOrderRepository $elgentosSalesOrderRepository,
 30 |         protected readonly CookieManagerInterface $cookieManager,
 31 |         protected readonly GAClient $gaclient,
 32 |         SalesOrderResource $resource = null,
 33 |         AbstractDb $resourceCollection = null,
 34 |         array $data = []
 35 |     ) {
 36 |         parent::__construct($context, $registry, $resource, $resourceCollection, $data);
 37 |     }
 38 | 
 39 |     protected function _construct(): void
 40 |     {
 41 |         $this->_init(ResourceModel\SalesOrder::class);
 42 |     }
 43 | 
 44 |     /**
 45 |      * Set the ga_user_id and ga_session_id on the current sales order.
 46 |      * Any missing data will be gathered from the cookies, or generated.
 47 |      */
 48 |     public function setGaData(int|null|string $storeId = null, null|string $gaUserId = null, int|null|string $gaSessionId = null): static
 49 |     {
 50 |         $this->setData('ga_user_id', $gaUserId ?? $this->getCurrentGaUserId());
 51 |         $this->setData('ga_session_id', $gaSessionId ?? $this->getCurrentGaSessionId($storeId));
 52 | 
 53 |         return $this;
 54 |     }
 55 | 
 56 |     /**
 57 |      * Attemt to get the current GA User id from cookies, database or generating it.
 58 |      */
 59 |     public function getCurrentGaUserId(): string
 60 |     {
 61 |         $gaUserId = $this->getUserIdFromCookie($this->cookieManager->getCookie('_ga')) ?? $this->getGaUserId();
 62 | 
 63 |         if (!$gaUserId) {
 64 |             $gaUserId = $this->generateFallbackUserId();
 65 |             $this->gaclient->createLog(
 66 |                 'Google Analytics cookie not found, generated temporary GA User Id: ' . $gaUserId
 67 |             );
 68 |         }
 69 | 
 70 |         return (string) $gaUserId;
 71 |     }
 72 | 
 73 |     /**
 74 |      * Attemt to get the current GA Session id from cookies, database or generating it.
 75 |      */
 76 |     public function getCurrentGaSessionId(int|null|string $storeId = null): string
 77 |     {
 78 |         $measurementId = $this->moduleConfiguration->getMeasurementId($storeId);
 79 |         $gaSessionId = $this->getSessionIdFromCookie(
 80 |             $this->getSessionIdCookie($measurementId)
 81 |         );
 82 | 
 83 |         if ($gaSessionId) {
 84 |             return $gaSessionId;
 85 |         }
 86 | 
 87 |         return (string) ($this->getGaSessionId() ?? $this->generateFallbackSessionId(
 88 |             $this->moduleConfiguration->getFallbackGenerationMode($storeId),
 89 |             $storeId
 90 |         ));
 91 |     }
 92 | 
 93 |     /**
 94 |      * Try to get the Google Analytics User ID from the cookie
 95 |      */
 96 |     public function getUserIdFromCookie($gaCookie = '' /** GA1.1.99999999.1732012836 */): ?string
 97 |     {
 98 |         $gaCookie = explode('.', $gaCookie ?? '');
 99 | 
100 |         if (count($gaCookie) < 4) {
101 |             return null;
102 |         }
103 | 
104 |         [
105 |             $gaCookieVersion,
106 |             $gaCookieDomainComponents,
107 |             $gaCookieUserId,
108 |             $gaCookieTimestamp
109 |         ] = $gaCookie;
110 | 
111 |         if (!$gaCookieUserId || !$gaCookieTimestamp) {
112 |             return null;
113 |         }
114 | 
115 |         if (
116 |             $gaCookieVersion != 'GA' . $this->gaclient->getVersion()
117 |         ) {
118 |             $this->gaclient->createLog(
119 |                 'Google Analytics cookie version differs from Measurement Protocol API version; please upgrade.'
120 |             );
121 |             return null;
122 |         }
123 | 
124 |         return implode('.', [$gaCookieUserId, $gaCookieTimestamp]);
125 |     }
126 | 
127 |     /**
128 |      * Generate a fallback analytics user id
129 |      */
130 |     public function generateFallbackUserId(): string
131 |     {
132 |         $gaCookieUserId = random_int((int)1E8, (int)1E9);
133 |         $gaCookieTimestamp = time();
134 |         $gaUserId = implode('.', [$gaCookieUserId, $gaCookieTimestamp]);
135 | 
136 |         return $gaUserId;
137 |     }
138 | 
139 |     public function getSessionIdCookie($gaMeasurementId = '' /** G-0XX00XXX */ ): string
140 |     {
141 |         $gaMeasurementId = str_replace('G-', '', $gaMeasurementId ?? '');
142 | 
143 |         return $this->cookieManager->getCookie('_ga_' . $gaMeasurementId) ?? '';
144 |     }
145 | 
146 |     public function getSessionIdFromCookie(?string $gaCookie = '' /** GS1.1.1732016998.2.1.1732018235.0.0.692404937 OR GS2.1.s1748246127$o6$g1$t1748251071$j60$l0$h263196385$dQn_oPl1JlfID64muTcg9EeKK4oR_eD4EGg */): ?string
147 |     {        
148 |         if (!preg_match('/^GS[0-9]\.[0-9]\.s?(?<session_id>[0-9]+)/', $gaCookie, $matches) || !$matches['session_id']) {
149 |             return null;
150 |         }
151 | 
152 |         return (string) $matches['session_id'];
153 |     }
154 | 
155 |     /**
156 |      * Generate a fallback analytics session id
157 |      */
158 |     public function generateFallbackSessionId($fallbackGenerationMode = Fallback::DEFAULT, int|null|string $storeId = null): string
159 |     {
160 |         if ($fallbackGenerationMode === Fallback::DEFAULT) {
161 |             return (string) $this->moduleConfiguration->getFallbackSessionId() ?? '9999999999999';
162 |         }
163 | 
164 |         if ($fallbackGenerationMode === Fallback::PREFIX) {
165 |             $prefix = $this->moduleConfiguration->getFallbackSessionIdPrefix($storeId);
166 |             if (!$prefix) {
167 |                 $prefix = '9999';
168 |             }
169 | 
170 |             return (string) $prefix . random_int((int)1E5, (int)1E6);
171 |         }
172 | 
173 |         return (string) random_int((int)1E5, (int)1E9);
174 |     }
175 | }
176 | 


--------------------------------------------------------------------------------
/Model/SalesOrderFactory.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | /**
 4 |  * Copyright Elgentos BV. All rights reserved.
 5 |  * https://www.elgentos.nl/
 6 |  */
 7 | 
 8 | declare(strict_types=1);
 9 | 
10 | namespace Elgentos\ServerSideAnalytics\Model;
11 | 
12 | use Magento\Framework\ObjectManagerInterface;
13 | use Magento\Quote\Model\Quote;
14 | 
15 | class SalesOrderFactory
16 | {
17 |     /**
18 |      * Object Manager instance
19 |      *
20 |      * @var ObjectManagerInterface
21 |      */
22 |     protected $_objectManager = null;
23 | 
24 |     /**
25 |      * Instance name to create
26 |      *
27 |      * @var string
28 |      */
29 |     protected $_instanceName = null;
30 | 
31 |     /**
32 |      * Factory constructor
33 |      *
34 |      * @param ObjectManagerInterface $objectManager
35 |      * @param string                 $instanceName
36 |      */
37 |     public function __construct(
38 |         ObjectManagerInterface $objectManager,
39 |         $instanceName = SalesOrder::class
40 |     ) {
41 |         $this->_objectManager = $objectManager;
42 |         $this->_instanceName  = $instanceName;
43 |     }
44 | 
45 |     /**
46 |      * Create class instance with specified parameters
47 |      *
48 |      * @param array $data
49 |      *
50 |      * @return Quote
51 |      */
52 |     public function create(array $data = [])
53 |     {
54 |         return $this->_objectManager->create($this->_instanceName, $data);
55 |     }
56 | }
57 | 


--------------------------------------------------------------------------------
/Model/SalesOrderRepository.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | /**
 4 |  * Copyright Elgentos BV. All rights reserved.
 5 |  * https://www.elgentos.nl/
 6 |  */
 7 | 
 8 | declare(strict_types=1);
 9 | 
10 | namespace Elgentos\ServerSideAnalytics\Model;
11 | 
12 | use Elgentos\ServerSideAnalytics\Model\ResourceModel\SalesOrder as SalesOrderResource;
13 | 
14 | class SalesOrderRepository
15 | {
16 |     public function __construct(
17 |         protected readonly SalesOrderResource $resource,
18 |     ) {
19 |     }
20 | 
21 |     public function save($data)
22 |     {
23 |         $this->resource->save($data);
24 |     }
25 | }
26 | 


--------------------------------------------------------------------------------
/Model/SendPurchaseEvent.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | /**
  4 |  * Copyright Elgentos BV. All rights reserved.
  5 |  * https://www.elgentos.nl/
  6 |  */
  7 | 
  8 | declare(strict_types=1);
  9 | 
 10 | namespace Elgentos\ServerSideAnalytics\Model;
 11 | 
 12 | use Elgentos\ServerSideAnalytics\Config\ModuleConfiguration;
 13 | use Elgentos\ServerSideAnalytics\Service\UserDataProvider;
 14 | use Elgentos\ServerSideAnalytics\Logger\Logger;
 15 | use Elgentos\ServerSideAnalytics\Model\ResourceModel\SalesOrder\CollectionFactory;
 16 | use Elgentos\ServerSideAnalytics\Model\Source\CurrencySource;
 17 | use Magento\Framework\DataObject;
 18 | use Magento\Framework\Event\ManagerInterface;
 19 | use Magento\Sales\Api\OrderRepositoryInterface;
 20 | use Magento\Sales\Model\Order;
 21 | use Magento\Sales\Model\Order\Invoice;
 22 | use Magento\Sales\Model\Order\Item;
 23 | use Magento\Store\Model\App\Emulation;
 24 | use Magento\Tax\Model\Config;
 25 | 
 26 | class SendPurchaseEvent
 27 | {
 28 |     public function __construct(
 29 |         protected readonly ModuleConfiguration $moduleConfiguration,
 30 |         protected readonly Emulation $emulation,
 31 |         protected readonly Logger $logger,
 32 |         protected readonly GAClientFactory $GAClientFactory,
 33 |         protected readonly ManagerInterface $event,
 34 |         protected readonly OrderRepositoryInterface $orderRepository,
 35 |         protected readonly CollectionFactory $elgentosSalesOrderCollectionFactory,
 36 |         protected readonly SalesOrderRepository $elgentosSalesOrderRepository,
 37 |         protected readonly UserDataProvider $userDataProvider
 38 |     ) {
 39 |     }
 40 | 
 41 |     public function execute(Order $order, string $eventName = 'unknown')
 42 |     {
 43 |         /** @var Invoice $invoice */
 44 |         $invoice = $order->getInvoiceCollection()->getFirstItem();
 45 | 
 46 |         $orderStoreId = $order->getStoreId();
 47 | 
 48 |         $gaUserDatabaseId = $order->getId();
 49 | 
 50 |         if (!$gaUserDatabaseId) {
 51 |             $gaUserDatabaseId = $order->getQuoteId();
 52 |         }
 53 | 
 54 |         if (!$gaUserDatabaseId) {
 55 |             return;
 56 |         }
 57 | 
 58 |         $this->emulation->startEnvironmentEmulation($orderStoreId, 'adminhtml');
 59 | 
 60 |         if (!$this->moduleConfiguration->isReadyForUse($orderStoreId)) {
 61 |             $this->emulation->stopEnvironmentEmulation();
 62 | 
 63 |             return;
 64 |         }
 65 | 
 66 |         $elgentosSalesOrder = $this->getElgentosSalesOrder($gaUserDatabaseId);
 67 | 
 68 |         if (!$elgentosSalesOrder) {
 69 |             $this->emulation->stopEnvironmentEmulation();
 70 | 
 71 |             return;
 72 |         }
 73 | 
 74 |         $gaclient = $this->GAClientFactory->create();
 75 | 
 76 |         if ($elgentosSalesOrder->getData('send_at') !== null) {
 77 |             $this->emulation->stopEnvironmentEmulation();
 78 |             if ($this->moduleConfiguration->isLogging($orderStoreId)) {
 79 |                 $gaclient->createLog(
 80 |                     'The purchase event for order #' .
 81 |                     $order->getIncrementId() . ' was send already by trigger ' .
 82 |                     ($elgentosSalesOrder->getData('trigger') ?? '') . '.',
 83 |                     [
 84 |                         'eventName' => $eventName,
 85 |                         ...$elgentosSalesOrder->getData()
 86 |                     ]
 87 |                 );
 88 |             }
 89 | 
 90 |             return;
 91 |         }
 92 | 
 93 |         if ($this->moduleConfiguration->isLogging($orderStoreId)) {
 94 |             $gaclient->createLog(
 95 |                 'Got ' . $eventName . ' event for Ga UserID: ' . $elgentosSalesOrder->getGaUserId(),
 96 |                 [
 97 |                     'eventName' => $eventName,
 98 |                     ...$elgentosSalesOrder->getData()
 99 |                 ]
100 |             );
101 |         }
102 | 
103 |         $trackingDataObject = new DataObject(
104 |             [
105 |                 'client_id' => $elgentosSalesOrder->getGaUserId(),
106 |                 'ip_override' => $order->getRemoteIp(),
107 |                 'document_path' => '/checkout/onepage/success/'
108 |             ]
109 |         );
110 |         
111 |         $transactionDataObject = $this->getTransactionDataObject($order, $elgentosSalesOrder);
112 |         $products = $this->collectProducts($order);
113 |         $userData = $this->collectUserData($order);
114 | 
115 |         $this->sendPurchaseEvent($gaclient, $transactionDataObject, $products, $trackingDataObject, $userData, $orderStoreId);
116 | 
117 |         $elgentosSalesOrder->setData('trigger', $eventName);
118 |         $elgentosSalesOrder->setData('send_at', date('Y-m-d H:i:s'));
119 |         $this->elgentosSalesOrderRepository->save($elgentosSalesOrder);
120 | 
121 |         $this->emulation->stopEnvironmentEmulation();
122 |     }
123 | 
124 |     protected function getElgentosSalesOrder($gaUserDatabaseId): ?SalesOrder
125 |     {
126 |         $elgentosSalesOrderCollection = $this->elgentosSalesOrderCollectionFactory->create();
127 |         /** @var SalesOrder $elgentosSalesOrder */
128 |         $elgentosSalesOrder = $elgentosSalesOrderCollection
129 |             ->addFieldToFilter(
130 |                 ['quote_id', 'order_id'],
131 |                 [
132 |                     ['eq' => $gaUserDatabaseId],
133 |                     ['eq' => $gaUserDatabaseId]
134 |                 ]
135 |             )
136 |             ->getFirstItem();
137 | 
138 |         if (
139 |             !$elgentosSalesOrder->getGaUserId()
140 |             ||
141 |             !$elgentosSalesOrder->getGaSessionId()
142 |         ) {
143 |             return null;
144 |         }
145 | 
146 |         return $elgentosSalesOrder;
147 |     }
148 | 
149 |     /**
150 |      * @return DataObject[]
151 |      */
152 |     protected function collectProducts(Order $order): array
153 |     {
154 |         $products = [];
155 | 
156 |         /** @var Invoice\Item $item */
157 |         foreach ($order->getAllItems() as $item) {
158 |             if (!$item->isDeleted() && !$item->getParentItemId()) {
159 |                 $product = new DataObject(
160 |                     [
161 |                         'sku' => $item->getSku(),
162 |                         'name' => $item->getName(),
163 |                         'price' => $this->getPaidProductPrice($item),
164 |                         'quantity' => $item->getQtyOrdered(),
165 |                         'position' => $item->getId(),
166 |                         'item_brand' => $item->getProduct()?->getAttributeText('manufacturer')
167 |                     ]
168 |                 );
169 | 
170 |                 $this->event->dispatch(
171 |                     'elgentos_serversideanalytics_product_item_transport_object',
172 |                     ['product' => $product, 'item' => $item]
173 |                 );
174 | 
175 |                 $products[] = $product;
176 |             }
177 |         }
178 | 
179 |         return $products;
180 |     }
181 | 
182 |     protected function collectUserData(Order $order){
183 |         $customerEmail = $order->getCustomerEmail();
184 | 
185 |         if ($customerEmail) {
186 |             $this->userDataProvider->setEmail($customerEmail);
187 |         }
188 | 
189 |         // Get billing address and set phone number and address details
190 |         $billingAddress = $order->getBillingAddress();
191 | 
192 |         if ($billingAddress) {
193 |             $billingPhoneNumber = $billingAddress->getTelephone();
194 |             if ($billingPhoneNumber) {
195 |                 $this->userDataProvider->setPhoneNumber($billingPhoneNumber);
196 |             }
197 | 
198 |             // Add address
199 |             $this->userDataProvider->addAddress(
200 |                 $billingAddress->getFirstname(),
201 |                 $billingAddress->getLastname(),
202 |                 implode(' ', $billingAddress->getStreet()),
203 |                 $billingAddress->getCity(),
204 |                 $billingAddress->getRegion(),
205 |                 $billingAddress->getPostcode(),
206 |                 $billingAddress->getCountryId()
207 |             );
208 |         }
209 | 
210 |         // Optionally process shipping address if needed
211 |         $shippingAddress = $order->getShippingAddress();
212 |         if ($shippingAddress) {
213 |             $shippingPhoneNumber = $shippingAddress->getTelephone();
214 |             if ($shippingPhoneNumber) {
215 |                 $this->userDataProvider->setPhoneNumber($shippingPhoneNumber);
216 |             }
217 | 
218 |             $this->userDataProvider->addAddress(
219 |                 $shippingAddress->getFirstname(),
220 |                 $shippingAddress->getLastname(),
221 |                 implode(' ', $shippingAddress->getStreet()),
222 |                 $shippingAddress->getCity(),
223 |                 $shippingAddress->getRegion(),
224 |                 $shippingAddress->getPostcode(),
225 |                 $shippingAddress->getCountryId()
226 |             );
227 |         }
228 | 
229 |         return $this->userDataProvider->toArray();
230 |     }
231 | 
232 |     /**
233 |      * Get the actual price the customer also saw in it's cart.
234 |      * @return float
235 |      */
236 |     private function getPaidProductPrice(Item $orderItem): float
237 |     {
238 |         $price = $this->moduleConfiguration
239 |             ->getTaxDisplayType($orderItem->getOrder()?->getStoreId()) === Config::DISPLAY_TYPE_EXCLUDING_TAX
240 |             ? $orderItem->getBasePrice()
241 |             : $orderItem->getBasePriceInclTax();
242 | 
243 |         return (float)$price;
244 |     }
245 | 
246 |     public function getTransactionDataObject(Order $order, $elgentosSalesOrder): DataObject
247 |     {
248 |         $currency = $this->moduleConfiguration->getCurrencySource($order->getStoreId()) === CurrencySource::GLOBAL ?
249 |             $order->getGlobalCurrencyCode() :
250 |             $order->getBaseCurrencyCode();
251 | 
252 |         $shippingCosts = $this->getPaidShippingCosts($order);
253 | 
254 |         $transactionDataObject = new DataObject(
255 |             [
256 |                 'transaction_id' => $order->getIncrementId(),
257 |                 'affiliation' => $order->getStoreName(),
258 |                 'currency' => $currency,
259 |                 'value' => (float)$order->getBaseGrandTotal(),
260 |                 'tax' => (float)$order->getBaseTaxAmount(),
261 |                 'shipping' => $shippingCosts ?? 0.0, // Use 0.0 if null
262 |                 'coupon_code' => $order->getCouponCode(),
263 |                 'session_id' => $elgentosSalesOrder->getGaSessionId()
264 |             ]
265 |         );
266 | 
267 |         $this->event->dispatch(
268 |             'elgentos_serversideanalytics_transaction_data_transport_object',
269 |             ['transaction_data_object' => $transactionDataObject, 'order' => $order]
270 |         );
271 | 
272 |         return $transactionDataObject;
273 |     }
274 | 
275 |     /**
276 |      * Get shipping costs
277 |      * @return float|null
278 |      */
279 |     private function getPaidShippingCosts(Order $order): ?float
280 |     {
281 |         $shippingAmount = $this->moduleConfiguration->getTaxDisplayType($order->getStoreId()) == Config::DISPLAY_TYPE_EXCLUDING_TAX
282 |             ? $order->getBaseShippingAmount()
283 |             : $order->getBaseShippingInclTax();
284 | 
285 |         if ($shippingAmount === null) {
286 |             return null;
287 |         }
288 | 
289 |         return (float)$shippingAmount;
290 |     }
291 | 
292 |     public function sendPurchaseEvent(
293 |         GAClient $gaclient,
294 |         DataObject $transactionDataObject,
295 |         array $products,
296 |         DataObject $trackingDataObject,
297 |         array $userData,
298 |         int|string|null $orderStoreId
299 |     ): void {
300 |         try {
301 |             $gaclient->setTransactionData($transactionDataObject);
302 |             $gaclient->addUserDataItems($userData);
303 |             $gaclient->addProducts($products);
304 |         } catch (\Exception $e) {
305 |             $gaclient->createLog($e);
306 | 
307 |             return;
308 |         }
309 | 
310 |         try {
311 |             $this->event->dispatch(
312 |                 'elgentos_serversideanalytics_tracking_data_transport_object',
313 |                 ['tracking_data_object' => $trackingDataObject]
314 |             );
315 | 
316 |             $gaclient->setTrackingData($trackingDataObject);
317 | 
318 |             $gaclient->firePurchaseEvent($orderStoreId);
319 |         } catch (\Exception $e) {
320 |             $gaclient->createLog($e);
321 |         }
322 |     }
323 | }
324 | 


--------------------------------------------------------------------------------
/Model/Source/CurrencySource.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | /**
 4 |  * Copyright Elgentos BV. All rights reserved.
 5 |  * https://www.elgentos.nl/
 6 |  */
 7 | 
 8 | declare(strict_types=1);
 9 | 
10 | namespace Elgentos\ServerSideAnalytics\Model\Source;
11 | 
12 | use Magento\Framework\Data\OptionSourceInterface;
13 | 
14 | class CurrencySource implements OptionSourceInterface
15 | {
16 |     public const ORDER  = 1;
17 |     public const GLOBAL = 2;
18 | 
19 |     /**
20 |      * Return array of options as value-label pairs
21 |      *
22 |      * @return array Format: array(array('value' => '<value>', 'label' => '<label>'), ...)
23 |      */
24 |     public function toOptionArray()
25 |     {
26 |         return [
27 |             ['value' => self::ORDER, 'label' => 'Currency of the order'],
28 |             ['value' => self::GLOBAL, 'label' => 'Default store currency'],
29 |         ];
30 |     }
31 | }
32 | 


--------------------------------------------------------------------------------
/Model/Source/Fallback.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | /**
 4 |  * Copyright Elgentos BV. All rights reserved.
 5 |  * https://www.elgentos.nl/
 6 |  */
 7 | 
 8 | declare(strict_types=1);
 9 | 
10 | namespace Elgentos\ServerSideAnalytics\Model\Source;
11 | 
12 | use Magento\Framework\Data\OptionSourceInterface;
13 | 
14 | class Fallback implements OptionSourceInterface
15 | {
16 |     public const DEFAULT = 1;
17 |     public const RANDOM  = 2;
18 |     public const PREFIX  = 3;
19 | 
20 |     /**
21 |      * Return array of options as value-label pairs
22 |      *
23 |      * @return array Format: array(array('value' => '<value>', 'label' => '<label>'), ...)
24 |      */
25 |     public function toOptionArray()
26 |     {
27 |         return [
28 |             ['value' => self::DEFAULT, 'label' => 'Enter one default sessionId'],
29 |             ['value' => self::RANDOM, 'label' => 'Completly random sessionId'],
30 |             ['value' => self::PREFIX, 'label' => 'Enter prefix for random sessionId']
31 |         ];
32 |     }
33 | }
34 | 


--------------------------------------------------------------------------------
/Model/Source/PaymentMethods.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | /**
 4 |  * Copyright Elgentos BV. All rights reserved.
 5 |  * https://www.elgentos.nl/
 6 |  */
 7 | 
 8 | declare(strict_types=1);
 9 | 
10 | namespace Elgentos\ServerSideAnalytics\Model\Source;
11 | 
12 | use Magento\Framework\Data\OptionSourceInterface;
13 | use Magento\Payment\Helper\Data;
14 | 
15 | class PaymentMethods implements OptionSourceInterface
16 | {
17 |     public function __construct(
18 |         protected Data $paymentHelper
19 |     ) {
20 |     }
21 | 
22 |     /**
23 |      * Return array of options as value-label pairs
24 |      *
25 |      * @return array Format: array(array('value' => '<value>', 'label' => '<label>'), ...)
26 |      */
27 |     public function toOptionArray()
28 |     {
29 |         $groupedMethods = [];
30 |         foreach ($this->paymentHelper->getPaymentMethods() as $key => $method) {
31 |             if (!isset($method['title'])) {
32 |                 continue;
33 |             }
34 | 
35 |             $groupedMethods[$method['group'] ?? 'other'][] = ['value' => $key, 'label' => $method['title']];
36 |         }
37 | 
38 |         ksort($groupedMethods);
39 | 
40 |         $options = [];
41 |         foreach ($groupedMethods as $group => $methods) {
42 |             $options[] = ['label' => ucfirst($group), 'value' => $methods];
43 |         }
44 | 
45 |         return $options;
46 |     }
47 | }
48 | 


--------------------------------------------------------------------------------
/Model/Source/TriggerMode.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | /**
 4 |  * Copyright Elgentos BV. All rights reserved.
 5 |  * https://www.elgentos.nl/
 6 |  */
 7 | 
 8 | declare(strict_types=1);
 9 | 
10 | namespace Elgentos\ServerSideAnalytics\Model\Source;
11 | 
12 | use Magento\Framework\Data\OptionSourceInterface;
13 | 
14 | class TriggerMode implements OptionSourceInterface
15 | {
16 |     public const PLACED  = 1;
17 |     public const PAYED = 2;
18 |     public const PAYMENT_METHOD_DEPENDENT  = 90;
19 |     public const ALL_OPTION_VALUES  =  [self::PLACED, self::PAYED, self::PAYMENT_METHOD_DEPENDENT];
20 | 
21 |     /**
22 |      * Return array of options as value-label pairs
23 |      *
24 |      * @return array Format: array(array('value' => '<value>', 'label' => '<label>'), ...)
25 |      */
26 |     public function toOptionArray()
27 |     {
28 |         return [
29 |             ['value' => self::PLACED, 'label' => 'Right after placing the order'],
30 |             ['value' => self::PAYED, 'label' => 'When the order is payed'],
31 |             ['value' => self::PAYMENT_METHOD_DEPENDENT, 'label' => 'Depends on the payment method..'],
32 |         ];
33 |     }
34 | }
35 | 


--------------------------------------------------------------------------------
/Observer/AfterOrderPayed.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | /**
 4 |  * Copyright Elgentos BV. All rights reserved.
 5 |  * https://www.elgentos.nl/
 6 |  */
 7 | 
 8 | declare(strict_types=1);
 9 | 
10 | namespace Elgentos\ServerSideAnalytics\Observer;
11 | 
12 | use Elgentos\ServerSideAnalytics\Config\ModuleConfiguration;
13 | use Elgentos\ServerSideAnalytics\Model\SendPurchaseEvent;
14 | use Magento\Framework\Event\Observer;
15 | use Magento\Framework\Event\ObserverInterface;
16 | use Magento\Sales\Model\Order;
17 | use Magento\Sales\Model\Order\Payment;
18 | 
19 | class AfterOrderPayed implements ObserverInterface
20 | {
21 |     public function __construct(
22 |         protected readonly SendPurchaseEvent $sendPurchaseEvent,
23 |         protected readonly ModuleConfiguration $moduleConfiguration,
24 |     ) {
25 |     }
26 | 
27 |     public function execute(Observer $observer)
28 |     {
29 |         /** @var Payment $payment */
30 |         $payment = $observer->getPayment();
31 |         $method = $payment->getMethodInstance();
32 | 
33 |         /** @var Order $order */
34 |         $order = $payment->getOrder();
35 | 
36 |         if (
37 |             $this->moduleConfiguration->shouldTriggerOnPayment(
38 |                 storeId: $order->getStoreId(),
39 |                 paymentMethodCode: $method->getCode()
40 |             )
41 |         ) {
42 |             $this->sendPurchaseEvent->execute($order, 'AfterOrderPayed');
43 |         }
44 |     }
45 | }
46 | 


--------------------------------------------------------------------------------
/Observer/AfterOrderPlaced.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | /**
 4 |  * Copyright Elgentos BV. All rights reserved.
 5 |  * https://www.elgentos.nl/
 6 |  */
 7 | 
 8 | declare(strict_types=1);
 9 | 
10 | namespace Elgentos\ServerSideAnalytics\Observer;
11 | 
12 | use Elgentos\ServerSideAnalytics\Config\ModuleConfiguration;
13 | use Elgentos\ServerSideAnalytics\Model\GAClient;
14 | use Elgentos\ServerSideAnalytics\Model\ResourceModel\SalesOrder\Collection;
15 | use Elgentos\ServerSideAnalytics\Model\ResourceModel\SalesOrder\CollectionFactory;
16 | use Elgentos\ServerSideAnalytics\Model\SalesOrderFactory;
17 | use Elgentos\ServerSideAnalytics\Model\SalesOrderRepository;
18 | use Elgentos\ServerSideAnalytics\Model\SendPurchaseEvent;
19 | use Magento\Framework\Event\Observer;
20 | use Magento\Framework\Event\ObserverInterface;
21 | use Magento\Sales\Model\Order\Payment;
22 | 
23 | class AfterOrderPlaced implements ObserverInterface
24 | {
25 |     public function __construct(
26 |         protected readonly ModuleConfiguration $moduleConfiguration,
27 |         protected readonly CollectionFactory $elgentosSalesOrderCollectionFactory,
28 |         protected readonly SalesOrderRepository $elgentosSalesOrderRepository,
29 |         protected readonly SalesOrderFactory $elgentosSalesOrderFactory,
30 |         protected readonly GAClient $gaclient,
31 |         protected readonly SendPurchaseEvent $sendPurchaseEvent,
32 |     ) {
33 |     }
34 | 
35 |     public function execute(Observer $observer)
36 |     {
37 |         $quote = $observer->getQuote();
38 |         $order = $observer->getOrder();
39 | 
40 |         if (!$order) {
41 |             return;
42 |         }
43 | 
44 |         if (!$this->moduleConfiguration->isReadyForUse($order->getStoreId())) {
45 |             return;
46 |         }
47 | 
48 |         if ($quote) {
49 |             // Quote should've already been created.
50 |             /** @var Collection $elgentosSalesOrderCollection */
51 |             $elgentosSalesOrderCollection = $this->elgentosSalesOrderCollectionFactory->create();
52 |             /** @var SalesOrder $elgentosSalesOrderData */
53 |             $elgentosSalesOrderData = $elgentosSalesOrderCollection
54 |                 ->addFieldToFilter('quote_id', $quote->getId())
55 |                 ->getFirstItem();
56 | 
57 |             if (empty($elgentosSalesOrderData->getData('quote_id'))) {
58 |                 return;
59 |             }
60 | 
61 |             $elgentosSalesOrderData->setData('order_id', $order->getId());
62 |         }
63 | 
64 |         if (!isset($elgentosSalesOrderData)) {
65 |             /** @var SalesOrder $elgentosSalesOrderData */
66 |             $elgentosSalesOrderData = $this->elgentosSalesOrderFactory->create();
67 |             $elgentosSalesOrderData->setData([
68 |                 'order_id' => $order->getId(),
69 |                 'quote_id' => $quote?->getId()
70 |             ]);
71 | 
72 |             $elgentosSalesOrderData->setGaData(storeId: $order->getStoreId());
73 |         }
74 | 
75 |         try {
76 |             $this->elgentosSalesOrderRepository->save($elgentosSalesOrderData);
77 |         } catch (\Exception $exception) {
78 |             $this->gaclient->createLog($exception->getMessage());
79 |         }
80 | 
81 |         /** @var Payment $payment */
82 |         $payment = $order->getPayment();
83 |         $method  = $payment->getMethodInstance();
84 | 
85 |         if (
86 |             $this->moduleConfiguration->shouldTriggerOnPlaced(
87 |                 storeId: $order->getStoreId(),
88 |                 paymentMethodCode: $method->getCode()
89 |             )
90 |         ) {
91 |             $this->sendPurchaseEvent->execute($order, 'AfterOrderPlaced');
92 |         }
93 |     }
94 | }
95 | 


--------------------------------------------------------------------------------
/Plugin/SaveGaUserDataToDb.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | /**
 4 |  * Copyright Elgentos BV. All rights reserved.
 5 |  * https://www.elgentos.nl/
 6 |  */
 7 | 
 8 | declare(strict_types=1);
 9 | 
10 | namespace Elgentos\ServerSideAnalytics\Plugin;
11 | 
12 | use Elgentos\ServerSideAnalytics\Config\ModuleConfiguration;
13 | use Elgentos\ServerSideAnalytics\Model\GAClient;
14 | use Elgentos\ServerSideAnalytics\Model\ResourceModel\SalesOrder\Collection;
15 | use Elgentos\ServerSideAnalytics\Model\ResourceModel\SalesOrder\CollectionFactory;
16 | use Elgentos\ServerSideAnalytics\Model\SalesOrderRepository;
17 | use Magento\Quote\Api\CartRepositoryInterface;
18 | 
19 | class SaveGaUserDataToDb
20 | {
21 |     public function __construct(
22 |         protected readonly ModuleConfiguration $moduleConfiguration,
23 |         protected readonly CollectionFactory $elgentosSalesOrderCollectionFactory,
24 |         protected readonly SalesOrderRepository $elgentosSalesOrderRepository,
25 |         protected readonly GAClient $gaclient
26 |     ) {
27 |     }
28 | 
29 |     public function afterSave(
30 |         CartRepositoryInterface $subject,
31 |         $result,
32 |         $quote
33 |     ) {
34 |         if (!$this->moduleConfiguration->isReadyForUse($quote->getStoreId())) {
35 |             $this->gaclient->createLog(
36 |                 'Google ServerSideAnalytics is disabled or not configured check the ServerSideAnalytics configuration.'
37 |             );
38 |             return $result;
39 |         }
40 | 
41 |         /** @var Collection $elgentosSalesOrderCollection */
42 |         $elgentosSalesOrderCollection = $this->elgentosSalesOrderCollectionFactory->create();
43 |         /** @var SalesOrder $elgentosSalesOrderData */
44 |         $elgentosSalesOrderData = $elgentosSalesOrderCollection
45 |             ->addFieldToFilter('quote_id', $quote->getId())
46 |             ->getFirstItem();
47 | 
48 |         if ($elgentosSalesOrderData->getCurrentGaUserId() === $elgentosSalesOrderData->getGaUserId()) {
49 |             return;
50 |         }
51 | 
52 |         $elgentosSalesOrderData->setData('quote_id', $quote->getId());
53 |         $elgentosSalesOrderData->setGaData(storeId: $quote->getStoreId());
54 | 
55 |         try {
56 |             $this->elgentosSalesOrderRepository->save($elgentosSalesOrderData);
57 |         } catch (\Exception $exception) {
58 |             $this->gaclient->createLog($exception->getMessage());
59 |         }
60 |     }
61 | }
62 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | # Server Side Analytics for Magento 2
 2 | 
 3 | This extension aims to solve the problem of discrepancies between Magento revenue reports and the revenue reports in Google Analytics.
 4 | 
 5 | That problem arises due to the fact that a certain number of people close the browser window before returning to Magento's success page. Since Google Analytics is Javascript based, and thus client based, the GA Purchase Event will not be fired and the order will not be registered in Analytics.
 6 | 
 7 | Another reason why this problem arises is that people decide to pay at a later point in time through a different platform (like the PSP's), using a link in an email for example.
 8 | 
 9 | ## Installation
10 | 
11 | ```bash
12 | composer require elgentos/serversideanalytics2
13 | bin/magento setup:upgrade
14 | ```
15 | 
16 | ### Sample query for GraphQL to set the GA data
17 | 
18 | ```
19 | mutation AddGaUserId($cartId: String!, $gaUserId: String, $gaSessionId: String) {
20 |                             AddGaUserId(input: {
21 |                                     cartId: $cartId
22 |                                     gaUserId: $gaUserId
23 |                                     gaSessionId: $gaSessionId
24 |                                 }
25 |                             ),
26 |                             {
27 |                                cartId
28 |                                maskedId
29 |                             }
30 |                     }
31 | ```
32 | 
33 | ## Further info
34 | - Compatible with GA4 Measurement Protocol;
35 | - When using YireoGTM, you can either disable the purchase event on the success page, or simply not send it to GA with GTM. Or just keep it, since Google will fix double transactionId's
36 | - Debugging is enabled when Magento is in developer mode. See `var/log/system.log` for the log;
37 | - Exceptions will be logged to `var/log/exceptions.log`;
38 | - The products in the payload are retrieve on invoice-basis, not on order-basis;
39 | - An event has been added for you to add or overwrite custom fields to products in the purchase event; `elgentos_serversideanalytics_product_item_transport_object`;
40 | - An event has been added for you to add or overwrite custom fields to transaction data in the purchase event; `elgentos_serversideanalytics_transaction_data_transport_object`;
41 | - An event has been added for you to add or overwrite fields to tracking data in the purchase event; `elgentos_serversideanalytics_tracking_data_transport_object`;
42 | - Testing can be done by dispatching `test_event_for_serversideanalytics` with a `$payment` (`\Magento\Sales\Order\Payment`) object in the payload;
43 | - magerun2 dev:events:fire --eventName sales_order_payment_pay --parameters "payment::\Magento\Sales\Model\Order\Payment:X;invoice::\Magento\Sales\Model\Order\Invoice:X";
44 | 


--------------------------------------------------------------------------------
/Service/UserDataProvider.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | namespace Elgentos\ServerSideAnalytics\Service;
  4 | 
  5 | class UserDataProvider
  6 | {
  7 |     private ?array $sha256_email_address = [];
  8 |     private ?array $sha256_phone_number = [];
  9 | 
 10 |     private array $addresses = [];
 11 | 
 12 | 
 13 |     /**
 14 |      *  Hashed and encoded email address of the user. Normalized as such:
 15 |      *  - lowercase
 16 |      *  - remove periods before @ for gmail.com/googlemail.com addresses
 17 |      *  - remove all spaces
 18 |      *  - hash using SHA256 algorithm
 19 |      *  - encode with hex string format.
 20 |      *
 21 |      * @param string $email
 22 |      *
 23 |      * @return bool
 24 |      */
 25 |     public function setEmail(string $email): bool
 26 |     {
 27 |         $email = str_replace(" ", "", mb_strtolower($email));
 28 | 
 29 |         if (!filter_var($email, FILTER_VALIDATE_EMAIL)){
 30 |             return false;
 31 |         }
 32 | 
 33 |         // https://developers.google.com/analytics/devguides/collection/ga4/uid-data
 34 |         if (
 35 |             substr($email, -mb_strlen("@gmail.com")) == "@gmail.com" ||
 36 |             substr($email, -mb_strlen("@googlemail.com")) == "@googlemail.com"
 37 |         ) {
 38 |             [$addr, $host] = explode("@", $email, 2);
 39 | 
 40 |             if ($host == "googlemail.com") {
 41 |                 $host = "gmail.com";
 42 |             }
 43 | 
 44 |             $addr = explode("+", $addr, 2)[0];
 45 |             $addr = str_replace(".", "", $addr);
 46 |             $email = implode("@", [trim($addr), trim($host)]);
 47 |         }
 48 | 
 49 |         $this->sha256_email_address[] = hash("sha256", $email);
 50 | 
 51 |         return true;
 52 |     }
 53 | 
 54 |     /**
 55 |      *  Hashed and encoded phone number of the user. Normalized as such:
 56 |      *  - remove all non digit characters
 57 |      *  - add + prefix
 58 |      *  - hash using SHA256 algorithm
 59 |      *  - encode with hex string format.
 60 |      *
 61 |      * @param int $number
 62 |      *
 63 |      * @return bool
 64 |      */
 65 |     public function setPhoneNumber(string $phoneNumber): bool
 66 |     {
 67 |         if (strlen($phoneNumber) < 3 || strlen($phoneNumber) > 15) {
 68 |             return false;
 69 |         }
 70 | 
 71 |         if (strpos($phoneNumber, '+') === 0) {
 72 |             $phoneNumber = "{$phoneNumber}";
 73 |         }else{
 74 |             $phoneNumber = "+{$phoneNumber}";
 75 |         }
 76 | 
 77 |         $this->sha256_phone_number[] = hash("sha256", $phoneNumber);
 78 | 
 79 |         return true;
 80 |     }
 81 | 
 82 | 
 83 |     public function addAddress(?string $firstName = null, ?string $lastName = null, ?string $street = null, ?string $city = null, ?string $region = null, ?string $postalCode = null, ?string $countryCode = null){
 84 |         $addressData = [];
 85 | 
 86 |         /**
 87 |          * Hashed and encoded first name of the user. Normalized as such:
 88 |          * - remove digits and symbol characters
 89 |          * - lowercase
 90 |          * - remove leading and trailing spaces
 91 |          * - hash using SHA256 algorithm
 92 |          * - encode with hex string format.
 93 |          */
 94 |         if (!empty($firstName)) {
 95 |             $addressData['sha256_first_name'] = hash("sha256", $this->strip($firstName, true));
 96 |         }
 97 | 
 98 |         /**
 99 |          * Hashed and encoded last name of the user. Normalized as such:
100 |          * - remove digits and symbol characters
101 |          * - lowercase
102 |          * - remove leading and trailing spaces
103 |          * - hash using SHA256 algorithm
104 |          * - encode with hex string format.
105 |          */
106 |         if (!empty($lastName)){
107 |             $addressData['sha256_last_name'] = hash("sha256", $this->strip($lastName, true));
108 |         }
109 | 
110 |         /**
111 |          * Hashed and encoded street and number of the user. Normalized as such:
112 |          * - remove symbol characters
113 |          * - lowercase
114 |          * - remove leading and trailing spaces
115 |          * - hash using SHA256 algorithm
116 |          * - encode with hex string format.
117 |          */
118 |         if (!empty($street)){
119 |             $addressData['sha256_street'] = hash("sha256", $this->strip($street));
120 |         }
121 | 
122 |         /**
123 |          * City for the address of the user. Normalized as such:
124 |          * - remove digits and symbol characters
125 |          * - lowercase
126 |          * - remove leading and trailing spaces.
127 |          */
128 |         if (!empty($city)){
129 |             $addressData['city'] = $this->strip($city, true);
130 |         }
131 | 
132 |         /**
133 |          * State or territory for the address of the user. Normalized as such:
134 |          * - remove digits and symbol characters
135 |          * - lowercase
136 |          * - remove leading and trailing spaces.
137 |          */
138 |         if (!empty($region)) {
139 |             $addressData['region'] = $this->strip($region, true);
140 |         }
141 | 
142 |         /**
143 |          * Postal code for the address of the user. Normalized as such:
144 |          * - remove . and ~ characters
145 |          * - remove leading and trailing spaces.
146 |          */
147 |         if (!empty($postalCode)) {
148 |             $addressData['postal_code'] = $this->strip($postalCode);
149 |         }
150 | 
151 |         if (!empty($countryCode)) {
152 |             $addressData['country'] = mb_strtoupper(trim($countryCode));
153 |         }
154 | 
155 |         $this->addresses[] = $addressData;
156 |     }
157 | 
158 |     public function toArray(): array
159 |     {
160 |         $data = [];
161 | 
162 |         if (!empty($this->sha256_email_address)) {
163 |             $data["sha256_email_address"] = $this->sha256_email_address;
164 |         }
165 | 
166 |         if (!empty($this->sha256_phone_number)) {
167 |             $data["sha256_phone_number"] = $this->sha256_phone_number;
168 |         }
169 | 
170 |         $data['address'] = $this->addresses;
171 | 
172 |         return $data;
173 |     }
174 | 
175 |     /**
176 |      * @param string $string
177 |      * @param bool $removeDigits
178 |      * @return string
179 |      */
180 |     private function strip(string $string, bool $removeDigits = false): string
181 |     {
182 |         $replaceDecimals = $removeDigits ? '0-9' : '';
183 | 
184 |         $string = preg_replace("[^a-zA-Z{$replaceDecimals}\-\_\.\,\s]", "", $string);
185 |         $string = mb_strtolower($string);
186 | 
187 |         return trim($string);
188 |     }
189 | }
190 | 


--------------------------------------------------------------------------------
/Setup/Patch/Data/RenameConfigPaths.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | namespace Elgentos\ServerSideAnalytics\Setup\Patch\Data;
  4 | 
  5 | use Magento\Framework\App\Config\ScopeConfigInterface;
  6 | use Magento\Framework\App\Config\Storage\WriterInterface;
  7 | use Magento\Framework\Setup\ModuleDataSetupInterface;
  8 | use Magento\Framework\Setup\Patch\DataPatchInterface;
  9 | use Magento\Store\Model\ScopeInterface;
 10 | use Magento\Store\Model\StoreManagerInterface;
 11 | use Magento\Store\Model\Website;
 12 | 
 13 | class RenameConfigPaths implements DataPatchInterface
 14 | {
 15 |     public function __construct(
 16 |         protected ModuleDataSetupInterface $moduleDataSetup,
 17 |         protected WriterInterface $configWriter,
 18 |         protected StoreManagerInterface $storeManager,
 19 |         protected ScopeConfigInterface $scopeConfig
 20 |     ) {
 21 |     }
 22 | 
 23 |     public function apply()
 24 |     {
 25 |         $this->moduleDataSetup->startSetup();
 26 |         $configPathMap = [
 27 |             'google/serverside_analytics/ga_enabled' =>
 28 |                 'google/serverside_analytics/enabled',
 29 |             'google/serverside_analytics/api_secret' =>
 30 |                 'google/serverside_analytics/general/api_secret',
 31 |             'google/serverside_analytics/measurement_id' =>
 32 |                 'google/serverside_analytics/general/measurement_id',
 33 |             'google/serverside_analytics/currency_source' =>
 34 |                 'google/serverside_analytics/general/currency_source',
 35 |             'google/serverside_analytics/fallback_session_id_generation_mode' =>
 36 |                 'google/serverside_analytics/fallback_session_id/mode',
 37 |             'google/serverside_analytics/fallback_session_id' =>
 38 |                 'google/serverside_analytics/fallback_session_id/id',
 39 |             'google/serverside_analytics/fallback_session_id_prefix' =>
 40 |                 'google/serverside_analytics/fallback_session_id/prefix',
 41 |             'google/serverside_analytics/debug_mode' =>
 42 |                 'google/serverside_analytics/developer/debug',
 43 |             'google/serverside_analytics/enable_logging' =>
 44 |                 'google/serverside_analytics/developer/logging',
 45 |         ];
 46 |         foreach ($configPathMap as $old => $new) {
 47 |             $this->renameConfigPath($old, $new);
 48 |         }
 49 | 
 50 |         $this->moduleDataSetup->endSetup();
 51 | 
 52 |         return $this;
 53 |     }
 54 | 
 55 |     protected function renameConfigPath(string $oldPath, string $newPath): void
 56 |     {
 57 |         // Get default config
 58 |         $defaultValue = $this->renameScopedConfigPath(
 59 |             $oldPath,
 60 |             $newPath,
 61 |             null
 62 |         );
 63 | 
 64 |         // Get website config
 65 |         $websites = $this->storeManager->getWebsites();
 66 |         /** @var Website $website */
 67 |         foreach ($websites as $website) {
 68 |             $websiteValue = $this->renameScopedConfigPath(
 69 |                 $oldPath,
 70 |                 $newPath,
 71 |                 $defaultValue,
 72 |                 ScopeInterface::SCOPE_WEBSITES,
 73 |                 $website->getId()
 74 |             );
 75 | 
 76 |             // Get store views config
 77 |             $stores = $website->getStores();
 78 |             foreach ($stores as $store) {
 79 |                 $this->renameScopedConfigPath(
 80 |                     $oldPath,
 81 |                     $newPath,
 82 |                     $websiteValue,
 83 |                     ScopeInterface::SCOPE_STORES,
 84 |                     $store->getId()
 85 |                 );
 86 |             }
 87 |         }
 88 |     }
 89 | 
 90 |     protected function renameScopedConfigPath(
 91 |         string $oldPath,
 92 |         string $newPath,
 93 |         mixed $parentValue,
 94 |         string $scopeType = ScopeConfigInterface::SCOPE_TYPE_DEFAULT,
 95 |         int $scopeId = 0
 96 |     ): mixed {
 97 |         $value = $this->scopeConfig->getValue($oldPath, $scopeType, $scopeId);
 98 |         $this->configWriter->delete($oldPath, $scopeType, $scopeId);
 99 |         if ($value !== $parentValue) {
100 |             $parentValue = $value;
101 |             $this->configWriter->save($newPath, $value, $scopeType, $scopeId);
102 |         }
103 | 
104 |         return $parentValue;
105 |     }
106 | 
107 |     public static function getDependencies()
108 |     {
109 |         return [];
110 |     }
111 | 
112 |     public function getAliases()
113 |     {
114 |         return [];
115 |     }
116 | }
117 | 


--------------------------------------------------------------------------------
/Setup/UpgradeData.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | /**
 4 |  * Copyright Elgentos BV. All rights reserved.
 5 |  * https://www.elgentos.nl/
 6 |  */
 7 | 
 8 | // phpcs:ignoreFile
 9 | 
10 | declare(strict_types=1);
11 | 
12 | namespace Elgentos\ServerSideAnalytics\Setup;
13 | 
14 | use Elgentos\ServerSideAnalytics\Model\Source\CurrencySource;
15 | use Magento\Framework\Setup\ModuleContextInterface;
16 | use Magento\Framework\Setup\ModuleDataSetupInterface;
17 | use Magento\Framework\Setup\UpgradeDataInterface;
18 | use Magento\Framework\App\Config\Storage\WriterInterface;
19 | 
20 | class UpgradeData implements UpgradeDataInterface
21 | {
22 |     public function __construct(
23 |         protected WriterInterface $configWriter
24 |     ) {
25 |     }
26 | 
27 |     public function upgrade(ModuleDataSetupInterface $setup, ModuleContextInterface $context)
28 |     {
29 |         $setup->startSetup();
30 | 
31 |         if ($context->getVersion() && version_compare($context->getVersion(), '1.3.0', '<')) {
32 |             // Extension was already installed, and older than 1.3.0 set currency source to global as it was
33 |             $this->configWriter->save(
34 |                 'google/serverside_analytics/currency_source',
35 |                 CurrencySource::GLOBAL
36 |             );
37 |         }
38 | 
39 |         $setup->endSetup();
40 |     }
41 | }
42 | 


--------------------------------------------------------------------------------
/composer.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "name": "elgentos/serversideanalytics2",
 3 |   "description": "Elgentos_ServerSideAnalytics for magento 2",
 4 |   "require": {
 5 |     "php": ">=8.2.0",
 6 |     "br33f/php-ga4-mp": "^0.1.5"
 7 |   },
 8 |   "type": "magento2-module",
 9 |   "authors": [
10 |     {
11 |       "name": "peterjaap",
12 |       "email": "peterjaap@elgentos.nl"
13 |     }
14 |   ],
15 |   "autoload": {
16 |     "files": [
17 |       "registration.php"
18 |     ],
19 |     "psr-4": {
20 |       "Elgentos\\ServerSideAnalytics\\": ""
21 |     }
22 |   }
23 | }
24 | 


--------------------------------------------------------------------------------
/etc/adminhtml/system.xml:
--------------------------------------------------------------------------------
  1 | <?xml version="1.0"?>
  2 | <config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Config:etc/system_file.xsd">
  3 |     <system>
  4 |         <section id="google" translate="label" sortOrder="140" showInDefault="1" showInWebsite="1" showInStore="1">
  5 |             <group id="serverside_analytics" translate="label" type="text" sortOrder="100" showInDefault="1" showInWebsite="1" showInStore="1">
  6 |                 <label>ServerSide Google Analytics</label>
  7 |                 <field id="enabled" translate="label" type="select" sortOrder="10" showInDefault="1" showInWebsite="1" showInStore="1" canRestore="1">
  8 |                     <label>Enabled</label>
  9 |                     <source_model>Magento\Config\Model\Config\Source\Yesno</source_model>
 10 |                 </field>
 11 |                 <group id="general" translate="label" type="text" sortOrder="20" showInDefault="1" showInWebsite="1" showInStore="1">
 12 |                     <label>General</label>
 13 |                     <depends>
 14 |                         <field id="google/serverside_analytics/enable">1</field>
 15 |                     </depends>
 16 |                     <field id="api_secret" translate="label" type="text" sortOrder="10" showInDefault="1" showInWebsite="1" showInStore="1" canRestore="1">
 17 |                         <label>API Secret</label>
 18 |                     </field>
 19 |                     <field id="measurement_id" translate="label" type="text" sortOrder="20" showInDefault="1" showInWebsite="1" showInStore="1" canRestore="1">
 20 |                         <label>Google Analytics Measurement Id</label>
 21 |                         <comment><![CDATA[For example, G-12384573]]></comment>
 22 |                     </field>
 23 |                     <field id="currency_source" translate="label" type="select" sortOrder="30" showInDefault="1" showInWebsite="1" showInStore="1" canRestore="1">
 24 |                         <label>Currency source</label>
 25 |                         <source_model>Elgentos\ServerSideAnalytics\Model\Source\CurrencySource</source_model>
 26 |                         <comment><![CDATA[This should be 'Currency of the order' in most cases. If however you want the 'global' currency code to be send with the order-value choose 'Default store currency'.]]></comment>
 27 | 
 28 |                     </field>
 29 |                 </group>
 30 |                 <group id="trigger_on" translate="label" type="text" sortOrder="25" showInDefault="1" showInWebsite="1" showInStore="1">
 31 |                     <label>Trigger on</label>
 32 |                     <comment><![CDATA[At what point in the order's life do we want Google Analytics to know about it?]]></comment>
 33 |                     <depends>
 34 |                         <field id="google/serverside_analytics/enable">1</field>
 35 |                     </depends>
 36 |                     <field id="mode" translate="label" type="select" sortOrder="10" showInDefault="1" showInWebsite="1" showInStore="1" canRestore="1">
 37 |                         <label>Mode</label>
 38 |                         <source_model>Elgentos\ServerSideAnalytics\Model\Source\TriggerMode</source_model>
 39 |                         <comment><![CDATA[At what point in the order's life do we want Google Analytics to know about it?]]></comment>
 40 |                     </field>
 41 |                     <field id="on_placed_methods" translate="label" type="multiselect" sortOrder="10" showInDefault="1" showInWebsite="1" showInStore="1" canRestore="1">
 42 |                         <label>Right after placing the order</label>
 43 |                         <source_model>Elgentos\ServerSideAnalytics\Model\Source\PaymentMethods</source_model>
 44 |                         <comment><![CDATA[Select the payment methods which should notify Google Analytics when a order is placed (immediately after checkout)]]></comment>
 45 |                         <depends>
 46 |                             <field id="google/serverside_analytics/trigger_on/mode">90</field>
 47 |                         </depends>
 48 |                     </field>
 49 |                     <field id="on_payed_methods" translate="label" type="multiselect" sortOrder="20" showInDefault="1" showInWebsite="1" showInStore="1" canRestore="1">
 50 |                         <label>When the order is payed</label>
 51 |                         <source_model>Elgentos\ServerSideAnalytics\Model\Source\PaymentMethods</source_model>
 52 |                         <comment><![CDATA[Select the payment methods which should notify Google Analytics when a order is fully payed]]></comment>
 53 |                         <depends>
 54 |                             <field id="google/serverside_analytics/trigger_on/mode">90</field>
 55 |                         </depends>
 56 |                     </field>
 57 | <!--                    <field id="on_invoice_methods" translate="label" type="multiselect" sortOrder="30" showInDefault="1" showInWebsite="1" showInStore="1" canRestore="1">-->
 58 | <!--                        <label>When the order has a invoice</label>-->
 59 | <!--                        <source_model>Elgentos\ServerSideAnalytics\Model\Source\PaymentMethods</source_model>-->
 60 | <!--                        <comment><![CDATA[Select the payment methods which should notify Google Analytics when a order has a invoice created for it]]></comment>-->
 61 | <!--                        <depends>-->
 62 | <!--                            <field id="google/serverside_analytics/trigger_on/mode">90</field>-->
 63 | <!--                        </depends>-->
 64 | <!--                    </field>-->
 65 |                 </group>
 66 |                 <group id="fallback_session_id" translate="label" type="text" sortOrder="30" showInDefault="1" showInWebsite="1" showInStore="1">
 67 |                     <label>Fallback Session id</label>
 68 |                     <depends>
 69 |                         <field id="google/serverside_analytics/enable">1</field>
 70 |                     </depends>
 71 |                     <field id="mode" translate="label" type="select" sortOrder="10" showInDefault="1" showInWebsite="1" showInStore="1" canRestore="1">
 72 |                         <label>Mode</label>
 73 |                         <source_model>Elgentos\ServerSideAnalytics\Model\Source\Fallback</source_model>
 74 |                         <comment><![CDATA[Select the session id generation mode when no session id is available due to adblockers]]></comment>
 75 |                     </field>
 76 |                     <field id="id" translate="label" type="text" sortOrder="20" showInDefault="1" showInWebsite="1" showInStore="1" canRestore="1">
 77 |                         <label>Fallback ID</label>
 78 |                         <comment><![CDATA[The default fallback session id. One session id for all missing]]></comment>
 79 |                         <depends>
 80 |                             <field id="google/serverside_analytics/fallback_session_id/mode">1</field>
 81 |                         </depends>
 82 |                     </field>
 83 |                     <field id="prefix" translate="label" type="text" sortOrder="30" showInDefault="1" showInWebsite="1" showInStore="1" canRestore="1">
 84 |                         <label>Prefix</label>
 85 |                         <comment><![CDATA[Prefix for session id so they are unique with a default prefix. Limit this on 4 numbers]]></comment>
 86 |                         <depends>
 87 |                             <field id="google/serverside_analytics/fallback_session_id/mode">3</field>
 88 |                         </depends>
 89 |                     </field>
 90 |                 </group>
 91 |                 <group id="developer" translate="label" type="text" sortOrder="90" showInDefault="1" showInWebsite="1" showInStore="1">
 92 |                     <label>Developers</label>
 93 |                     <depends>
 94 |                         <field id="google/serverside_analytics/enable">1</field>
 95 |                     </depends>
 96 |                     <field id="debug" translate="label" type="select" sortOrder="10" showInDefault="1" showInWebsite="1" showInStore="1" canRestore="1">
 97 |                         <label>Enable Debug Mode</label>
 98 |                         <comment><![CDATA[<strong>Warning:</strong> When this is enabled, transactions will not be pushed to Google Analytics, only debugged]]></comment>
 99 |                         <source_model>Magento\Config\Model\Config\Source\Yesno</source_model>
100 |                     </field>
101 |                     <field id="logging" translate="label" type="select" sortOrder="20" showInDefault="1" showInWebsite="1" showInStore="1" canRestore="1">
102 |                         <label>Enable Logging</label>
103 |                         <comment><![CDATA[When enabled, this will log the requests done to Google Analytics]]></comment>
104 |                         <source_model>Magento\Config\Model\Config\Source\Yesno</source_model>
105 |                     </field>
106 |                 </group>
107 |             </group>
108 |         </section>
109 |     </system>
110 | </config>
111 | 


--------------------------------------------------------------------------------
/etc/config.xml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0" ?>
 2 | <config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Store:etc/config.xsd">
 3 |     <default>
 4 |         <google>
 5 |             <serverside_analytics>
 6 |                 <trigger_on>
 7 |                     <mode>2</mode>
 8 |                 </trigger_on>
 9 |             </serverside_analytics>
10 |         </google>
11 |     </default>
12 | </config>
13 | 


--------------------------------------------------------------------------------
/etc/db_schema.xml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0"?>
 2 | <!--
 3 | /**
 4 |  * Copyright © Elgentos. All rights reserved.
 5 |  * https://elgentos.nl
 6 |  */
 7 | -->
 8 | <schema xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:Setup/Declaration/Schema/etc/schema.xsd">
 9 |     <table name="elgentos_serversideanalytics_sales_order" engine="innodb" comment="Sales Order">
10 |         <column xsi:type="int" name="id" unsigned="true" nullable="false" identity="true"
11 |                 comment="Id"/>
12 | 
13 |         <column xsi:type="int" name="quote_id" unsigned="true" nullable="true"
14 |                 comment="Quote id"/>
15 | 
16 |         <column xsi:type="int" name="order_id" unsigned="true" nullable="true"
17 |                 comment="Order id"/>
18 | 
19 |         <column xsi:type="varchar" name="ga_user_id" nullable="true" length="255"
20 |                 comment="Google Analytics User Id"/>
21 |         <column xsi:type="varchar" name="ga_session_id" nullable="true" length="255"
22 |                 comment="Google Analytics Session Id"/>
23 | 
24 |         <column xsi:type="varchar" name="trigger" nullable="true"
25 |                 comment="Trigger event"/>
26 | 
27 |         <column xsi:type="datetime" name="send_at" on_update="false" nullable="true"
28 |                 comment="The time of sending"/>
29 | 
30 |         <constraint xsi:type="primary" referenceId="PRIMARY">
31 |             <column name="id"/>
32 |         </constraint>
33 | 
34 |         <constraint xsi:type="unique" referenceId="ELGENTOS_SERVERSIDEANALYTICS_SALES_ORDER_QUOTE_ID_UNIQUE">
35 |             <column name="quote_id"/>
36 |         </constraint>
37 | 
38 |         <constraint xsi:type="unique" referenceId="ELGENTOS_SERVERSIDEANALYTICS_SALES_ORDER_ORDER_ID_UNIQUE">
39 |             <column name="order_id"/>
40 |         </constraint>
41 | 
42 |         <constraint xsi:type="foreign" referenceId="ELGENTOS_SERVERSIDEANALYTICS_SALES_ORDER_ORDER_ID_SALES_ORDER_ENTITY_ID"
43 |                     table="elgentos_serversideanalytics_sales_order" column="order_id" referenceTable="sales_order"
44 |                     referenceColumn="entity_id" onDelete="CASCADE"/>
45 | 
46 |         <constraint xsi:type="foreign" referenceId="ELGENTOS_SERVERSIDEANALYTICS_SALES_ORDER_QUOTE_ID_QUOTE_ENTITY_ID"
47 |                     table="elgentos_serversideanalytics_sales_order" column="quote_id" referenceTable="quote"
48 |                     referenceColumn="entity_id" onDelete="CASCADE"/>
49 |     </table>
50 | </schema>
51 | 


--------------------------------------------------------------------------------
/etc/db_schema_whitelist.json:
--------------------------------------------------------------------------------
 1 | {
 2 |     "elgentos_serversideanalytics_sales_order": {
 3 |         "column": {
 4 |             "id": true,
 5 |             "quote_id": true,
 6 |             "order_id": true,
 7 |             "ga_user_id": true,
 8 |             "ga_session_id": true
 9 |         },
10 |         "constraint": {
11 |             "PRIMARY": true,
12 |             "ELGENTOS_SERVERSIDEANALYTICS_SALES_ORDER_QUOTE_ID": true,
13 |             "ELGENTOS_SERVERSIDEANALYTICS_SALES_ORDER_ORDER_ID": true,
14 |             "FK_628E3DC6541785A5FE0A850CF165075E": true,
15 |             "ELGENTOS_SERVERSIDEANALYTICS_SALES_ORDER_QUOTE_ID_QUOTE_ENTT_ID": true
16 |         }
17 |     }
18 | }
19 | 


--------------------------------------------------------------------------------
/etc/di.xml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0"?>
 2 | <config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:ObjectManager/etc/config.xsd">
 3 |     <type name="Magento\Quote\Api\CartRepositoryInterface">
 4 |         <plugin name="SaveGaUserDataToDb"
 5 |                 type="Elgentos\ServerSideAnalytics\Plugin\SaveGaUserDataToDb"/>
 6 |     </type>
 7 | 
 8 |     <type name="Elgentos\ServerSideAnalytics\Logger\Handler">
 9 |         <arguments>
10 |             <argument name="filesystem" xsi:type="object">Magento\Framework\Filesystem\Driver\File</argument>
11 |         </arguments>
12 |     </type>
13 |     <type name="Elgentos\ServerSideAnalytics\Logger\Logger">
14 |         <arguments>
15 |             <argument name="name" xsi:type="string">serversideanalytics</argument>
16 |             <argument name="handlers"  xsi:type="array">
17 |                 <item name="system" xsi:type="object">Elgentos\ServerSideAnalytics\Logger\Handler</item>
18 |             </argument>
19 |         </arguments>
20 |     </type>
21 |     <type name="Elgentos\ServerSideAnalytics\Setup\UpgradeData">
22 |         <arguments>
23 |             <argument name="configWriter" xsi:type="object">Magento\Framework\App\Config\Storage\WriterInterface</argument>
24 |         </arguments>
25 |     </type>
26 | 
27 |     <type name="Elgentos\ServerSideAnalytics\Service\UserDataProvider"/>
28 | </config>
29 | 


--------------------------------------------------------------------------------
/etc/events.xml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0"?>
 2 | <config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:Event/etc/events.xsd">
 3 |     <event name="sales_order_payment_pay">
 4 |         <observer name="elgentos_serversideanalytics_after_order_payed" instance="Elgentos\ServerSideAnalytics\Observer\AfterOrderPayed"/>
 5 |     </event>
 6 | 
 7 |     <event name="checkout_submit_all_after">
 8 |         <observer name="elgentos_serversideanalytics_after_order_placed" instance="Elgentos\ServerSideAnalytics\Observer\AfterOrderPlaced"/>
 9 |     </event>
10 | 
11 |     <event name="test_event_for_serversideanalytics">
12 |         <observer name="elgentos_serversideanalytics_test" instance="Elgentos\ServerSideAnalytics\Observer\AfterOrderPayed"/>
13 |     </event>
14 | </config>
15 | 


--------------------------------------------------------------------------------
/etc/extension_attributes.xml:
--------------------------------------------------------------------------------
1 | <?xml version="1.0"?>
2 | <config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:Api/etc/extension_attributes.xsd">
3 |     <extension_attributes for="Magento\Sales\Api\Data\OrderInterface">
4 |         <attribute code="ga_user_id" type="string"/>
5 |         <attribute code="ga_session_id" type="string"/>
6 |     </extension_attributes>
7 | </config>
8 | 


--------------------------------------------------------------------------------
/etc/module.xml:
--------------------------------------------------------------------------------
1 | <?xml version="1.0"?>
2 | <config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:Module/etc/module.xsd">
3 |     <module name="Elgentos_ServerSideAnalytics" setup_version="2.0.0">
4 |         <sequence/>
5 |     </module>
6 | </config>
7 | 


--------------------------------------------------------------------------------
/etc/schema.graphqls:
--------------------------------------------------------------------------------
 1 | type Mutation {
 2 |     AddGaUserId (input: AddGaUserIdInput) : AddGaUserIdOutput @resolver( class: "Elgentos\\ServerSideAnalytics\\Model\\Resolver\\GAResolver") @doc(description: "Add Google Analytics User Id and Session id to Quote")
 3 | }
 4 | 
 5 | input AddGaUserIdInput {
 6 |     cartId: String!
 7 |     gaUserId: String
 8 |     gaSessionId: String
 9 | }
10 | 
11 | 
12 | type AddGaUserIdOutput {
13 |     cartId: String!
14 |     maskedId: String
15 | }
16 | 


--------------------------------------------------------------------------------
/registration.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | /**
 4 |  * Copyright Elgentos BV. All rights reserved.
 5 |  * https://www.elgentos.nl/
 6 |  */
 7 | 
 8 | declare(strict_types=1);
 9 | 
10 | use Magento\Framework\Component\ComponentRegistrar;
11 | 
12 | ComponentRegistrar::register(
13 |     ComponentRegistrar::MODULE,
14 |     'Elgentos_ServerSideAnalytics',
15 |     __DIR__
16 | );
17 | 


--------------------------------------------------------------------------------