Code refactoring

EverstormDevelopment · May 5, 2020 · 48079aa · 48079aa
1 parent 480aa6e
commit 48079aa
Show file tree

Hide file tree

Showing 20 changed files with 6 additions and 162 deletions.
diff --git a/Block/Adminhtml/System/Config/Form/Composer/Version.php b/Block/Adminhtml/System/Config/Form/Composer/Version.php
@@ -16,10 +16,6 @@
 use Magento\Framework\Data\Form\Element\AbstractElement;
 use Magento\Framework\Filesystem\Directory\ReadFactory;
 
-/**
- * Class Version
- * @package MagePal\GoogleTagManager\Block\Adminhtml\System\Config\Form\Composer
- */
 class Version extends Field
 {
 
@@ -115,7 +111,7 @@ public function getComposerVersion($moduleName)
                 return !empty($data->version) ? $data->version : __('Unknown');
             }
         } catch (Exception $e) {
-            //
+            return 'Unknown';
         }
 
         return 'Unknown';

diff --git a/Block/Adminhtml/System/Config/Form/Field/ItemVariantFormat.php b/Block/Adminhtml/System/Config/Form/Field/ItemVariantFormat.php
@@ -9,20 +9,10 @@
 
 use Magento\Framework\Option\ArrayInterface;
 
-/**
- * Class ItemVariantFormat
- * @package MagePal\GoogleTagManager\Block\Adminhtml\System\Config\Form\Field
- */
 class ItemVariantFormat implements ArrayInterface
 {
-    /**
-     * Short format
-     */
     const SHORT_FORMAT = 1;
 
-    /**
-     * long format
-     */
     const LONG_FORMAT = 2;
 
     const DEFAULT_FORMAT = self::SHORT_FORMAT;

diff --git a/Block/Adminhtml/System/Config/Form/Module/Version.php b/Block/Adminhtml/System/Config/Form/Module/Version.php
diff --git a/Block/Data/Cart.php b/Block/Data/Cart.php
@@ -15,10 +15,6 @@
 use MagePal\GoogleTagManager\Model\Cart as GtmCartModel;
 use MagePal\GoogleTagManager\Model\DataLayerEvent;
 
-/**
- * Class Cart
- * @package MagePal\GoogleTagManager\Block\Data
- */
 class Cart extends Template
 {
 

diff --git a/Block/Data/Category.php b/Block/Data/Category.php
@@ -16,10 +16,6 @@
 use MagePal\GoogleTagManager\DataLayer\CategoryData\CategoryProvider;
 use MagePal\GoogleTagManager\Model\DataLayerEvent;
 
-/**
- * Class Category
- * @package MagePal\GoogleTagManager\Block\Data
- */
 class Category extends Template
 {
     /**

diff --git a/Block/Data/Checkout.php b/Block/Data/Checkout.php
@@ -15,10 +15,6 @@
 use MagePal\GoogleTagManager\Model\Cart as GtmCartModel;
 use MagePal\GoogleTagManager\Model\DataLayerEvent;
 
-/**
- * Class Checkout
- * @package MagePal\GoogleTagManager\Block\Data
- */
 class Checkout extends Template
 {
 

diff --git a/Block/Data/Customer.php b/Block/Data/Customer.php
@@ -12,10 +12,6 @@
 use MagePal\GoogleTagManager\Block\DataLayer;
 use MagePal\GoogleTagManager\Model\Customer as GtmCustomerModel;
 
-/**
- * Class Customer
- * @package MagePal\GoogleTagManager\Block\Data
- */
 class Customer extends Template
 {
     /**

diff --git a/Block/Data/Order.php b/Block/Data/Order.php
@@ -13,8 +13,6 @@
 use MagePal\GoogleTagManager\Block\DataLayer;
 
 /**
- * Class Order
- * @package MagePal\GoogleTagManager\Block\Data
  * @method Array setOrderIds(Array $orderIds)
  * @method Array getOrderIds()
  */

diff --git a/Block/DataLayer.php b/Block/DataLayer.php
@@ -11,10 +11,6 @@
 use MagePal\GoogleTagManager\Block\Data\Order;
 use MagePal\GoogleTagManager\Model\Config\Source\GdprOption;
 
-/**
- * Class DataLayer
- * @package MagePal\GoogleTagManager\Block
- */
 class DataLayer extends DataLayerAbstract
 {
 
@@ -72,7 +68,7 @@ public function getCookieRestrictionName($store_id = null)
 
     /**
      * @param null $store_id
-     * @return bool
+     * @return int
      */
     public function isGdprEnabled($store_id = null)
     {
@@ -81,7 +77,7 @@ public function isGdprEnabled($store_id = null)
 
     /**
      * @param null $store_id
-     * @return bool
+     * @return int
      */
     public function addJsInHead($store_id = null)
     {

diff --git a/Block/DataLayerAbstract.php b/Block/DataLayerAbstract.php
@@ -14,8 +14,6 @@
 use MagePal\GoogleTagManager\Helper\Data as GtmHelper;
 
 /**
- * Class DataLayerAbstract
- * @package MagePal\GoogleTagManager\Block
  * @method getList()
  */
 class DataLayerAbstract extends Template
@@ -247,7 +245,7 @@ public function getDataLayerName()
     }
 
     /**
-     * @return mixed
+     * @return string
      * @throws NoSuchEntityException
      */
     public function getStoreCurrencyCode()
@@ -258,7 +256,7 @@ public function getStoreCurrencyCode()
     /**
      * Return cookie restriction mode value.
      *
-     * @return bool
+     * @return int
      */
     public function isCookieRestrictionModeEnabled()
     {

diff --git a/Helper/Data.php b/Helper/Data.php
@@ -10,10 +10,6 @@
 use Magento\Framework\App\Helper\AbstractHelper;
 use Magento\Store\Model\ScopeInterface;
 
-/**
- * Class Data
- * @package MagePal\GoogleTagManager\Helper
- */
 class Data extends AbstractHelper
 {
     /**
@@ -103,7 +99,6 @@ public function getGdprOption($store_id = null)
         );
     }
 
-
     /**
      * @param null $store_id
      * @return int

diff --git a/Helper/DataLayerItem.php b/Helper/DataLayerItem.php
@@ -12,10 +12,6 @@
 use Magento\Store\Model\ScopeInterface;
 use MagePal\GoogleTagManager\Block\Adminhtml\System\Config\Form\Field\ItemVariantFormat;
 
-/**
- * Class Item
- * @package MagePal\GoogleTagManager\Helper
- */
 class DataLayerItem extends Data
 {
     /**

diff --git a/Helper/Product.php b/Helper/Product.php
@@ -10,10 +10,6 @@
 use Magento\Framework\App\Helper\AbstractHelper;
 use Magento\Framework\UrlInterface;
 
-/**
- * Class Product
- * @package MagePal\GoogleTagManager\Helper
- */
 class Product extends AbstractHelper
 {
 

diff --git a/Model/Cart.php b/Model/Cart.php
@@ -18,10 +18,6 @@
 use MagePal\GoogleTagManager\DataLayer\QuoteData\QuoteProvider;
 use MagePal\GoogleTagManager\Helper\DataLayerItem as dataLayerItemHelper;
 
-/**
- * Class Cart
- * @package MagePal\GoogleTagManager\Model
- */
 class Cart extends DataObject
 {
 
@@ -94,7 +90,6 @@ public function getCart()
 
         if ($quote->getItemsCount()) {
             $items = [];
-            /** @var Item $item */
             foreach ($quote->getAllVisibleItems() as $item) {
                 $itemData = [
                     'sku' => $item->getSku(),

diff --git a/Model/Config/Source/GdprOption.php b/Model/Config/Source/GdprOption.php
@@ -8,10 +8,6 @@
 
 use Magento\Framework\Option\ArrayInterface;
 
-/**
- * Class GdprType
- * @package MagePal\GmailSmtpApp\Model\Config\Source
- */
 class GdprOption implements ArrayInterface
 {
     const USE_COOKIE_RESTRICTION_MODE = 1;

diff --git a/Model/Customer.php b/Model/Customer.php
@@ -10,10 +10,6 @@
 use Magento\Customer\Model\Session;
 use Magento\Framework\DataObject;
 
-/**
- * Class Customer
- * @package MagePal\GoogleTagManager\Model
- */
 class Customer extends DataObject
 {
 

diff --git a/Model/DataLayerEvent.php b/Model/DataLayerEvent.php
@@ -7,10 +7,6 @@
 
 namespace MagePal\GoogleTagManager\Model;
 
-/**
- * Class DataLayerEvent
- * @package MagePal\GoogleTagManager\Model
- */
 class DataLayerEvent
 {
     const ADD_TO_CART_EVENT = 'addToCart';

diff --git a/Model/Order.php b/Model/Order.php
@@ -23,8 +23,6 @@
 use MagePal\GoogleTagManager\Helper\DataLayerItem;
 
 /**
- * Class Order
- * @package MagePal\GoogleTagManager\Model
  * @method $this setOrderIds(Array $orderIds)
  * @method Array getOrderIds()
  */
@@ -249,7 +247,7 @@ public function getOrderDataLayer(SalesOrder $order)
                                 ->getData();
         }
 
-        $transaction = [
+        return [
             'order_id' => $order->getIncrementId(),
             'store_name' => $this->escapeJsQuote($this->_storeManager->getStore()->getFrontendName()),
             'total' => $this->gtmHelper->formatPrice($order->getBaseGrandTotal()),
@@ -265,8 +263,6 @@ public function getOrderDataLayer(SalesOrder $order)
             'is_guest_checkout' => $order->getCustomerIsGuest() ? true : false,
             'items' => $products
         ];
-
-        return $transaction;
     }
 
     /**

diff --git a/Observer/Frontend/OrderSuccessPageViewObserver.php b/Observer/Frontend/OrderSuccessPageViewObserver.php
@@ -10,10 +10,6 @@
 use Magento\Framework\Event\Observer as EventObserver;
 use Magento\Framework\Event\ObserverInterface;
 
-/**
- * Class OrderSuccessPageViewObserver
- * @package MagePal\GoogleTagManager\Observer\Frontend
- */
 class OrderSuccessPageViewObserver implements ObserverInterface
 {
     /**

diff --git a/etc/adminhtml/system.xml b/etc/adminhtml/system.xml
@@ -76,10 +76,6 @@
                      </style>
                   ]]>
                 </comment>
-                <field id="module_version" translate="label" type="label" sortOrder="0" showInDefault="1" showInWebsite="0" showInStore="0">
-                    <label>Module Version</label>
-                    <frontend_model>MagePal\GoogleTagManager\Block\Adminhtml\System\Config\Form\Module\Version</frontend_model>
-                </field>
                 <field id="composer_version" translate="label" type="label" sortOrder="1" showInDefault="1" showInWebsite="0" showInStore="0">
                     <label>Composer Version</label>
                     <frontend_model>MagePal\GoogleTagManager\Block\Adminhtml\System\Config\Form\Composer\Version</frontend_model>