Merge pull request #49 from stape-io/feature/fix-php84-compatibility

Added PHP8.4 compatibility

Author: chaikovskyia

Block/Adminhtml/System/Config/CustomLoader.php

@@ -38,5 +38,4 @@ protected function _getElementHtml(AbstractElement $element)
             ->setElementHtml($elementHtml)
             ->toHtml();
     }
-
 }

Block/Gtm.php

@@ -25,6 +25,7 @@ class Gtm extends \Magento\Framework\View\Element\Template
      *
      * @param Template\Context $context
      * @param ConfigProvider $configProvider
+     * @param EventFormatter $eventFormatter
      * @param array $data
      */
     public function __construct(

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+v1.0.28
+- added PHP 8.4 compatibility;
+- fixed code style;
+
 v1.0.27
 - added option to enable/disable '_stape' suffix in Datalayer events;
 

Model/Backend/CodeSnippet.php

@@ -35,8 +35,8 @@ public function __construct(
         ScopeConfigInterface $config,
         TypeListInterface $cacheTypeList,
         Gtm $gtm,
-        AbstractResource $resource = null,
-        AbstractDb $resourceCollection = null,
+        ?AbstractResource $resource = null,
+        ?AbstractDb $resourceCollection = null,
         array $data = []
     ) {
         parent::__construct($context, $registry, $config, $cacheTypeList, $resource, $resourceCollection, $data);

Model/Backend/CustomLoader.php

@@ -39,8 +39,8 @@ class CustomLoader extends \Magento\Framework\App\Config\Value
      * @param \Magento\Framework\App\Cache\TypeListInterface $cacheTypeList
      * @param RandomString $randomString
      * @param RandomSuffix $randomSuffix
-     * @param \Magento\Framework\Serialize\Serializer\Json $jsonSerializer
      * @param \Magento\Config\Model\ConfigFactory $configFactory
+     * @param \Magento\Framework\Serialize\Serializer\Json $jsonSerializer
      * @param \Magento\Framework\Model\ResourceModel\AbstractResource|null $resource
      * @param \Magento\Framework\Data\Collection\AbstractDb|null $resourceCollection
      * @param array $data
@@ -54,8 +54,8 @@ public function __construct(
         \Stape\Gtm\Model\Data\RandomSuffix $randomSuffix,
         \Magento\Config\Model\ConfigFactory $configFactory,
         \Magento\Framework\Serialize\Serializer\Json $jsonSerializer,
-        \Magento\Framework\Model\ResourceModel\AbstractResource $resource = null,
-        \Magento\Framework\Data\Collection\AbstractDb $resourceCollection = null,
+        ?\Magento\Framework\Model\ResourceModel\AbstractResource $resource = null,
+        ?\Magento\Framework\Data\Collection\AbstractDb $resourceCollection = null,
         array $data = []
     ) {
         parent::__construct($context, $registry, $config, $cacheTypeList, $resource, $resourceCollection, $data);
@@ -90,7 +90,9 @@ protected function saveLoaderPrefix()
      */
     protected function saveContainerIdParams()
     {
+        // phpcs:disable
         parse_str($this->randomSuffix->generate($this->getValue()), $suffix);
+        // phpcs:enable
         $value = $this->jsonSerializer->serialize([
             'prefix' => $this->randomString->generate(),
             'suffix' => $suffix,
@@ -138,7 +140,11 @@ public function afterSave()
 
         try {
 
-            $prefix = $this->_config->getValue(ConfigProvider::XPATH_GTM_LOADER_PREFIX, $this->getScope(), $this->getScopeId());
+            $prefix = $this->_config->getValue(
+                ConfigProvider::XPATH_GTM_LOADER_PREFIX,
+                $this->getScope(),
+                $this->getScopeId()
+            );
 
             if (!empty($loader) && empty($prefix)) {
                 $this->saveLoaderPrefix();
@@ -157,11 +163,9 @@ public function afterSave()
             if (strlen($this->getValue() ?? '') < 1) {
                 $this->resetLinkedOptions();
             }
-
+            return parent::afterSave();
         } catch (\Throwable $e) {
-
+            return parent::afterSave();
         }
-
-        return parent::afterSave();
     }
 }

Model/Data/DataProviderInterface.php

@@ -4,7 +4,26 @@
 
 interface DataProviderInterface
 {
+    /**
+     * Retrieve data
+     *
+     * @return mixed
+     */
     public function get();
+
+    /**
+     * Add data
+     *
+     * @param string $eventName
+     * @param array $data
+     * @return mixed
+     */
     public function add($eventName, $data);
+
+    /**
+     * Clear data
+     *
+     * @return mixed
+     */
     public function clear();
 }

Model/Data/RandomSuffix.php

@@ -5,6 +5,8 @@
 class RandomSuffix
 {
     /**
+     * Generate random suffix
+     *
      * @param null|string $loaderId
      * @return string
      */

Model/Data/Webhook/CookieList.php

@@ -4,6 +4,11 @@
 
 class CookieList
 {
+    /**
+     * Retrieve entire list of cookies
+     *
+     * @return string[]
+     */
     public function getAll()
     {
         return [
@@ -48,4 +53,3 @@ public function getAll()
         ];
     }
 }
-

Model/Datalayer/Formatter/Event.php

@@ -9,7 +9,7 @@ class Event
     /*
      * Stape event suffix
      */
-    const STAPE_EVENT_SUFFIX = '_stape';
+    public const STAPE_EVENT_SUFFIX = '_stape';
 
     /**
      * @var ConfigProvider $configProvider
@@ -27,6 +27,8 @@ public function __construct(ConfigProvider $configProvider)
     }
 
     /**
+     * Format event name. Add suffix if needed
+     *
      * @param string $eventName
      * @param string|int $scopeCode
      * @return string

Observer/AddToCartComplete.php

@@ -94,7 +94,8 @@ public function execute(Observer $observer)
                     'item_category' => $category ? $category->getName() : null,
                     'price' => $this->priceCurrency->round($quoteItem->getBasePriceInclTax()),
                     'quantity' => $qty,
-                    'variation_id' => $quoteItem->getHasChildren() ? current($quoteItem->getChildren())->getProductId() : null
+                    'variation_id' => $quoteItem->getHasChildren()
+                        ? current($quoteItem->getChildren())->getProductId() : null
                 ]
             ]
         ]);